Support remove on synchronous instruments

Author: atoulme

internal/global/instruments.go

@@ -229,6 +229,12 @@ func (i *sfCounter) Add(ctx context.Context, incr float64, opts ...metric.AddOpt
 	}
 }
 
+func (i *sfCounter) Remove(ctx context.Context, opts ...metric.MeasurementOption) {
+	if ctr := i.delegate.Load(); ctr != nil {
+		ctr.(metric.Float64Counter).Remove(ctx, opts...)
+	}
+}
+
 type sfUpDownCounter struct {
 	embedded.Float64UpDownCounter
 
@@ -255,6 +261,12 @@ func (i *sfUpDownCounter) Add(ctx context.Context, incr float64, opts ...metric.
 	}
 }
 
+func (i *sfUpDownCounter) Remove(ctx context.Context, opts ...metric.MeasurementOption) {
+	if ctr := i.delegate.Load(); ctr != nil {
+		ctr.(metric.Float64UpDownCounter).Remove(ctx, opts...)
+	}
+}
+
 type sfHistogram struct {
 	embedded.Float64Histogram
 
@@ -281,6 +293,12 @@ func (i *sfHistogram) Record(ctx context.Context, x float64, opts ...metric.Reco
 	}
 }
 
+func (i *sfHistogram) Remove(ctx context.Context, opts ...metric.MeasurementOption) {
+	if ctr := i.delegate.Load(); ctr != nil {
+		ctr.(metric.Float64Histogram).Remove(ctx, opts...)
+	}
+}
+
 type sfGauge struct {
 	embedded.Float64Gauge
 
@@ -307,6 +325,12 @@ func (i *sfGauge) Record(ctx context.Context, x float64, opts ...metric.RecordOp
 	}
 }
 
+func (i *sfGauge) Remove(ctx context.Context, opts ...metric.MeasurementOption) {
+	if ctr := i.delegate.Load(); ctr != nil {
+		ctr.(metric.Float64Gauge).Remove(ctx, opts...)
+	}
+}
+
 type siCounter struct {
 	embedded.Int64Counter
 
@@ -333,6 +357,12 @@ func (i *siCounter) Add(ctx context.Context, x int64, opts ...metric.AddOption)
 	}
 }
 
+func (i *siCounter) Remove(ctx context.Context, opts ...metric.MeasurementOption) {
+	if ctr := i.delegate.Load(); ctr != nil {
+		ctr.(metric.Int64Counter).Remove(ctx, opts...)
+	}
+}
+
 type siUpDownCounter struct {
 	embedded.Int64UpDownCounter
 
@@ -359,6 +389,12 @@ func (i *siUpDownCounter) Add(ctx context.Context, x int64, opts ...metric.AddOp
 	}
 }
 
+func (i *siUpDownCounter) Remove(ctx context.Context, opts ...metric.MeasurementOption) {
+	if ctr := i.delegate.Load(); ctr != nil {
+		ctr.(metric.Int64UpDownCounter).Remove(ctx, opts...)
+	}
+}
+
 type siHistogram struct {
 	embedded.Int64Histogram
 
@@ -385,6 +421,12 @@ func (i *siHistogram) Record(ctx context.Context, x int64, opts ...metric.Record
 	}
 }
 
+func (i *siHistogram) Remove(ctx context.Context, opts ...metric.MeasurementOption) {
+	if ctr := i.delegate.Load(); ctr != nil {
+		ctr.(metric.Int64Histogram).Remove(ctx, opts...)
+	}
+}
+
 type siGauge struct {
 	embedded.Int64Gauge
 
@@ -410,3 +452,9 @@ func (i *siGauge) Record(ctx context.Context, x int64, opts ...metric.RecordOpti
 		ctr.(metric.Int64Gauge).Record(ctx, x, opts...)
 	}
 }
+
+func (i *siGauge) Remove(ctx context.Context, opts ...metric.MeasurementOption) {
+	if ctr := i.delegate.Load(); ctr != nil {
+		ctr.(metric.Int64Gauge).Remove(ctx, opts...)
+	}
+}

internal/global/instruments_test.go

@@ -158,24 +158,27 @@ type testCountingFloatInstrument struct {
 	count int
 
 	metric.Float64Observable
-	embedded.Float64Counter
 	embedded.Float64UpDownCounter
 	embedded.Float64Histogram
 	embedded.Float64Gauge
-	embedded.Float64ObservableCounter
 	embedded.Float64ObservableUpDownCounter
 	embedded.Float64ObservableGauge
+	embedded.Float64Counter
+	embedded.Float64ObservableCounter
 }
 
 func (i *testCountingFloatInstrument) observe() {
 	i.count++
 }
 
-func (i *testCountingFloatInstrument) Add(context.Context, float64, ...metric.AddOption) {
+func (i *testCountingFloatInstrument) Record(context.Context, float64, ...metric.RecordOption) {
 	i.count++
 }
 
-func (i *testCountingFloatInstrument) Record(context.Context, float64, ...metric.RecordOption) {
+func (*testCountingFloatInstrument) Remove(context.Context, ...metric.MeasurementOption) {
+}
+
+func (i *testCountingFloatInstrument) Add(context.Context, float64, ...metric.AddOption) {
 	i.count++
 }
 
@@ -192,11 +195,14 @@ type testCountingIntInstrument struct {
 	embedded.Int64ObservableGauge
 }
 
-func (i *testCountingIntInstrument) observe() {
+func (i *testCountingIntInstrument) Add(context.Context, int64, ...metric.AddOption) {
 	i.count++
 }
 
-func (i *testCountingIntInstrument) Add(context.Context, int64, ...metric.AddOption) {
+func (*testCountingIntInstrument) Remove(context.Context, ...metric.MeasurementOption) {
+}
+
+func (i *testCountingIntInstrument) observe() {
 	i.count++
 }
 

metric/example_test.go

@@ -137,6 +137,14 @@ func ExampleMeter_upDownCounter() {
 
 	// Remove an item from the collection.
 	itemsCounter.Add(context.Background(), -1)
+
+	// Add an item to the collection with some attributes
+	itemsCounter.Add(context.Background(), 1, metric.WithAttributes(attribute.String("location", "kitchen")))
+	// Add another item to the collection with different attributes
+	itemsCounter.Add(context.Background(), 1, metric.WithAttributes(attribute.String("location", "living room")))
+
+	// Remove a counter with some attributes
+	itemsCounter.Remove(context.Background(), metric.WithAttributes(attribute.String("location", "kitchen")))
 }
 
 // Gauges can be used to record non-additive values when changes occur.

metric/noop/noop.go

@@ -191,55 +191,79 @@ type Int64Counter struct{ embedded.Int64Counter }
 // Add performs no operation.
 func (Int64Counter) Add(context.Context, int64, ...metric.AddOption) {}
 
+// Remove performs no operation.
+func (Int64Counter) Remove(context.Context, ...metric.MeasurementOption) {}
+
 // Float64Counter is an OpenTelemetry Counter used to record float64
 // measurements. It produces no telemetry.
 type Float64Counter struct{ embedded.Float64Counter }
 
 // Add performs no operation.
 func (Float64Counter) Add(context.Context, float64, ...metric.AddOption) {}
 
+// Remove performs no operation.
+func (Float64Counter) Remove(context.Context, ...metric.MeasurementOption) {}
+
 // Int64UpDownCounter is an OpenTelemetry UpDownCounter used to record int64
 // measurements. It produces no telemetry.
 type Int64UpDownCounter struct{ embedded.Int64UpDownCounter }
 
 // Add performs no operation.
 func (Int64UpDownCounter) Add(context.Context, int64, ...metric.AddOption) {}
 
+// Remove performs no operation.
+func (Int64UpDownCounter) Remove(context.Context, ...metric.MeasurementOption) {}
+
 // Float64UpDownCounter is an OpenTelemetry UpDownCounter used to record
 // float64 measurements. It produces no telemetry.
 type Float64UpDownCounter struct{ embedded.Float64UpDownCounter }
 
 // Add performs no operation.
 func (Float64UpDownCounter) Add(context.Context, float64, ...metric.AddOption) {}
 
+// Remove performs no operation.
+func (Float64UpDownCounter) Remove(context.Context, ...metric.MeasurementOption) {}
+
 // Int64Histogram is an OpenTelemetry Histogram used to record int64
 // measurements. It produces no telemetry.
 type Int64Histogram struct{ embedded.Int64Histogram }
 
 // Record performs no operation.
 func (Int64Histogram) Record(context.Context, int64, ...metric.RecordOption) {}
 
+// Remove performs no operation.
+func (Int64Histogram) Remove(context.Context, ...metric.MeasurementOption) {}
+
 // Float64Histogram is an OpenTelemetry Histogram used to record float64
 // measurements. It produces no telemetry.
 type Float64Histogram struct{ embedded.Float64Histogram }
 
 // Record performs no operation.
 func (Float64Histogram) Record(context.Context, float64, ...metric.RecordOption) {}
 
+// Remove performs no operation.
+func (Float64Histogram) Remove(context.Context, ...metric.MeasurementOption) {}
+
 // Int64Gauge is an OpenTelemetry Gauge used to record instantaneous int64
 // measurements. It produces no telemetry.
 type Int64Gauge struct{ embedded.Int64Gauge }
 
 // Record performs no operation.
 func (Int64Gauge) Record(context.Context, int64, ...metric.RecordOption) {}
 
+// Remove performs no operation.
+func (Int64Gauge) Remove(context.Context, ...metric.MeasurementOption) {}
+
 // Float64Gauge is an OpenTelemetry Gauge used to record instantaneous float64
 // measurements. It produces no telemetry.
 type Float64Gauge struct{ embedded.Float64Gauge }
 
 // Record performs no operation.
 func (Float64Gauge) Record(context.Context, float64, ...metric.RecordOption) {}
 
+// Remove performs no operation.
+func (Float64Gauge) Remove(context.Context, ...metric.MeasurementOption) {}
+
 // Int64ObservableCounter is an OpenTelemetry ObservableCounter used to record
 // int64 measurements. It produces no telemetry.
 type Int64ObservableCounter struct {

metric/syncfloat64.go

@@ -25,6 +25,12 @@ type Float64Counter interface {
 	// Use the WithAttributeSet (or, if performance is not a concern,
 	// the WithAttributes) option to include measurement attributes.
 	Add(ctx context.Context, incr float64, options ...AddOption)
+
+	// Remove unregisters an instrument.
+	//
+	// Use the WithAttributeSet (or, if performance is not a concern,
+	// the WithAttributes) option to include measurement attributes.
+	Remove(ctx context.Context, options ...MeasurementOption)
 }
 
 // Float64CounterConfig contains options for synchronous counter instruments that
@@ -78,6 +84,12 @@ type Float64UpDownCounter interface {
 	// Use the WithAttributeSet (or, if performance is not a concern,
 	// the WithAttributes) option to include measurement attributes.
 	Add(ctx context.Context, incr float64, options ...AddOption)
+
+	// Remove unregisters an instrument.
+	//
+	// Use the WithAttributeSet (or, if performance is not a concern,
+	// the WithAttributes) option to include measurement attributes.
+	Remove(ctx context.Context, options ...MeasurementOption)
 }
 
 // Float64UpDownCounterConfig contains options for synchronous counter
@@ -131,6 +143,12 @@ type Float64Histogram interface {
 	// Use the WithAttributeSet (or, if performance is not a concern,
 	// the WithAttributes) option to include measurement attributes.
 	Record(ctx context.Context, incr float64, options ...RecordOption)
+
+	// Remove unregisters an instrument.
+	//
+	// Use the WithAttributeSet (or, if performance is not a concern,
+	// the WithAttributes) option to include measurement attributes.
+	Remove(ctx context.Context, options ...MeasurementOption)
 }
 
 // Float64HistogramConfig contains options for synchronous histogram
@@ -189,6 +207,12 @@ type Float64Gauge interface {
 	// Use the WithAttributeSet (or, if performance is not a concern,
 	// the WithAttributes) option to include measurement attributes.
 	Record(ctx context.Context, value float64, options ...RecordOption)
+
+	// Remove unregisters an instrument.
+	//
+	// Use the WithAttributeSet (or, if performance is not a concern,
+	// the WithAttributes) option to include measurement attributes.
+	Remove(ctx context.Context, options ...MeasurementOption)
 }
 
 // Float64GaugeConfig contains options for synchronous gauge instruments that

metric/syncint64.go

@@ -25,6 +25,12 @@ type Int64Counter interface {
 	// Use the WithAttributeSet (or, if performance is not a concern,
 	// the WithAttributes) option to include measurement attributes.
 	Add(ctx context.Context, incr int64, options ...AddOption)
+
+	// Remove unregisters an instrument.
+	//
+	// Use the WithAttributeSet (or, if performance is not a concern,
+	// the WithAttributes) option to include measurement attributes.
+	Remove(ctx context.Context, options ...MeasurementOption)
 }
 
 // Int64CounterConfig contains options for synchronous counter instruments that
@@ -78,6 +84,12 @@ type Int64UpDownCounter interface {
 	// Use the WithAttributeSet (or, if performance is not a concern,
 	// the WithAttributes) option to include measurement attributes.
 	Add(ctx context.Context, incr int64, options ...AddOption)
+
+	// Remove unregisters an instrument.
+	//
+	// Use the WithAttributeSet (or, if performance is not a concern,
+	// the WithAttributes) option to include measurement attributes.
+	Remove(ctx context.Context, options ...MeasurementOption)
 }
 
 // Int64UpDownCounterConfig contains options for synchronous counter
@@ -131,6 +143,12 @@ type Int64Histogram interface {
 	// Use the WithAttributeSet (or, if performance is not a concern,
 	// the WithAttributes) option to include measurement attributes.
 	Record(ctx context.Context, incr int64, options ...RecordOption)
+
+	// Remove unregisters an instrument.
+	//
+	// Use the WithAttributeSet (or, if performance is not a concern,
+	// the WithAttributes) option to include measurement attributes.
+	Remove(ctx context.Context, options ...MeasurementOption)
 }
 
 // Int64HistogramConfig contains options for synchronous histogram instruments
@@ -189,6 +207,12 @@ type Int64Gauge interface {
 	// Use the WithAttributeSet (or, if performance is not a concern,
 	// the WithAttributes) option to include measurement attributes.
 	Record(ctx context.Context, value int64, options ...RecordOption)
+
+	// Remove unregisters an instrument.
+	//
+	// Use the WithAttributeSet (or, if performance is not a concern,
+	// the WithAttributes) option to include measurement attributes.
+	Remove(ctx context.Context, options ...MeasurementOption)
 }
 
 // Int64GaugeConfig contains options for synchronous gauge instruments that