Debian Codegraph @

sdk/metric/exemplar/storage.go

raw
1 // Copyright The OpenTelemetry Authors
2 // SPDX-License-Identifier: Apache-2.0
3
4 package exemplar // import "go.opentelemetry.io/otel/sdk/metric/exemplar"
5
6 import (
7 "context"
8 "sync"
9 "time"
10
11 "go.opentelemetry.io/otel/attribute"
12 "go.opentelemetry.io/otel/trace"
13 )
14
15 // storage is an exemplar storage for [Reservoir] implementations.
16 type storage struct {
17 // measurements are the measurements sampled.
18 //
19 // This does not use []metricdata.Exemplar because it potentially would
20 // require an allocation for trace and span IDs in the hot path of Offer.
21 measurements []measurement
22 }
23
24 func newStorage(n int) *storage {
25 return &storage{measurements: make([]measurement, n)}
26 }
27
28 func (r *storage) store(ctx context.Context, idx int, ts time.Time, v Value, droppedAttr []attribute.KeyValue) {
29 r.measurements[idx].mux.Lock()
30 defer r.measurements[idx].mux.Unlock()
31 r.measurements[idx].FilteredAttributes = droppedAttr
32 r.measurements[idx].Time = ts
33 r.measurements[idx].Value = v
34 r.measurements[idx].Ctx = ctx
35 r.measurements[idx].valid = true
36 }
37
38 // Collect returns all the held exemplars.
39 //
40 // The Reservoir state is preserved after this call.
41 func (r *storage) Collect(dest *[]Exemplar) {
42 *dest = reset(*dest, len(r.measurements), len(r.measurements))
43 var n int
44 for i := range r.measurements {
45 if r.measurements[i].exemplar(&(*dest)[n]) {
46 n++
47 }
48 }
49 *dest = (*dest)[:n]
50 }
51
52 // measurement is a measurement made by a telemetry system.
53 type measurement struct {
54 mux sync.Mutex
55 // FilteredAttributes are the attributes dropped during the measurement.
56 FilteredAttributes []attribute.KeyValue
57 // Time is the time when the measurement was made.
58 Time time.Time
59 // Value is the value of the measurement.
60 Value Value
61 // Ctx is the context active when a measurement was made.
62 Ctx context.Context
63
64 valid bool
65 }
66
67 // exemplar returns m as an [Exemplar].
68 // returns true if it populated the exemplar.
69 func (m *measurement) exemplar(dest *Exemplar) bool {
70 m.mux.Lock()
71 defer m.mux.Unlock()
72 if !m.valid {
73 return false
74 }
75
76 dest.FilteredAttributes = m.FilteredAttributes
77 dest.Time = m.Time
78 dest.Value = m.Value
79
80 sc := trace.SpanContextFromContext(m.Ctx)
81 if sc.HasTraceID() {
82 traceID := sc.TraceID()
83 dest.TraceID = traceID[:]
84 } else {
85 dest.TraceID = dest.TraceID[:0]
86 }
87
88 if sc.HasSpanID() {
89 spanID := sc.SpanID()
90 dest.SpanID = spanID[:]
91 } else {
92 dest.SpanID = dest.SpanID[:0]
93 }
94 return true
95 }
96
97 func reset[T any](s []T, length, capacity int) []T {
98 if cap(s) < capacity {
99 return make([]T, length, capacity)
100 }
101 return s[:length]
102 }