Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

### Added

- Add temporality selector functions `DeltaTemporalitySelector`, `CumulativeTemporalitySelector`, `LowMemoryTemporalitySelector` to `go.opentelemetry.io/otel/sdk/metric`. (#7434)
- Add `WithInstrumentationAttributeSet` option to `go.opentelemetry.io/otel/log`, `go.opentelemetry.io/otel/metric`, and `go.opentelemetry.io/otel/trace` packages.
This provides a concurrent-safe and performant alternative to `WithInstrumentationAttributes` by accepting a pre-constructed `attribute.Set`. (#7287)
- Greatly reduce the cost of recording metrics in `go.opentelemetry.io/otel/sdk/metric` using hashing for map keys. (#7175)
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 3 additions & 26 deletions internal/shared/otlp/otlpmetric/oconf/envconfig.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import (
"{{ .envconfigImportPath }}"
"go.opentelemetry.io/otel/internal/global"
"go.opentelemetry.io/otel/sdk/metric"
"go.opentelemetry.io/otel/sdk/metric/metricdata"
)

// DefaultEnvOptionsReader is the default environments reader.
Expand Down Expand Up @@ -165,11 +164,11 @@ func withEnvTemporalityPreference(n string, fn func(metric.TemporalitySelector))
if s, ok := e.GetEnvValue(n); ok {
switch strings.ToLower(s) {
case "cumulative":
fn(cumulativeTemporality)
fn(metric.CumulativeTemporalitySelector)
case "delta":
fn(deltaTemporality)
fn(metric.DeltaTemporalitySelector)
case "lowmemory":
fn(lowMemory)
fn(metric.LowMemoryTemporalitySelector)
default:
global.Warn(
"OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE is set to an invalid value, ignoring.",
Expand All @@ -181,28 +180,6 @@ func withEnvTemporalityPreference(n string, fn func(metric.TemporalitySelector))
}
}

func cumulativeTemporality(metric.InstrumentKind) metricdata.Temporality {
return metricdata.CumulativeTemporality
}

func deltaTemporality(ik metric.InstrumentKind) metricdata.Temporality {
switch ik {
case metric.InstrumentKindCounter, metric.InstrumentKindHistogram, metric.InstrumentKindObservableCounter:
return metricdata.DeltaTemporality
default:
return metricdata.CumulativeTemporality
}
}

func lowMemory(ik metric.InstrumentKind) metricdata.Temporality {
switch ik {
case metric.InstrumentKindCounter, metric.InstrumentKindHistogram:
return metricdata.DeltaTemporality
default:
return metricdata.CumulativeTemporality
}
}

func withEnvAggPreference(n string, fn func(metric.AggregationSelector)) func(e *envconfig.EnvOptionsReader) {
return func(e *envconfig.EnvOptionsReader) {
if s, ok := e.GetEnvValue(n); ok {
Expand Down
32 changes: 31 additions & 1 deletion sdk/metric/reader.go
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,40 @@ type TemporalitySelector func(InstrumentKind) metricdata.Temporality
// DefaultTemporalitySelector is the default TemporalitySelector used if
// WithTemporalitySelector is not provided. CumulativeTemporality will be used
// for all instrument kinds if this TemporalitySelector is used.
func DefaultTemporalitySelector(InstrumentKind) metricdata.Temporality {
func DefaultTemporalitySelector(k InstrumentKind) metricdata.Temporality {
return CumulativeTemporalitySelector(k)
}

// CumulativeTemporalitySelector is the TemporalitySelector that uses
// a cumulative temporality for all instrument kinds.
func CumulativeTemporalitySelector(InstrumentKind) metricdata.Temporality {
return metricdata.CumulativeTemporality
}

// DeltaTemporalitySelector is the TemporalitySelector that uses
// a delta temporality for instrument kinds: counter, histogram, observable counter
// All other instruments use cumulative temporality.
func DeltaTemporalitySelector(k InstrumentKind) metricdata.Temporality {
switch k {
case InstrumentKindCounter, InstrumentKindHistogram, InstrumentKindObservableCounter:
return metricdata.DeltaTemporality
default:
return metricdata.CumulativeTemporality
}
}

// LowMemoryTemporalitySelector is the TemporalitySelector that uses
// delta temporality for counters and histograms. All other instruments use
// cumulative temporality.
func LowMemoryTemporalitySelector(k InstrumentKind) metricdata.Temporality {
switch k {
case InstrumentKindCounter, InstrumentKindHistogram:
return metricdata.DeltaTemporality
default:
return metricdata.CumulativeTemporality
}
}

// AggregationSelector selects the aggregation and the parameters to use for
// that aggregation based on the InstrumentKind.
//
Expand Down
58 changes: 58 additions & 0 deletions sdk/metric/reader_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,64 @@ func TestDefaultTemporalitySelector(t *testing.T) {
}
}

func TestCumulativeTemporalitySelector(t *testing.T) {
var undefinedInstrument InstrumentKind
for _, ik := range []InstrumentKind{
undefinedInstrument,
InstrumentKindCounter,
InstrumentKindUpDownCounter,
InstrumentKindHistogram,
InstrumentKindGauge,
InstrumentKindObservableCounter,
InstrumentKindObservableUpDownCounter,
InstrumentKindObservableGauge,
} {
assert.Equal(t, metricdata.CumulativeTemporality, CumulativeTemporalitySelector(ik))
}
}

func TestDeltaTemporalitySelector(t *testing.T) {
var undefinedInstrument InstrumentKind
for _, ik := range []InstrumentKind{
InstrumentKindCounter,
InstrumentKindHistogram,
InstrumentKindObservableCounter,
} {
assert.Equal(t, metricdata.DeltaTemporality, DeltaTemporalitySelector(ik))
}

for _, ik := range []InstrumentKind{
undefinedInstrument,
InstrumentKindGauge,
InstrumentKindObservableGauge,
InstrumentKindObservableUpDownCounter,
InstrumentKindUpDownCounter,
} {
assert.Equal(t, metricdata.CumulativeTemporality, DeltaTemporalitySelector(ik))
}
}

func TestLowMemoryTemporalitySelector(t *testing.T) {
var undefinedInstrument InstrumentKind
for _, ik := range []InstrumentKind{
InstrumentKindCounter,
InstrumentKindHistogram,
} {
assert.Equal(t, metricdata.DeltaTemporality, LowMemoryTemporalitySelector(ik))
}

for _, ik := range []InstrumentKind{
undefinedInstrument,
InstrumentKindGauge,
InstrumentKindObservableCounter,
InstrumentKindObservableGauge,
InstrumentKindObservableUpDownCounter,
InstrumentKindUpDownCounter,
} {
assert.Equal(t, metricdata.CumulativeTemporality, LowMemoryTemporalitySelector(ik))
}
}

type notComparable [0]func() // nolint:unused // non-comparable type itself is used.

type noCompareReader struct {
Expand Down