[telemetry] emit metrics with _ instead of /

.chloggen/codeboten_use-period.yaml

@@ -0,0 +1,29 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: service
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: emit internal collector metrics with _ instead of / with OTLP export
+
+# One or more tracking issues or pull requests related to the change
+issues: [9774]
+
+# (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: |
+  This is addressing an issue w/ the names of the metrics generated by the Collector for its
+  internal metrics. Note that this change only impacts users that emit telemetry using OTLP, which
+  is currently still in experimental support. The prometheus metrics already replaced `/` with `_`
+  and they will do the same with `_`.
+
+# 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: []

exporter/exporterhelper/obsexporter.go

@@ -20,7 +20,7 @@ import (
 )
 
 const (
-	exporterScope = obsmetrics.Scope + obsmetrics.NameSep + obsmetrics.ExporterKey
+	exporterScope = obsmetrics.Scope + obsmetrics.SpanNameSep + obsmetrics.ExporterKey
 )
 
 // ObsReport is a helper to add observability to an exporter.
@@ -78,55 +78,55 @@ func (or *ObsReport) createOtelMetrics(cfg ObsReportSettings) error {
 	var errors, err error
 
 	or.sentSpans, err = meter.Int64Counter(
-		obsmetrics.ExporterPrefix+obsmetrics.SentSpansKey,
+		obsmetrics.ExporterMetricPrefix+obsmetrics.SentSpansKey,
 		metric.WithDescription("Number of spans successfully sent to destination."),
 		metric.WithUnit("1"))
 	errors = multierr.Append(errors, err)
 
 	or.failedToSendSpans, err = meter.Int64Counter(
-		obsmetrics.ExporterPrefix+obsmetrics.FailedToSendSpansKey,
+		obsmetrics.ExporterMetricPrefix+obsmetrics.FailedToSendSpansKey,
 		metric.WithDescription("Number of spans in failed attempts to send to destination."),
 		metric.WithUnit("1"))
 	errors = multierr.Append(errors, err)
 
 	or.failedToEnqueueSpans, err = meter.Int64Counter(
-		obsmetrics.ExporterPrefix+obsmetrics.FailedToEnqueueSpansKey,
+		obsmetrics.ExporterMetricPrefix+obsmetrics.FailedToEnqueueSpansKey,
 		metric.WithDescription("Number of spans failed to be added to the sending queue."),
 		metric.WithUnit("1"))
 	errors = multierr.Append(errors, err)
 
 	or.sentMetricPoints, err = meter.Int64Counter(
-		obsmetrics.ExporterPrefix+obsmetrics.SentMetricPointsKey,
+		obsmetrics.ExporterMetricPrefix+obsmetrics.SentMetricPointsKey,
 		metric.WithDescription("Number of metric points successfully sent to destination."),
 		metric.WithUnit("1"))
 	errors = multierr.Append(errors, err)
 
 	or.failedToSendMetricPoints, err = meter.Int64Counter(
-		obsmetrics.ExporterPrefix+obsmetrics.FailedToSendMetricPointsKey,
+		obsmetrics.ExporterMetricPrefix+obsmetrics.FailedToSendMetricPointsKey,
 		metric.WithDescription("Number of metric points in failed attempts to send to destination."),
 		metric.WithUnit("1"))
 	errors = multierr.Append(errors, err)
 
 	or.failedToEnqueueMetricPoints, err = meter.Int64Counter(
-		obsmetrics.ExporterPrefix+obsmetrics.FailedToEnqueueMetricPointsKey,
+		obsmetrics.ExporterMetricPrefix+obsmetrics.FailedToEnqueueMetricPointsKey,
 		metric.WithDescription("Number of metric points failed to be added to the sending queue."),
 		metric.WithUnit("1"))
 	errors = multierr.Append(errors, err)
 
 	or.sentLogRecords, err = meter.Int64Counter(
-		obsmetrics.ExporterPrefix+obsmetrics.SentLogRecordsKey,
+		obsmetrics.ExporterMetricPrefix+obsmetrics.SentLogRecordsKey,
 		metric.WithDescription("Number of log record successfully sent to destination."),
 		metric.WithUnit("1"))
 	errors = multierr.Append(errors, err)
 
 	or.failedToSendLogRecords, err = meter.Int64Counter(
-		obsmetrics.ExporterPrefix+obsmetrics.FailedToSendLogRecordsKey,
+		obsmetrics.ExporterMetricPrefix+obsmetrics.FailedToSendLogRecordsKey,
 		metric.WithDescription("Number of log records in failed attempts to send to destination."),
 		metric.WithUnit("1"))
 	errors = multierr.Append(errors, err)
 
 	or.failedToEnqueueLogRecords, err = meter.Int64Counter(
-		obsmetrics.ExporterPrefix+obsmetrics.FailedToEnqueueLogRecordsKey,
+		obsmetrics.ExporterMetricPrefix+obsmetrics.FailedToEnqueueLogRecordsKey,
 		metric.WithDescription("Number of log records failed to be added to the sending queue."),
 		metric.WithUnit("1"))
 	errors = multierr.Append(errors, err)

internal/obsreportconfig/obsmetrics/obs_exporter.go

@@ -30,8 +30,9 @@ const (
 )
 
 var (
-	ExporterPrefix                 = ExporterKey + NameSep
-	ExportTraceDataOperationSuffix = NameSep + "traces"
-	ExportMetricsOperationSuffix   = NameSep + "metrics"
-	ExportLogsOperationSuffix      = NameSep + "logs"
+	ExporterPrefix                 = ExporterKey + SpanNameSep
+	ExporterMetricPrefix           = ExporterKey + MetricNameSep
+	ExportTraceDataOperationSuffix = SpanNameSep + "traces"
+	ExportMetricsOperationSuffix   = SpanNameSep + "metrics"
+	ExportLogsOperationSuffix      = SpanNameSep + "logs"
 )

internal/obsreportconfig/obsmetrics/obs_processor.go

@@ -18,5 +18,5 @@ const (
 )
 
 var (
-	ProcessorPrefix = ProcessorKey + NameSep
+	ProcessorMetricPrefix = ProcessorKey + MetricNameSep
 )

internal/obsreportconfig/obsmetrics/obs_receiver.go

@@ -30,8 +30,9 @@ const (
 )
 
 var (
-	ReceiverPrefix                  = ReceiverKey + NameSep
-	ReceiveTraceDataOperationSuffix = NameSep + "TraceDataReceived"
-	ReceiverMetricsOperationSuffix  = NameSep + "MetricsReceived"
-	ReceiverLogsOperationSuffix     = NameSep + "LogsReceived"
+	ReceiverPrefix                  = ReceiverKey + SpanNameSep
+	ReceiverMetricPrefix            = ReceiverKey + MetricNameSep
+	ReceiveTraceDataOperationSuffix = SpanNameSep + "TraceDataReceived"
+	ReceiverMetricsOperationSuffix  = SpanNameSep + "MetricsReceived"
+	ReceiverLogsOperationSuffix     = SpanNameSep + "LogsReceived"
 )

internal/obsreportconfig/obsmetrics/obs_scraper.go

@@ -16,6 +16,7 @@ const (
 )
 
 const (
-	ScraperPrefix                 = ScraperKey + NameSep
-	ScraperMetricsOperationSuffix = NameSep + "MetricsScraped"
+	ScraperPrefix                 = ScraperKey + SpanNameSep
+	ScraperMetricPrefix           = ScraperKey + MetricNameSep
+	ScraperMetricsOperationSuffix = SpanNameSep + "MetricsScraped"
 )

internal/obsreportconfig/obsmetrics/obsmetrics.go

@@ -7,6 +7,7 @@
 package obsmetrics // import "go.opentelemetry.io/collector/internal/obsreportconfig/obsmetrics"
 
 const (
-	NameSep = "/"
-	Scope   = "go.opentelemetry.io/collector/obsreport"
+	SpanNameSep   = "/"
+	MetricNameSep = "_"
+	Scope         = "go.opentelemetry.io/collector/obsreport"
 )

processor/processorhelper/obsreport.go

@@ -19,21 +19,21 @@ import (
 )
 
 var (
-	processorScope = obsmetrics.Scope + obsmetrics.NameSep + obsmetrics.ProcessorKey
+	processorScope = obsmetrics.Scope + obsmetrics.SpanNameSep + obsmetrics.ProcessorKey
 )
 
 // BuildCustomMetricName is used to be build a metric name following
 // the standards used in the Collector. The configType should be the same
 // value used to identify the type on the config.
 func BuildCustomMetricName(configType, metric string) string {
-	componentPrefix := obsmetrics.ProcessorPrefix
-	if !strings.HasSuffix(componentPrefix, obsmetrics.NameSep) {
-		componentPrefix += obsmetrics.NameSep
+	componentPrefix := obsmetrics.ProcessorMetricPrefix
+	if !strings.HasSuffix(componentPrefix, obsmetrics.MetricNameSep) {
+		componentPrefix += obsmetrics.MetricNameSep
 	}
 	if configType == "" {
 		return componentPrefix
 	}
-	return componentPrefix + configType + obsmetrics.NameSep + metric
+	return componentPrefix + configType + obsmetrics.MetricNameSep + metric
 }
 
 // ObsReport is a helper to add observability to a processor.
@@ -87,63 +87,63 @@ func (or *ObsReport) createOtelMetrics(cfg ObsReportSettings) error {
 	var errors, err error
 
 	or.acceptedSpansCounter, err = meter.Int64Counter(
-		obsmetrics.ProcessorPrefix+obsmetrics.AcceptedSpansKey,
+		obsmetrics.ProcessorMetricPrefix+obsmetrics.AcceptedSpansKey,
 		metric.WithDescription("Number of spans successfully pushed into the next component in the pipeline."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	or.refusedSpansCounter, err = meter.Int64Counter(
-		obsmetrics.ProcessorPrefix+obsmetrics.RefusedSpansKey,
+		obsmetrics.ProcessorMetricPrefix+obsmetrics.RefusedSpansKey,
 		metric.WithDescription("Number of spans that were rejected by the next component in the pipeline."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	or.droppedSpansCounter, err = meter.Int64Counter(
-		obsmetrics.ProcessorPrefix+obsmetrics.DroppedSpansKey,
+		obsmetrics.ProcessorMetricPrefix+obsmetrics.DroppedSpansKey,
 		metric.WithDescription("Number of spans that were dropped."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	or.acceptedMetricPointsCounter, err = meter.Int64Counter(
-		obsmetrics.ProcessorPrefix+obsmetrics.AcceptedMetricPointsKey,
+		obsmetrics.ProcessorMetricPrefix+obsmetrics.AcceptedMetricPointsKey,
 		metric.WithDescription("Number of metric points successfully pushed into the next component in the pipeline."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	or.refusedMetricPointsCounter, err = meter.Int64Counter(
-		obsmetrics.ProcessorPrefix+obsmetrics.RefusedMetricPointsKey,
+		obsmetrics.ProcessorMetricPrefix+obsmetrics.RefusedMetricPointsKey,
 		metric.WithDescription("Number of metric points that were rejected by the next component in the pipeline."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	or.droppedMetricPointsCounter, err = meter.Int64Counter(
-		obsmetrics.ProcessorPrefix+obsmetrics.DroppedMetricPointsKey,
+		obsmetrics.ProcessorMetricPrefix+obsmetrics.DroppedMetricPointsKey,
 		metric.WithDescription("Number of metric points that were dropped."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	or.acceptedLogRecordsCounter, err = meter.Int64Counter(
-		obsmetrics.ProcessorPrefix+obsmetrics.AcceptedLogRecordsKey,
+		obsmetrics.ProcessorMetricPrefix+obsmetrics.AcceptedLogRecordsKey,
 		metric.WithDescription("Number of log records successfully pushed into the next component in the pipeline."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	or.refusedLogRecordsCounter, err = meter.Int64Counter(
-		obsmetrics.ProcessorPrefix+obsmetrics.RefusedLogRecordsKey,
+		obsmetrics.ProcessorMetricPrefix+obsmetrics.RefusedLogRecordsKey,
 		metric.WithDescription("Number of log records that were rejected by the next component in the pipeline."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	or.droppedLogRecordsCounter, err = meter.Int64Counter(
-		obsmetrics.ProcessorPrefix+obsmetrics.DroppedLogRecordsKey,
+		obsmetrics.ProcessorMetricPrefix+obsmetrics.DroppedLogRecordsKey,
 		metric.WithDescription("Number of log records that were dropped."),
 		metric.WithUnit("1"),
 	)

processor/processorhelper/obsreport_test.go

@@ -63,11 +63,11 @@ func TestBuildProcessorCustomMetricName(t *testing.T) {
 	}{
 		{
 			name: "firstMeasure",
-			want: "processor/test_type/firstMeasure",
+			want: "processor_test_type_firstMeasure",
 		},
 		{
 			name: "secondMeasure",
-			want: "processor/test_type/secondMeasure",
+			want: "processor_test_type_secondMeasure",
 		},
 	}
 	for _, tt := range tests {

receiver/receiverhelper/obsreport.go

@@ -20,7 +20,7 @@ import (
 )
 
 const (
-	receiverScope = obsmetrics.Scope + obsmetrics.NameSep + obsmetrics.ReceiverKey
+	receiverScope = obsmetrics.Scope + obsmetrics.SpanNameSep + obsmetrics.ReceiverKey
 )
 
 // ObsReport is a helper to add observability to a receiver.
@@ -88,42 +88,42 @@ func (rec *ObsReport) createOtelMetrics() error {
 	var errors, err error
 
 	rec.acceptedSpansCounter, err = rec.meter.Int64Counter(
-		obsmetrics.ReceiverPrefix+obsmetrics.AcceptedSpansKey,
+		obsmetrics.ReceiverMetricPrefix+obsmetrics.AcceptedSpansKey,
 		metric.WithDescription("Number of spans successfully pushed into the pipeline."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	rec.refusedSpansCounter, err = rec.meter.Int64Counter(
-		obsmetrics.ReceiverPrefix+obsmetrics.RefusedSpansKey,
+		obsmetrics.ReceiverMetricPrefix+obsmetrics.RefusedSpansKey,
 		metric.WithDescription("Number of spans that could not be pushed into the pipeline."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	rec.acceptedMetricPointsCounter, err = rec.meter.Int64Counter(
-		obsmetrics.ReceiverPrefix+obsmetrics.AcceptedMetricPointsKey,
+		obsmetrics.ReceiverMetricPrefix+obsmetrics.AcceptedMetricPointsKey,
 		metric.WithDescription("Number of metric points successfully pushed into the pipeline."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	rec.refusedMetricPointsCounter, err = rec.meter.Int64Counter(
-		obsmetrics.ReceiverPrefix+obsmetrics.RefusedMetricPointsKey,
+		obsmetrics.ReceiverMetricPrefix+obsmetrics.RefusedMetricPointsKey,
 		metric.WithDescription("Number of metric points that could not be pushed into the pipeline."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	rec.acceptedLogRecordsCounter, err = rec.meter.Int64Counter(
-		obsmetrics.ReceiverPrefix+obsmetrics.AcceptedLogRecordsKey,
+		obsmetrics.ReceiverMetricPrefix+obsmetrics.AcceptedLogRecordsKey,
 		metric.WithDescription("Number of log records successfully pushed into the pipeline."),
 		metric.WithUnit("1"),
 	)
 	errors = multierr.Append(errors, err)
 
 	rec.refusedLogRecordsCounter, err = rec.meter.Int64Counter(
-		obsmetrics.ReceiverPrefix+obsmetrics.RefusedLogRecordsKey,
+		obsmetrics.ReceiverMetricPrefix+obsmetrics.RefusedLogRecordsKey,
 		metric.WithDescription("Number of log records that could not be pushed into the pipeline."),
 		metric.WithUnit("1"),
 	)

receiver/scraperhelper/obsreport.go

@@ -22,7 +22,7 @@ import (
 )
 
 var (
-	scraperScope = obsmetrics.Scope + obsmetrics.NameSep + obsmetrics.ScraperKey
+	scraperScope = obsmetrics.Scope + obsmetrics.SpanNameSep + obsmetrics.ScraperKey
 )
 
 // ObsReport is a helper to add observability to a scraper.
@@ -98,7 +98,7 @@ func (s *ObsReport) createOtelMetrics(cfg ObsReportSettings) error {
 // returned context should be used in other calls to the obsreport functions
 // dealing with the same scrape operation.
 func (s *ObsReport) StartMetricsOp(ctx context.Context) context.Context {
-	spanName := obsmetrics.ScraperPrefix + s.receiverID.String() + obsmetrics.NameSep + s.scraper.String() + obsmetrics.ScraperMetricsOperationSuffix
+	spanName := obsmetrics.ScraperPrefix + s.receiverID.String() + obsmetrics.SpanNameSep + s.scraper.String() + obsmetrics.ScraperMetricsOperationSuffix
 	ctx, _ = s.tracer.Start(ctx, spanName)
 	return ctx
 }