update all metrics to include otelcol_ prefix

This ensures the consistency for folks emitting metrics w/ OTLP until the OTEP to specify pipeline telemetry is completed.

Signed-off-by: Alex Boten <[email protected]>

Author: codeboten

service/internal/proctelemetry/config.go

@@ -214,7 +214,6 @@ func initPrometheusExporter(prometheusConfig *config.Prometheus, asyncErrorChann
 		otelprom.WithProducer(opencensus.NewMetricProducer()),
 		// This allows us to produce metrics that are backwards compatible w/ opencensus
 		otelprom.WithoutCounterSuffixes(),
-		otelprom.WithNamespace("otelcol"),
 		otelprom.WithResourceAsConstantLabels(attribute.NewDenyKeysFilter()),
 	)
 	if err != nil {

service/internal/proctelemetry/process_telemetry.go

@@ -19,6 +19,7 @@ import (
 const (
 	scopeName      = "go.opentelemetry.io/collector/service/process_telemetry"
 	processNameKey = "process_name"
+	otelPrefix     = "otelcol_"
 )
 
 // processMetrics is a struct that contains views related to process metrics (cpu, mem, etc)
@@ -93,7 +94,7 @@ func (pm *processMetrics) record(meter otelmetric.Meter) error {
 	var errs, err error
 
 	pm.otelProcessUptime, err = meter.Float64ObservableCounter(
-		"process_uptime",
+		otelPrefix+"process_uptime",
 		otelmetric.WithDescription("Uptime of the process"),
 		otelmetric.WithUnit("s"),
 		otelmetric.WithFloat64Callback(func(_ context.Context, o otelmetric.Float64Observer) error {
@@ -103,7 +104,7 @@ func (pm *processMetrics) record(meter otelmetric.Meter) error {
 	errs = multierr.Append(errs, err)
 
 	pm.otelAllocMem, err = meter.Int64ObservableGauge(
-		"process_runtime_heap_alloc_bytes",
+		otelPrefix+"process_runtime_heap_alloc_bytes",
 		otelmetric.WithDescription("Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc')"),
 		otelmetric.WithUnit("By"),
 		otelmetric.WithInt64Callback(func(_ context.Context, o otelmetric.Int64Observer) error {
@@ -113,7 +114,7 @@ func (pm *processMetrics) record(meter otelmetric.Meter) error {
 	errs = multierr.Append(errs, err)
 
 	pm.otelTotalAllocMem, err = meter.Int64ObservableCounter(
-		"process_runtime_total_alloc_bytes",
+		otelPrefix+"process_runtime_total_alloc_bytes",
 		otelmetric.WithDescription("Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc')"),
 		otelmetric.WithUnit("By"),
 		otelmetric.WithInt64Callback(func(_ context.Context, o otelmetric.Int64Observer) error {
@@ -123,7 +124,7 @@ func (pm *processMetrics) record(meter otelmetric.Meter) error {
 	errs = multierr.Append(errs, err)
 
 	pm.otelSysMem, err = meter.Int64ObservableGauge(
-		"process_runtime_total_sys_memory_bytes",
+		otelPrefix+"process_runtime_total_sys_memory_bytes",
 		otelmetric.WithDescription("Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys')"),
 		otelmetric.WithUnit("By"),
 		otelmetric.WithInt64Callback(func(_ context.Context, o otelmetric.Int64Observer) error {
@@ -133,7 +134,7 @@ func (pm *processMetrics) record(meter otelmetric.Meter) error {
 	errs = multierr.Append(errs, err)
 
 	pm.otelCPUSeconds, err = meter.Float64ObservableCounter(
-		"process_cpu_seconds",
+		otelPrefix+"process_cpu_seconds",
 		otelmetric.WithDescription("Total CPU user and system time in seconds"),
 		otelmetric.WithUnit("s"),
 		otelmetric.WithFloat64Callback(func(_ context.Context, o otelmetric.Float64Observer) error {
@@ -143,7 +144,7 @@ func (pm *processMetrics) record(meter otelmetric.Meter) error {
 	errs = multierr.Append(errs, err)
 
 	pm.otelRSSMemory, err = meter.Int64ObservableGauge(
-		"process_memory_rss",
+		otelPrefix+"process_memory_rss",
 		otelmetric.WithDescription("Total physical memory (resident set size)"),
 		otelmetric.WithUnit("By"),
 		otelmetric.WithInt64Callback(func(_ context.Context, o otelmetric.Int64Observer) error {

service/internal/proctelemetry/process_telemetry_linux_test.go

@@ -39,7 +39,7 @@ func TestProcessTelemetryWithHostProc(t *testing.T) {
 		} else {
 			metricValue = metric.Metric[0].GetGauge().GetValue()
 		}
-		if strings.HasPrefix(metricName, "process_uptime") || strings.HasPrefix(metricName, "process_cpu_seconds") {
+		if strings.HasPrefix(metricName, "otelcol_process_uptime") || strings.HasPrefix(metricName, "otelcol_process_cpu_seconds") {
 			// This likely will still be zero when running the test.
 			assert.GreaterOrEqual(t, metricValue, float64(0), metricName)
 			continue

service/internal/proctelemetry/process_telemetry_test.go

@@ -32,12 +32,12 @@ type testTelemetry struct {
 }
 
 var expectedMetrics = []string{
-	"process_uptime",
-	"process_runtime_heap_alloc_bytes",
-	"process_runtime_total_alloc_bytes",
-	"process_runtime_total_sys_memory_bytes",
-	"process_cpu_seconds",
-	"process_memory_rss",
+	"otelcol_process_uptime",
+	"otelcol_process_runtime_heap_alloc_bytes",
+	"otelcol_process_runtime_total_alloc_bytes",
+	"otelcol_process_runtime_total_sys_memory_bytes",
+	"otelcol_process_cpu_seconds",
+	"otelcol_process_memory_rss",
 }
 
 func setupTelemetry(t *testing.T) testTelemetry {
@@ -94,7 +94,7 @@ func TestProcessTelemetry(t *testing.T) {
 		} else {
 			metricValue = metric.Metric[0].GetGauge().GetValue()
 		}
-		if strings.HasPrefix(metricName, "process_uptime") || strings.HasPrefix(metricName, "process_cpu_seconds") {
+		if strings.HasPrefix(metricName, "otel_process_uptime") || strings.HasPrefix(metricName, "otel_process_cpu_seconds") {
 			// This likely will still be zero when running the test.
 			assert.GreaterOrEqual(t, metricValue, float64(0), metricName)
 			continue

service/telemetry_test.go

@@ -281,33 +281,33 @@ func TestTelemetryInit(t *testing.T) {
 
 func createTestMetrics(t *testing.T, mp metric.MeterProvider) *view.View {
 	// Creates a OTel Go counter
-	counter, err := mp.Meter("collector_test").Int64Counter(otelPrefix+counterName, metric.WithUnit("ms"))
+	counter, err := mp.Meter("collector_test").Int64Counter(metricPrefix+otelPrefix+counterName, metric.WithUnit("ms"))
 	require.NoError(t, err)
 	counter.Add(context.Background(), 13)
 
-	grpcExampleCounter, err := mp.Meter(proctelemetry.GRPCInstrumentation).Int64Counter(grpcPrefix + counterName)
+	grpcExampleCounter, err := mp.Meter(proctelemetry.GRPCInstrumentation).Int64Counter(metricPrefix + grpcPrefix + counterName)
 	require.NoError(t, err)
 	grpcExampleCounter.Add(context.Background(), 11, metric.WithAttributes(proctelemetry.GRPCUnacceptableKeyValues...))
 
-	httpExampleCounter, err := mp.Meter(proctelemetry.HTTPInstrumentation).Int64Counter(httpPrefix + counterName)
+	httpExampleCounter, err := mp.Meter(proctelemetry.HTTPInstrumentation).Int64Counter(metricPrefix + httpPrefix + counterName)
 	require.NoError(t, err)
 	httpExampleCounter.Add(context.Background(), 10, metric.WithAttributes(proctelemetry.HTTPUnacceptableKeyValues...))
 
 	// Creates a OpenCensus measure
-	ocCounter := stats.Int64(ocPrefix+counterName, counterName, stats.UnitDimensionless)
+	ocCounter := stats.Int64(metricPrefix+ocPrefix+counterName, counterName, stats.UnitDimensionless)
 	v := &view.View{
-		Name:        ocPrefix + counterName,
+		Name:        metricPrefix + ocPrefix + counterName,
 		Description: ocCounter.Description(),
 		Measure:     ocCounter,
 		Aggregation: view.Sum(),
 	}
 	err = view.Register(v)
 	require.NoError(t, err)
 
-	stats.Record(context.Background(), stats.Int64(ocPrefix+counterName, counterName, stats.UnitDimensionless).M(13))
+	stats.Record(context.Background(), stats.Int64(metricPrefix+ocPrefix+counterName, counterName, stats.UnitDimensionless).M(13))
 
 	// Forces a flush for the view data.
-	_, _ = view.RetrieveData(ocPrefix + counterName)
+	_, _ = view.RetrieveData(metricPrefix + ocPrefix + counterName)
 
 	return v
 }