Skip to content

Commit 5753a58

Browse files
codebotencodeboten
authored
update all metrics to include otelcol_ prefix (#9759)
This ensures the consistency for folks emitting metrics w/ OTLP until the OTEP to specify pipeline telemetry is completed. Waiting on #9775 before moving this forward Fixes #9315 --------- Signed-off-by: Alex Boten <[email protected]>
1 parent 1dc6428 commit 5753a58

File tree

25 files changed

+240
-214
lines changed

25 files changed

+240
-214
lines changed

‎.chloggen/codeboten_update-all-metrics-with-prefix.yaml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: breaking
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
7+
component: service
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: "Update all metrics to include `otelcol_` prefix to ensure consistency across OTLP and Prometheus metrics"
11+
12+
# One or more tracking issues or pull requests related to the change
13+
issues: [9759]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext: |
19+
This change is marked as a breaking change as anyone that was using OTLP for metrics will
20+
see the new prefix which was not present before. Prometheus generated metrics remain
21+
unchanged.
22+
23+
# Optional: The change log or logs in which this entry should be included.
24+
# e.g. '[user]' or '[user, api]'
25+
# Include 'user' if the change is relevant to end users.
26+
# Include 'api' if there is a change to a library API.
27+
# Default: '[user]'
28+
change_logs: []

‎cmd/mdatagen/internal/samplereceiver/documentation.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,23 +117,23 @@ metrics:
117117
118118
The following telemetry is emitted by this component.
119119
120-
### batch_size_trigger_send
120+
### otelcol_batch_size_trigger_send
121121
122122
Number of times the batch was sent due to a size trigger
123123
124124
| Unit | Metric Type | Value Type | Monotonic |
125125
| ---- | ----------- | ---------- | --------- |
126126
| 1 | Sum | Int | true |
127127
128-
### process_runtime_total_alloc_bytes
128+
### otelcol_process_runtime_total_alloc_bytes
129129
130130
Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc')
131131
132132
| Unit | Metric Type | Value Type | Monotonic |
133133
| ---- | ----------- | ---------- | --------- |
134134
| By | Sum | Int | true |
135135
136-
### queue_length
136+
### otelcol_queue_length
137137
138138
This metric is optional and therefore not initialized in NewTelemetryBuilder.
139139
@@ -143,7 +143,7 @@ For example this metric only exists if feature A is enabled.
143143
| ---- | ----------- | ---------- |
144144
| 1 | Gauge | Int |
145145
146-
### request_duration
146+
### otelcol_request_duration
147147
148148
Duration of request
149149

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

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎cmd/mdatagen/internal/samplereceiver/metrics_test.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func TestComponentTelemetry(t *testing.T) {
3030
require.NoError(t, err)
3131
tt.assertMetrics(t, []metricdata.Metrics{
3232
{
33-
Name: "batch_size_trigger_send",
33+
Name: "otelcol_batch_size_trigger_send",
3434
Description: "Number of times the batch was sent due to a size trigger",
3535
Unit: "1",
3636
Data: metricdata.Sum[int64]{
@@ -44,7 +44,7 @@ func TestComponentTelemetry(t *testing.T) {
4444
},
4545
},
4646
{
47-
Name: "process_runtime_total_alloc_bytes",
47+
Name: "otelcol_process_runtime_total_alloc_bytes",
4848
Description: "Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc')",
4949
Unit: "By",
5050
Data: metricdata.Sum[int64]{
@@ -63,7 +63,7 @@ func TestComponentTelemetry(t *testing.T) {
6363
rcv.initOptionalMetric()
6464
tt.assertMetrics(t, []metricdata.Metrics{
6565
{
66-
Name: "batch_size_trigger_send",
66+
Name: "otelcol_batch_size_trigger_send",
6767
Description: "Number of times the batch was sent due to a size trigger",
6868
Unit: "1",
6969
Data: metricdata.Sum[int64]{
@@ -77,7 +77,7 @@ func TestComponentTelemetry(t *testing.T) {
7777
},
7878
},
7979
{
80-
Name: "process_runtime_total_alloc_bytes",
80+
Name: "otelcol_process_runtime_total_alloc_bytes",
8181
Description: "Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc')",
8282
Unit: "By",
8383
Data: metricdata.Sum[int64]{
@@ -91,7 +91,7 @@ func TestComponentTelemetry(t *testing.T) {
9191
},
9292
},
9393
{
94-
Name: "queue_length",
94+
Name: "otelcol_queue_length",
9595
Description: "This metric is optional and therefore not initialized in NewTelemetryBuilder.",
9696
Unit: "1",
9797
Data: metricdata.Gauge[int64]{

‎cmd/mdatagen/templates/documentation.md.tmpl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
{{- $metricName := . }}
3939
{{- $metric := $metricName | telemetryInfo -}}
4040

41-
### {{ $metricName }}
41+
### otelcol_{{ $metricName }}
4242

4343
{{ $metric.Description }}
4444

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ func WithLevel(lvl configtelemetry.Level) telemetryBuilderOption {
5454
func (builder *TelemetryBuilder) Init{{ $name.Render }}({{ if $metric.Data.Async -}}cb func() {{ $metric.Data.BasicType }}{{- end }}, opts ...metric.ObserveOption) error {
5555
var err error
5656
builder.{{ $name.Render }}, err = builder.meter.{{ $metric.Data.Instrument }}(
57-
"{{ $name }}",
57+
"otelcol_{{ $name }}",
5858
metric.WithDescription("{{ $metric.Description }}"),
5959
metric.WithUnit("{{ $metric.Unit }}"),
6060
{{- if eq $metric.Data.Type "Histogram" -}}
@@ -106,7 +106,7 @@ func NewTelemetryBuilder(settings component.TelemetrySettings, options ...teleme
106106
{{- range $name, $metric := .Telemetry.Metrics }}
107107
{{- if not $metric.Optional }}
108108
builder.{{ $name.Render }}, err = builder.meter.{{ $metric.Data.Instrument }}(
109-
"{{ $name }}",
109+
"otelcol_{{ $name }}",
110110
metric.WithDescription("{{ $metric.Description }}"),
111111
metric.WithUnit("{{ $metric.Unit }}"),
112112
{{- if eq $metric.Data.Type "Histogram" -}}

‎component/componenttest/otelprometheuschecker.go‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,7 @@ func (pc *prometheusChecker) checkExporterMetricGauge(exporter component.ID, met
117117
}
118118

119119
func (pc *prometheusChecker) checkCounter(expectedMetric string, value int64, attrs []attribute.KeyValue) error {
120-
121-
ts, err := pc.getMetric(expectedMetric, io_prometheus_client.MetricType_COUNTER, attrs)
120+
ts, err := pc.getMetric(fmt.Sprintf("otelcol_%s", expectedMetric), io_prometheus_client.MetricType_COUNTER, attrs)
122121
if err != nil {
123122
return err
124123
}

‎component/componenttest/testdata/prometheus_response‎

Lines changed: 78 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,81 @@
1-
# HELP exporter_send_failed_spans Number of spans in failed attempts to send to destination.
2-
# TYPE exporter_send_failed_spans counter
3-
exporter_send_failed_spans{exporter="fakeExporter"} 14
4-
# HELP exporter_sent_spans Number of spans successfully sent to destination.
5-
# TYPE exporter_sent_spans counter
6-
exporter_sent_spans{exporter="fakeExporter"} 43
7-
# HELP exporter_send_failed_metric_points Number of metrics in failed attempts to send to destination.
8-
# TYPE exporter_send_failed_metric_points counter
9-
exporter_send_failed_metric_points{exporter="fakeExporter"} 42
10-
# HELP exporter_sent_metric_points Number of metrics successfully sent to destination.
11-
# TYPE exporter_sent_metric_points counter
12-
exporter_sent_metric_points{exporter="fakeExporter"} 8
13-
# HELP exporter_send_failed_log_records Number of logs in failed attempts to send to destination.
14-
# TYPE exporter_send_failed_log_records counter
15-
exporter_send_failed_log_records{exporter="fakeExporter"} 36
16-
# HELP exporter_sent_log_records Number of logs successfully sent to destination.
17-
# TYPE exporter_sent_log_records counter
18-
exporter_sent_log_records{exporter="fakeExporter"} 103
19-
# HELP processor_accepted_spans Number of spans successfully pushed into the next component in the pipeline.
20-
# TYPE processor_accepted_spans counter
21-
processor_accepted_spans{processor="fakeProcessor"} 42
22-
# HELP processor_refused_spans Number of spans that were rejected by the next component in the pipeline.
23-
# TYPE processor_refused_spans counter
24-
processor_refused_spans{processor="fakeProcessor"} 13
25-
# HELP processor_dropped_spans Number of spans that were dropped.
26-
# TYPE processor_dropped_spans counter
27-
processor_dropped_spans{processor="fakeProcessor"} 7
28-
# HELP processor_inserted_spans Number of spans that were inserted.
29-
# TYPE processor_inserted_spans counter
30-
processor_inserted_spans{processor="fakeProcessor"} 5
31-
# HELP processor_accepted_metric_points Number of metric points successfully pushed into the next component in the pipeline.
32-
# TYPE processor_accepted_metric_points counter
33-
processor_accepted_metric_points{processor="fakeProcessor"} 7
34-
# HELP processor_refused_metric_points Number of metric points that were rejected by the next component in the pipeline.
35-
# TYPE processor_refused_metric_points counter
36-
processor_refused_metric_points{processor="fakeProcessor"} 41
37-
# HELP processor_dropped_metric_points Number of metric points that were dropped.
38-
# TYPE processor_dropped_metric_points counter
39-
processor_dropped_metric_points{processor="fakeProcessor"} 13
40-
# HELP processor_inserted_metric_points Number of metric points that were inserted.
41-
# TYPE processor_inserted_metric_points counter
42-
processor_inserted_metric_points{processor="fakeProcessor"} 4
43-
# HELP processor_accepted_log_records Number of log records successfully pushed into the next component in the pipeline.
44-
# TYPE processor_accepted_log_records counter
45-
processor_accepted_log_records{processor="fakeProcessor"} 102
46-
# HELP processor_refused_log_records Number of log records that were rejected by the next component in the pipeline.
47-
# TYPE processor_refused_log_records counter
48-
processor_refused_log_records{processor="fakeProcessor"} 35
49-
# HELP processor_dropped_log_records Number of log records that were dropped.
50-
# TYPE processor_dropped_log_records counter
51-
processor_dropped_log_records{processor="fakeProcessor"} 14
52-
# HELP processor_inserted_log_records Number of log records that were inserted.
53-
# TYPE processor_inserted_log_records counter
54-
processor_inserted_log_records{processor="fakeProcessor"} 3
55-
# HELP receiver_accepted_log_records Number of log records successfully pushed into the pipeline.
56-
# TYPE receiver_accepted_log_records counter
57-
receiver_accepted_log_records{receiver="fakeReceiver",transport="fakeTransport"} 102
58-
# HELP receiver_accepted_metric_points Number of metric points successfully pushed into the pipeline.
59-
# TYPE receiver_accepted_metric_points counter
60-
receiver_accepted_metric_points{receiver="fakeReceiver",transport="fakeTransport"} 7
61-
# HELP receiver_accepted_spans Number of spans successfully pushed into the pipeline.
62-
# TYPE receiver_accepted_spans counter
63-
receiver_accepted_spans{receiver="fakeReceiver",transport="fakeTransport"} 42
64-
# HELP receiver_refused_log_records Number of log records that could not be pushed into the pipeline.
65-
# TYPE receiver_refused_log_records counter
66-
receiver_refused_log_records{receiver="fakeReceiver",transport="fakeTransport"} 35
67-
# HELP receiver_refused_metric_points Number of metric points that could not be pushed into the pipeline.
68-
# TYPE receiver_refused_metric_points counter
69-
receiver_refused_metric_points{receiver="fakeReceiver",transport="fakeTransport"} 41
70-
# HELP receiver_refused_spans Number of spans that could not be pushed into the pipeline.
71-
# TYPE receiver_refused_spans counter
72-
receiver_refused_spans{receiver="fakeReceiver",transport="fakeTransport"} 13
73-
# HELP scraper_scraped_metric_points Number of metric points successfully scraped.
74-
# TYPE scraper_scraped_metric_points counter
75-
scraper_scraped_metric_points{receiver="fakeReceiver",scraper="fakeScraper"} 7
76-
# HELP scraper_errored_metric_points Number of metric points that were unable to be scraped.
77-
# TYPE scraper_errored_metric_points counter
78-
scraper_errored_metric_points{receiver="fakeReceiver",scraper="fakeScraper"} 41
1+
# HELP otelcol_exporter_send_failed_spans Number of spans in failed attempts to send to destination.
2+
# TYPE otelcol_exporter_send_failed_spans counter
3+
otelcol_exporter_send_failed_spans{exporter="fakeExporter"} 14
4+
# HELP otelcol_exporter_sent_spans Number of spans successfully sent to destination.
5+
# TYPE otelcol_exporter_sent_spans counter
6+
otelcol_exporter_sent_spans{exporter="fakeExporter"} 43
7+
# HELP otelcol_exporter_send_failed_metric_points Number of metrics in failed attempts to send to destination.
8+
# TYPE otelcol_exporter_send_failed_metric_points counter
9+
otelcol_exporter_send_failed_metric_points{exporter="fakeExporter"} 42
10+
# HELP otelcol_exporter_sent_metric_points Number of metrics successfully sent to destination.
11+
# TYPE otelcol_exporter_sent_metric_points counter
12+
otelcol_exporter_sent_metric_points{exporter="fakeExporter"} 8
13+
# HELP otelcol_exporter_send_failed_log_records Number of logs in failed attempts to send to destination.
14+
# TYPE otelcol_exporter_send_failed_log_records counter
15+
otelcol_exporter_send_failed_log_records{exporter="fakeExporter"} 36
16+
# HELP otelcol_exporter_sent_log_records Number of logs successfully sent to destination.
17+
# TYPE otelcol_exporter_sent_log_records counter
18+
otelcol_exporter_sent_log_records{exporter="fakeExporter"} 103
19+
# HELP otelcol_processor_accepted_spans Number of spans successfully pushed into the next component in the pipeline.
20+
# TYPE otelcol_processor_accepted_spans counter
21+
otelcol_processor_accepted_spans{processor="fakeProcessor"} 42
22+
# HELP otelcol_processor_refused_spans Number of spans that were rejected by the next component in the pipeline.
23+
# TYPE otelcol_processor_refused_spans counter
24+
otelcol_processor_refused_spans{processor="fakeProcessor"} 13
25+
# HELP otelcol_processor_dropped_spans Number of spans that were dropped.
26+
# TYPE otelcol_processor_dropped_spans counter
27+
otelcol_processor_dropped_spans{processor="fakeProcessor"} 7
28+
# HELP otelcol_processor_inserted_spans Number of spans that were inserted.
29+
# TYPE otelcol_processor_inserted_spans counter
30+
otelcol_processor_inserted_spans{processor="fakeProcessor"} 5
31+
# HELP otelcol_processor_accepted_metric_points Number of metric points successfully pushed into the next component in the pipeline.
32+
# TYPE otelcol_processor_accepted_metric_points counter
33+
otelcol_processor_accepted_metric_points{processor="fakeProcessor"} 7
34+
# HELP otelcol_processor_refused_metric_points Number of metric points that were rejected by the next component in the pipeline.
35+
# TYPE otelcol_processor_refused_metric_points counter
36+
otelcol_processor_refused_metric_points{processor="fakeProcessor"} 41
37+
# HELP otelcol_processor_dropped_metric_points Number of metric points that were dropped.
38+
# TYPE otelcol_processor_dropped_metric_points counter
39+
otelcol_processor_dropped_metric_points{processor="fakeProcessor"} 13
40+
# HELP otelcol_processor_inserted_metric_points Number of metric points that were inserted.
41+
# TYPE otelcol_processor_inserted_metric_points counter
42+
otelcol_processor_inserted_metric_points{processor="fakeProcessor"} 4
43+
# HELP otelcol_processor_accepted_log_records Number of log records successfully pushed into the next component in the pipeline.
44+
# TYPE otelcol_processor_accepted_log_records counter
45+
otelcol_processor_accepted_log_records{processor="fakeProcessor"} 102
46+
# HELP otelcol_processor_refused_log_records Number of log records that were rejected by the next component in the pipeline.
47+
# TYPE otelcol_processor_refused_log_records counter
48+
otelcol_processor_refused_log_records{processor="fakeProcessor"} 35
49+
# HELP otelcol_processor_dropped_log_records Number of log records that were dropped.
50+
# TYPE otelcol_processor_dropped_log_records counter
51+
otelcol_processor_dropped_log_records{processor="fakeProcessor"} 14
52+
# HELP otelcol_processor_inserted_log_records Number of log records that were inserted.
53+
# TYPE otelcol_processor_inserted_log_records counter
54+
otelcol_processor_inserted_log_records{processor="fakeProcessor"} 3
55+
# HELP otelcol_receiver_accepted_log_records Number of log records successfully pushed into the pipeline.
56+
# TYPE otelcol_receiver_accepted_log_records counter
57+
otelcol_receiver_accepted_log_records{receiver="fakeReceiver",transport="fakeTransport"} 102
58+
# HELP otelcol_receiver_accepted_metric_points Number of metric points successfully pushed into the pipeline.
59+
# TYPE otelcol_receiver_accepted_metric_points counter
60+
otelcol_receiver_accepted_metric_points{receiver="fakeReceiver",transport="fakeTransport"} 7
61+
# HELP otelcol_receiver_accepted_spans Number of spans successfully pushed into the pipeline.
62+
# TYPE otelcol_receiver_accepted_spans counter
63+
otelcol_receiver_accepted_spans{receiver="fakeReceiver",transport="fakeTransport"} 42
64+
# HELP otelcol_receiver_refused_log_records Number of log records that could not be pushed into the pipeline.
65+
# TYPE otelcol_receiver_refused_log_records counter
66+
otelcol_receiver_refused_log_records{receiver="fakeReceiver",transport="fakeTransport"} 35
67+
# HELP otelcol_receiver_refused_metric_points Number of metric points that could not be pushed into the pipeline.
68+
# TYPE otelcol_receiver_refused_metric_points counter
69+
otelcol_receiver_refused_metric_points{receiver="fakeReceiver",transport="fakeTransport"} 41
70+
# HELP otelcol_receiver_refused_spans Number of spans that could not be pushed into the pipeline.
71+
# TYPE otelcol_receiver_refused_spans counter
72+
otelcol_receiver_refused_spans{receiver="fakeReceiver",transport="fakeTransport"} 13
73+
# HELP otelcol_scraper_scraped_metric_points Number of metric points successfully scraped.
74+
# TYPE otelcol_scraper_scraped_metric_points counter
75+
otelcol_scraper_scraped_metric_points{receiver="fakeReceiver",scraper="fakeScraper"} 7
76+
# HELP otelcol_scraper_errored_metric_points Number of metric points that were unable to be scraped.
77+
# TYPE otelcol_scraper_errored_metric_points counter
78+
otelcol_scraper_errored_metric_points{receiver="fakeReceiver",scraper="fakeScraper"} 41
7979
# HELP gauge_metric A simple gauge metric
8080
# TYPE gauge_metric gauge
8181
gauge_metric 49

0 commit comments

Comments
 (0)