Update documentation for Metrics API #2280
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2280 +/- ##
=====================================
Coverage 77.7% 77.7%
=====================================
Files 123 123
Lines 23050 23050
=====================================
Hits 17931 17931
Misses 5119 5119 ☔ View full report in Codecov by Sentry. |
| @@ -11,6 +11,8 @@ static GLOBAL_METER_PROVIDER: Lazy<RwLock<GlobalMeterProvider>> = | |||
|
|
|||
| /// Sets the given [`MeterProvider`] instance as the current global meter | |||
| /// provider. | |||
| /// | |||
| /// **NOTE:** This function should be called before getting [`Meter`] instances via [`meter()`] or [`meter_with_scope()`]. Otherwise, you could get no-op [`Meter`] instances. | |||
There was a problem hiding this comment.
can we mention something like - do this at the earliest stage of your application/similar? Or is this sufficient?
I am also wondering what happens if a library statically creates Meter - is that going to be no-ops always, as we won't have an opportunity to set the global provider beforehand?
There was a problem hiding this comment.
Library author should just get meter from provider without the need to know the whether the provider is set or not. Application owner is responsible to instrument the provider before collectiong metrics.
There was a problem hiding this comment.
Yes! This API is for application owners only (this is the set one), so we should include doc comment targeting app owners. In fact, I think we should also mention that "if you are library author, do not use this API.
Changes