open-telemetry / opentelemetry.io

The OpenTelemetry website and documentation
https://opentelemetry.io
Creative Commons Attribution 4.0 International
533 stars 1.16k forks source link

Fill remaining JS Metrics docs gaps #2052

Open cartermp opened 1 year ago

cartermp commented 1 year ago

The following concepts still need to be documented with working code samples and good commentary:

You can also use this as a guide, at least for Views: https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/metrics.md

Omkar-Waingankar commented 1 year ago

Hi! I'd like to take on this issue - it will be my first across any OTEL github repo. I am very familiar with the Go SDK and have instrumented several micro-services at my startup with OTEL - this will be my first time looking at the JavaScript docs though.

Omkar-Waingankar commented 1 year ago

Should the code samples be added inline in metrics.md?

cartermp commented 1 year ago

@Omkar-Waingankar Thanks for offering! Code samples should be added inline, yes.

What I did with the first cut was:

I found the observable instruments ...difficult. Not necessarily difficult to use, but their behavior was confusing to me (e.g., being able to decrease a value in an observablecounter) and the spec wasn't entirely clear either. So it's worth a shot, but if you find yourself treading water then we can bubble it up to others.

Omkar-Waingankar commented 1 year ago

Thanks for the tips!

Omkar-Waingankar commented 1 year ago

https://github.com/open-telemetry/opentelemetry.io/pull/2144 ^I've made a PR here, but I'm not sure how to link it to this issue

Omkar-Waingankar commented 1 year ago

@cartermp I've pushed a new set of updates to the PR above, where I address some comments from other contributors and add a section on views

domdomegg commented 1 year ago

Can we add tracking for Metric and Log Exporters - currently missing from https://opentelemetry.io/docs/instrumentation/js/exporters/

svrnm commented 1 year ago

Can we add tracking for Metric and Log Exporters - currently missing from https://opentelemetry.io/docs/instrumentation/js/exporters/

Sure, this would be a worthwile addition