[mdatagen] Generate wrappers for recording telemetry metrics

Author: crobert-1

.chloggen/tel_metric_attributes.yaml

@@ -0,0 +1,25 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: mdatagen
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Generate wrappers for telemetry metrics as a first step towards configurable attributes
+
+# One or more tracking issues or pull requests related to the change
+issues: [10801]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []

cmd/mdatagen/internal/command_test.go

@@ -116,6 +116,7 @@ func TestRunContents(t *testing.T) {
 		},
 		{
 			yml:                    "with_telemetry.yaml",
+			wantMetricsContext:     true,
 			wantStatusGenerated:    true,
 			wantTelemetryGenerated: true,
 		},

cmd/mdatagen/internal/samplereceiver/factory.go

@@ -41,7 +41,7 @@ func createMetrics(ctx context.Context, set receiver.Settings, _ component.Confi
 		return nil, err
 	}
 
-	telemetryBuilder.BatchSizeTriggerSend.Add(ctx, 1)
+	telemetryBuilder.RecordBatchSizeTriggerSend(ctx, 1)
 	return nopReceiver{telemetryBuilder: telemetryBuilder}, nil
 }
 

cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_telemetry.go

@@ -4,15 +4,9 @@ package {{ .Package }}
 
 import (
     {{- if .Telemetry.Metrics }}
-    {{- range $_, $metric := .Telemetry.Metrics }}
-    {{- if $metric.Data.Async }}
     "context"
-    "sync"
-
-{{- break}}
-    {{- end }}
-    {{- end }}
     "errors"
+    "sync"
     {{- end }}
 
 	"go.opentelemetry.io/otel/metric"
@@ -143,3 +137,13 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...Teleme
 }
 
 {{- end }}
+
+{{- range $name, $metric := .Telemetry.Metrics }}
+{{- if not $metric.Data.Async }}
+
+func (builder *TelemetryBuilder) Record{{ $name.Render }}(ctx context.Context, val {{ $metric.Data.BasicType }}, opts ...metric.{{- if eq $metric.Data.Type "Sum" -}}Add{{- else -}}Record{{- end -}}Option) {
+    builder.{{ $name.Render }}.{{- if eq $metric.Data.Type "Sum" -}}Add{{- else -}}Record{{- end -}}(ctx, val, opts...)
+}
+
+{{- end }}
+{{- end }}

cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest_test.go

@@ -29,12 +29,8 @@ func TestSetupTelemetry(t *testing.T) {
     {{- end }}
 
     {{- range $name, $metric := .Telemetry.Metrics }}
-        {{- if not $metric.Data.Async }}
-            {{- if eq $metric.Data.Type "Sum" }}
-            	tb.{{ $name.Render }}.Add(context.Background(), 1)
-            {{- else }}
-            	tb.{{ $name.Render }}.Record(context.Background(), 1)
-            {{- end }}
+        {{- if (and (not $metric.Optional) (not $metric.Data.Async)) }}
+            tb.Record{{ $name.Render }}(context.Background(), 1)
         {{- end }}
     {{- end }}
 

cmd/mdatagen/internal/templates/telemetry.go.tmpl

@@ -290,7 +290,7 @@ To record the measurement, you can then call the metric stored in the telemetry
 builder:
 
 ```go
-tsp.telemetry.ProcessorTailsamplingSamplingdecisionLatency.Record(ctx, ...)
+tsp.telemetry.RecordProcessorTailsamplingSamplingdecisionLatency(ctx, ...)
 ```
 
 ## Resource Usage

cmd/mdatagen/internal/templates/telemetrytest_test.go.tmpl

@@ -38,13 +38,13 @@ type obsReportSender[K request.Request] struct {
 	component.StartFunc
 	component.ShutdownFunc
 
-	spanName        string
-	tracer          trace.Tracer
-	spanAttrs       trace.SpanStartEventOption
-	metricAttr      metric.MeasurementOption
-	itemsSentInst   metric.Int64Counter
-	itemsFailedInst metric.Int64Counter
-	next            Sender[K]
+	spanName         string
+	tracer           trace.Tracer
+	signal           pipeline.Signal
+	spanAttrs        trace.SpanStartEventOption
+	metricAttr       metric.MeasurementOption
+	next             Sender[K]
+	telemetryBuilder *metadata.TelemetryBuilder
 }
 
 func newObsReportSender[K request.Request](set exporter.Settings, signal pipeline.Signal, next Sender[K]) (Sender[K], error) {
@@ -57,25 +57,13 @@ func newObsReportSender[K request.Request](set exporter.Settings, signal pipelin
 	expAttr := attribute.String(ExporterKey, idStr)
 
 	or := &obsReportSender[K]{
-		spanName:   ExporterKey + spanNameSep + idStr + spanNameSep + signal.String(),
-		tracer:     metadata.Tracer(set.TelemetrySettings),
-		spanAttrs:  trace.WithAttributes(expAttr, attribute.String(DataTypeKey, signal.String())),
-		metricAttr: metric.WithAttributeSet(attribute.NewSet(expAttr)),
-		next:       next,
-	}
-
-	switch signal {
-	case pipeline.SignalTraces:
-		or.itemsSentInst = telemetryBuilder.ExporterSentSpans
-		or.itemsFailedInst = telemetryBuilder.ExporterSendFailedSpans
-
-	case pipeline.SignalMetrics:
-		or.itemsSentInst = telemetryBuilder.ExporterSentMetricPoints
-		or.itemsFailedInst = telemetryBuilder.ExporterSendFailedMetricPoints
-
-	case pipeline.SignalLogs:
-		or.itemsSentInst = telemetryBuilder.ExporterSentLogRecords
-		or.itemsFailedInst = telemetryBuilder.ExporterSendFailedLogRecords
+		spanName:         ExporterKey + spanNameSep + idStr + spanNameSep + signal.String(),
+		tracer:           metadata.Tracer(set.TelemetrySettings),
+		signal:           signal,
+		spanAttrs:        trace.WithAttributes(expAttr, attribute.String(DataTypeKey, signal.String())),
+		metricAttr:       metric.WithAttributeSet(attribute.NewSet(expAttr)),
+		next:             next,
+		telemetryBuilder: telemetryBuilder,
 	}
 
 	return or, nil
@@ -104,12 +92,16 @@ func (ors *obsReportSender[K]) endOp(ctx context.Context, numLogRecords int, err
 	numSent, numFailedToSend := toNumItems(numLogRecords, err)
 
 	// No metrics recorded for profiles.
-	if ors.itemsSentInst != nil {
-		ors.itemsSentInst.Add(ctx, numSent, ors.metricAttr)
-	}
-	// No metrics recorded for profiles.
-	if ors.itemsFailedInst != nil {
-		ors.itemsFailedInst.Add(ctx, numFailedToSend, ors.metricAttr)
+	switch ors.signal {
+	case pipeline.SignalTraces:
+		ors.telemetryBuilder.RecordExporterSentSpans(ctx, numSent, ors.metricAttr)
+		ors.telemetryBuilder.RecordExporterSendFailedSpans(ctx, numFailedToSend, ors.metricAttr)
+	case pipeline.SignalMetrics:
+		ors.telemetryBuilder.RecordExporterSentMetricPoints(ctx, numSent, ors.metricAttr)
+		ors.telemetryBuilder.RecordExporterSendFailedMetricPoints(ctx, numFailedToSend, ors.metricAttr)
+	case pipeline.SignalLogs:
+		ors.telemetryBuilder.RecordExporterSentLogRecords(ctx, numSent, ors.metricAttr)
+		ors.telemetryBuilder.RecordExporterSendFailedLogRecords(ctx, numFailedToSend, ors.metricAttr)
 	}
 
 	span := trace.SpanFromContext(ctx)

docs/coding-guidelines.md

@@ -53,11 +53,11 @@ func newBatchProcessorTelemetry(set processor.Settings, currentMetadataCardinali
 func (bpt *batchProcessorTelemetry) record(trigger trigger, sent, bytes int64) {
 	switch trigger {
 	case triggerBatchSize:
-		bpt.telemetryBuilder.ProcessorBatchBatchSizeTriggerSend.Add(bpt.exportCtx, 1, bpt.processorAttr)
+		bpt.telemetryBuilder.RecordProcessorBatchBatchSizeTriggerSend(bpt.exportCtx, 1, bpt.processorAttr)
 	case triggerTimeout:
-		bpt.telemetryBuilder.ProcessorBatchTimeoutTriggerSend.Add(bpt.exportCtx, 1, bpt.processorAttr)
+		bpt.telemetryBuilder.RecordProcessorBatchTimeoutTriggerSend(bpt.exportCtx, 1, bpt.processorAttr)
 	}
 
-	bpt.telemetryBuilder.ProcessorBatchBatchSendSize.Record(bpt.exportCtx, sent, bpt.processorAttr)
-	bpt.telemetryBuilder.ProcessorBatchBatchSendSizeBytes.Record(bpt.exportCtx, bytes, bpt.processorAttr)
+	bpt.telemetryBuilder.RecordProcessorBatchBatchSendSize(bpt.exportCtx, sent, bpt.processorAttr)
+	bpt.telemetryBuilder.RecordProcessorBatchBatchSendSizeBytes(bpt.exportCtx, bytes, bpt.processorAttr)
 }