Skip to content

Commit 7319405

Browse files
committed
Code review.
1 parent 385df5b commit 7319405

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/core/diagnostics/metrics-instrumentation.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -568,15 +568,22 @@ OpenTelemetry is: `[ 0, 5, 10, 25, 50, 75, 100, 250, 500, 750, 1000, 2500, 5000,
568568
The default values may not lead to the best granularity for every Histogram. For
569569
example, sub-second request durations would all fall into the `0` bucket.
570570

571-
To solve this problem the `9.0.0` version of the
571+
The tool or library collecting the Histogram data may offer mechanism(s) to
572+
allow users to customize the bucket configuration. For example, OpenTelemetry
573+
defines a [View
574+
API](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#view).
575+
This however requires end user action and makes it the user's responsibility to
576+
understand the data distribution well enough to choose correct buckets.
577+
578+
To improve the experience the `9.0.0` version of the
572579
`System.Diagnostics.DiagnosticSource` package introduced the
573580
(<xref:System.Diagnostics.Metrics.InstrumentAdvice%2A>) API.
574581

575582
The `InstrumentAdvice` API may be used by instrumentation authors to specify the
576583
set of recommended default bucket boundaries for a given Histogram. The tool or
577584
library collecting the Histogram data can then choose to use those values when
578-
configuring aggregation. This is supported in the OpenTelemetry .NET SDK as of
579-
version `1.10.0`.
585+
configuring aggregation leading to a more seamless onboarding experience for
586+
users. This is supported in the OpenTelemetry .NET SDK as of version `1.10.0`.
580587

581588
> [!IMPORTANT]
582589
> In general more buckets will lead to more precise data for a given Histogram

0 commit comments

Comments
 (0)