[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/samplereceiver/factory.go

@@ -31,7 +31,7 @@ func createMetrics(ctx context.Context, set receiver.Settings, _ component.Confi
 	if err != nil {
 		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,12 +4,7 @@ package {{ .Package }}
 
 import (
     {{- if .Telemetry.Metrics }}
-    {{- range $_, $metric := .Telemetry.Metrics }}
-    {{- if $metric.Data.Async }}
     "context"
-    {{- break}}
-    {{- end }}
-    {{- end }}
     "errors"
     {{- end }}
 
@@ -128,3 +123,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

@@ -26,11 +26,7 @@ func TestSetupTelemetry(t *testing.T) {
 	require.NotNil(t, tb)
     {{- range $name, $metric := .Telemetry.Metrics }}
         {{- if (and (not $metric.Optional) (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 }}
+            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,12 +38,9 @@ type ObsReport struct {
 	tracer   trace.Tracer
 	Signal   pipeline.Signal
 
-	spanAttrs         trace.SpanStartEventOption
-	metricAttr        metric.MeasurementOption
-	TelemetryBuilder  *metadata.TelemetryBuilder
-	enqueueFailedInst metric.Int64Counter
-	itemsSentInst     metric.Int64Counter
-	itemsFailedInst   metric.Int64Counter
+	spanAttrs        trace.SpanStartEventOption
+	metricAttr       metric.MeasurementOption
+	TelemetryBuilder *metadata.TelemetryBuilder
 }
 
 // ObsReportSettings are settings for creating an ObsReport.
@@ -70,23 +67,6 @@ func NewObsReport(set ObsReportSettings) (*ObsReport, error) {
 		TelemetryBuilder: telemetryBuilder,
 	}
 
-	switch set.Signal {
-	case pipeline.SignalTraces:
-		or.enqueueFailedInst = or.TelemetryBuilder.ExporterEnqueueFailedSpans
-		or.itemsSentInst = or.TelemetryBuilder.ExporterSentSpans
-		or.itemsFailedInst = or.TelemetryBuilder.ExporterSendFailedSpans
-
-	case pipeline.SignalMetrics:
-		or.enqueueFailedInst = or.TelemetryBuilder.ExporterEnqueueFailedMetricPoints
-		or.itemsSentInst = or.TelemetryBuilder.ExporterSentMetricPoints
-		or.itemsFailedInst = or.TelemetryBuilder.ExporterSendFailedMetricPoints
-
-	case pipeline.SignalLogs:
-		or.enqueueFailedInst = or.TelemetryBuilder.ExporterEnqueueFailedLogRecords
-		or.itemsSentInst = or.TelemetryBuilder.ExporterSentLogRecords
-		or.itemsFailedInst = or.TelemetryBuilder.ExporterSendFailedLogRecords
-	}
-
 	return or, nil
 }
 
@@ -102,12 +82,16 @@ func (or *ObsReport) EndOp(ctx context.Context, numLogRecords int, err error) {
 	numSent, numFailedToSend := toNumItems(numLogRecords, err)
 
 	// No metrics recorded for profiles.
-	if or.itemsSentInst != nil {
-		or.itemsSentInst.Add(ctx, numSent, or.metricAttr)
-	}
-	// No metrics recorded for profiles.
-	if or.itemsFailedInst != nil {
-		or.itemsFailedInst.Add(ctx, numFailedToSend, or.metricAttr)
+	switch or.Signal {
+	case pipeline.SignalTraces:
+		or.TelemetryBuilder.RecordExporterSentSpans(ctx, numSent, or.metricAttr)
+		or.TelemetryBuilder.RecordExporterSendFailedSpans(ctx, numFailedToSend, or.metricAttr)
+	case pipeline.SignalMetrics:
+		or.TelemetryBuilder.RecordExporterSentMetricPoints(ctx, numSent, or.metricAttr)
+		or.TelemetryBuilder.RecordExporterSendFailedMetricPoints(ctx, numFailedToSend, or.metricAttr)
+	case pipeline.SignalLogs:
+		or.TelemetryBuilder.RecordExporterSentLogRecords(ctx, numSent, or.metricAttr)
+		or.TelemetryBuilder.RecordExporterSendFailedLogRecords(ctx, numFailedToSend, or.metricAttr)
 	}
 
 	span := trace.SpanFromContext(ctx)
@@ -133,9 +117,12 @@ func toNumItems(numExportedItems int, err error) (int64, int64) {
 
 func (or *ObsReport) RecordEnqueueFailure(ctx context.Context, failed int64) {
 	// No metrics recorded for profiles.
-	if or.enqueueFailedInst == nil {
-		return
+	switch or.Signal {
+	case pipeline.SignalTraces:
+		or.TelemetryBuilder.RecordExporterEnqueueFailedSpans(ctx, failed, or.metricAttr)
+	case pipeline.SignalMetrics:
+		or.TelemetryBuilder.RecordExporterEnqueueFailedMetricPoints(ctx, failed, or.metricAttr)
+	case pipeline.SignalLogs:
+		or.TelemetryBuilder.RecordExporterEnqueueFailedLogRecords(ctx, failed, or.metricAttr)
 	}
-
-	or.enqueueFailedInst.Add(ctx, failed, or.metricAttr)
 }

docs/coding-guidelines.md

@@ -49,11 +49,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)
 }

exporter/exporterhelper/internal/metadata/generated_telemetry.go

@@ -36,22 +36,22 @@ func newObsReport(set processor.Settings) (*obsReport, error) {
 func (or *obsReport) accepted(ctx context.Context, num int, signal pipeline.Signal) {
 	switch signal {
 	case pipeline.SignalTraces:
-		or.telemetryBuilder.ProcessorAcceptedSpans.Add(ctx, int64(num), or.otelAttrs)
+		or.telemetryBuilder.RecordProcessorAcceptedSpans(ctx, int64(num), or.otelAttrs)
 	case pipeline.SignalMetrics:
-		or.telemetryBuilder.ProcessorAcceptedMetricPoints.Add(ctx, int64(num), or.otelAttrs)
+		or.telemetryBuilder.RecordProcessorAcceptedMetricPoints(ctx, int64(num), or.otelAttrs)
 	case pipeline.SignalLogs:
-		or.telemetryBuilder.ProcessorAcceptedLogRecords.Add(ctx, int64(num), or.otelAttrs)
+		or.telemetryBuilder.RecordProcessorAcceptedLogRecords(ctx, int64(num), or.otelAttrs)
 	}
 }
 
 // refused reports that the num data that was refused.
 func (or *obsReport) refused(ctx context.Context, num int, signal pipeline.Signal) {
 	switch signal {
 	case pipeline.SignalTraces:
-		or.telemetryBuilder.ProcessorRefusedSpans.Add(ctx, int64(num), or.otelAttrs)
+		or.telemetryBuilder.RecordProcessorRefusedSpans(ctx, int64(num), or.otelAttrs)
 	case pipeline.SignalMetrics:
-		or.telemetryBuilder.ProcessorRefusedMetricPoints.Add(ctx, int64(num), or.otelAttrs)
+		or.telemetryBuilder.RecordProcessorRefusedMetricPoints(ctx, int64(num), or.otelAttrs)
 	case pipeline.SignalLogs:
-		or.telemetryBuilder.ProcessorRefusedLogRecords.Add(ctx, int64(num), or.otelAttrs)
+		or.telemetryBuilder.RecordProcessorRefusedLogRecords(ctx, int64(num), or.otelAttrs)
 	}
 }