Skip to content

Commit 20d6fc8

Browse files
authored
Docs: clarify overflow attribute behavior (#6796)
1 parent 6d589b4 commit 20d6fc8

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/metrics/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,16 @@ measurement that could not be independently aggregated will be automatically
393393
aggregated using the [overflow
394394
attribute](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#overflow-attribute).
395395

396+
In other words, the SDK will stop tracking some new attribute sets separately.
397+
Instead of dropping those measurements, the SDK aggregates them into a
398+
synthetic metric point with a single attribute: `otel.metric.overflow=true`.
399+
400+
Once an overflow exists, queries that filter on attributes (dimensions) become
401+
unreliable. For example, if you query the sum of requests where `route=foo`,
402+
there is no way to tell whether some `route=foo` measurements were folded into
403+
the overflow metric point. In that situation, only aggregations that do not
404+
filter based on dimensions (the total metric) remain trustworthy.
405+
396406
> [!NOTE]
397407
> In SDK versions `1.6.0` - `1.9.0` the overflow attribute was an experimental
398408
feature that could be enabled by setting the environment variable

0 commit comments

Comments
 (0)