Skip to content

fix: change metric units to singular #14753

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mx-psi merged 6 commits into from
Mar 12, 2026
Merged

fix: change metric units to singular #14753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bb1b94f
fix: change metric units to singular
andrzej-stencel Mar 11, 2026
cf816dd
add changelog entry
andrzej-stencel Mar 11, 2026
c2dcb9f
make gogenerate
andrzej-stencel Mar 11, 2026
2fc926e
fix tests
andrzej-stencel Mar 11, 2026
ade03f0
docs: change `change_type` to `breaking`
andrzej-stencel Mar 11, 2026
21ff594
Merge branch 'main' into units-singular
mx-psi Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .chloggen/units-singular.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: breaking

# The name of the component, or a single word describing the area of concern, (e.g. receiver/otlp)
component: all

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Change metric units to be singular to match OTel specification, e.g. `{requests}` -> `{request}`

# One or more tracking issues or pull requests related to the change
issues: [14753]

# (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: []
6 changes: 3 additions & 3 deletions cmd/mdatagen/internal/loader_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ func TestLoadMetadata(t *testing.T) {
Since: "1.5.0",
Note: "This metric will be removed in favor of batch_send_trigger_size",
},
Unit: strPtr("{times}"),
Unit: strPtr("{time}"),
Sum: &Sum{
MetricValueType: MetricValueType{pmetric.NumberDataPointValueTypeInt},
Mono: Mono{Monotonic: true},
Expand Down Expand Up @@ -500,7 +500,7 @@ func TestLoadMetadata(t *testing.T) {
Description: "This metric is optional and therefore not initialized in NewTelemetryBuilder.",
ExtendedDocumentation: "For example this metric only exists if feature A is enabled.",
},
Unit: strPtr("{items}"),
Unit: strPtr("{item}"),
Optional: true,
Gauge: &Gauge{
MetricValueType: MetricValueType{
Expand All @@ -515,7 +515,7 @@ func TestLoadMetadata(t *testing.T) {
Description: "Queue capacity - sync gauge example.",
Stability: component.StabilityLevelDevelopment,
},
Unit: strPtr("{items}"),
Unit: strPtr("{item}"),
Gauge: &Gauge{
MetricValueType: MetricValueType{
ValueType: pmetric.NumberDataPointValueTypeInt,
Expand Down
6 changes: 3 additions & 3 deletions cmd/mdatagen/internal/samplereceiver/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ Number of times the batch was sent due to a size trigger

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {times} | Sum | Int | true | Deprecated since 1.5.0 |
| {time} | Sum | Int | true | Deprecated since 1.5.0 |

**Deprecation note**: This metric will be removed in favor of batch_send_trigger_size

Expand All @@ -266,7 +266,7 @@ Queue capacity - sync gauge example.

| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| {items} | Gauge | Int | Development |
| {item} | Gauge | Int | Development |

### otelcol_queue_length

Expand All @@ -276,7 +276,7 @@ For example this metric only exists if feature A is enabled.

| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| {items} | Gauge | Int | Alpha |
| {item} | Gauge | Int | Alpha |

### otelcol_request_duration

Expand Down
6 changes: 3 additions & 3 deletions cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_telemetry.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions cmd/mdatagen/internal/samplereceiver/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ telemetry:
since: "1.5.0"
note: "This metric will be removed in favor of batch_send_trigger_size"
description: Number of times the batch was sent due to a size trigger
unit: "{times}"
unit: "{time}"
sum:
value_type: int
monotonic: true
Expand All @@ -329,15 +329,15 @@ telemetry:
enabled: true
description: Queue capacity - sync gauge example.
stability: development
unit: "{items}"
unit: "{item}"
gauge:
value_type: int
queue_length:
enabled: true
stability: alpha
description: This metric is optional and therefore not initialized in NewTelemetryBuilder.
extended_documentation: For example this metric only exists if feature A is enabled.
unit: "{items}"
unit: "{item}"
optional: true
gauge:
async: true
Expand Down
30 changes: 15 additions & 15 deletions exporter/exporterhelper/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,39 +12,39 @@ Number of log records failed to be added to the sending queue.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {records} | Sum | Int | true | Alpha |
| {record} | Sum | Int | true | Alpha |

### otelcol_exporter_enqueue_failed_metric_points

Number of metric points failed to be added to the sending queue.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {datapoints} | Sum | Int | true | Alpha |
| {datapoint} | Sum | Int | true | Alpha |

### otelcol_exporter_enqueue_failed_profile_samples

Number of profile samples failed to be added to the sending queue.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {samples} | Sum | Int | true | Development |
| {sample} | Sum | Int | true | Development |

### otelcol_exporter_enqueue_failed_spans

Number of spans failed to be added to the sending queue.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {spans} | Sum | Int | true | Alpha |
| {span} | Sum | Int | true | Alpha |

### otelcol_exporter_queue_batch_send_size

Number of units in the batch

| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| {units} | Histogram | Int | Development |
| {unit} | Histogram | Int | Development |

### otelcol_exporter_queue_batch_send_size_bytes

Expand All @@ -60,79 +60,79 @@ Fixed capacity of the retry queue (in batches).

| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| {batches} | Gauge | Int | Alpha |
| {batch} | Gauge | Int | Alpha |

### otelcol_exporter_queue_size

Current size of the retry queue (in batches).

| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| {batches} | Gauge | Int | Alpha |
| {batch} | Gauge | Int | Alpha |

### otelcol_exporter_send_failed_log_records

Number of log records in failed attempts to send to destination. At detailed telemetry level, includes attributes: error.type (semantic convention), error.permanent.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {records} | Sum | Int | true | Alpha |
| {record} | Sum | Int | true | Alpha |

### otelcol_exporter_send_failed_metric_points

Number of metric points in failed attempts to send to destination. At detailed telemetry level, includes attributes: error.type (semantic convention), error.permanent.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {datapoints} | Sum | Int | true | Alpha |
| {datapoint} | Sum | Int | true | Alpha |

### otelcol_exporter_send_failed_profile_samples

Number of profile samples in failed attempts to send to destination. At detailed telemetry level, includes attributes: error.type (semantic convention), error.permanent.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {samples} | Sum | Int | true | Development |
| {sample} | Sum | Int | true | Development |

### otelcol_exporter_send_failed_spans

Number of spans in failed attempts to send to destination. At detailed telemetry level, includes attributes: error.type (semantic convention), error.permanent.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {spans} | Sum | Int | true | Alpha |
| {span} | Sum | Int | true | Alpha |

### otelcol_exporter_sent_log_records

Number of log record successfully sent to destination.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {records} | Sum | Int | true | Alpha |
| {record} | Sum | Int | true | Alpha |

### otelcol_exporter_sent_metric_points

Number of metric points successfully sent to destination.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {datapoints} | Sum | Int | true | Alpha |
| {datapoint} | Sum | Int | true | Alpha |

### otelcol_exporter_sent_profile_samples

Number of profile samples successfully sent to destination.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {samples} | Sum | Int | true | Development |
| {sample} | Sum | Int | true | Development |

### otelcol_exporter_sent_spans

Number of spans successfully sent to destination.

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {spans} | Sum | Int | true | Alpha |
| {span} | Sum | Int | true | Alpha |

## Feature Gates

Expand Down
Loading
Loading