go/opentelemetry-go
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-10-08 23:21:56 +02:00
Code Issues Releases Activity

Document the ordering guarantees provided by the metrics SDK (#7453)

Browse Source 
Forked from this discussion here:
https://github.com/open-telemetry/opentelemetry-go/pull/7443#discussion_r2402481912

It seems like a good idea for us as a group to align on and document
what we are comfortable with in terms of how ordered measurements are
reflected in collected metric data.

---------

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
This commit is contained in:
David Ashpole
2025-10-07 11:21:58 -04:00
committed by GitHub
parent b64883dc9a
commit 5f5f4af5e5
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
sdk/metric/doc.go
View File

@@ -63,6 +63,22 @@
// issues for databases that cannot handle high cardinality.
// - A too low of a limit causes loss of attribute detail as more data falls into overflow.
//
// # Ordering and Collection Guarantees
//
// For performance reasons, the SDK does not guarantee that the order in which
// synchronous measurements are made to the SDK is reflected in the collected
// metric data. This means that even when a single goroutine makes sequential
// synchronous measurements, it is possible for a later measurement to be
// included in the collected metric data when an earlier measurement is not.
// This applies to measurements made to different instruments, or to different
// attribute sets on the same instrument. Sequential measurements made to the
// same instrument and with the same attributes are guaranteed to preserve
// ordering with respect to collection.
//
// Additionally, the SDK does not guarantee that exemplars are always included
// in the same batch of metric data as the measurement they are associated
// with.
//
// See [go.opentelemetry.io/otel/metric] for more information about
// the metric API.
//