Skip to content

Add stability level info on generated metrics' documentation #13756

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 5 commits into from
Sep 10, 2025
Merged

Add stability level info on generated metrics' documentation #13756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4367f73
Add stability level info on generated metrics' documentation
ChrsMark Sep 3, 2025
80a9246
Merge branch 'main' into expose_stability_lvl
ChrsMark Sep 3, 2025
59f2f1a
Merge branch 'main' into expose_stability_lvl
ChrsMark Sep 8, 2025
146b057
Merge branch 'main' into expose_stability_lvl
dmathieu Sep 9, 2025
9a56ddc
Merge branch 'main' into expose_stability_lvl
ChrsMark Sep 10, 2025
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/expose_stability_lvl.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: 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: Expose stability level in generated metric documentation

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

# (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: [user]
24 changes: 12 additions & 12 deletions cmd/mdatagen/internal/samplereceiver/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,17 +192,17 @@ The following telemetry is emitted by this component.

Number of times the batch was sent due to a size trigger [deprecated since v0.110.0]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| {times} | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {times} | Sum | Int | true | deprecated |

### otelcol_process_runtime_total_alloc_bytes

Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc')

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| By | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| By | Sum | Int | true | stable |

### otelcol_queue_capacity

Expand All @@ -218,14 +218,14 @@ This metric is optional and therefore not initialized in NewTelemetryBuilder. [a

For example this metric only exists if feature A is enabled.

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

### otelcol_request_duration

Duration of request [alpha]

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| s | Histogram | Double |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| s | Histogram | Double | alpha |
12 changes: 6 additions & 6 deletions cmd/mdatagen/internal/samplescraper/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ The metric will be removed soon.

Monotonic cumulative sum int metric with string input_type enabled by default.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| s | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| s | Sum | Int | Cumulative | true | beta |

#### Attributes

Expand Down Expand Up @@ -90,9 +90,9 @@ metrics:

[DEPRECATED] Gauge double metric disabled by default.

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| | Gauge | Double |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| | Gauge | Double | deprecated |

#### Attributes

Expand Down
4 changes: 4 additions & 0 deletions cmd/mdatagen/internal/samplescraper/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ metrics:

optional.metric.empty_unit:
enabled: false
stability:
level: deprecated
description: "[DEPRECATED] Gauge double metric disabled by default."
unit: ""
gauge:
Expand All @@ -147,6 +149,8 @@ metrics:

metric.input_type:
enabled: true
stability:
level: beta
description: Monotonic cumulative sum int metric with string input_type enabled by default.
unit: s
sum:
Expand Down
10 changes: 6 additions & 4 deletions cmd/mdatagen/internal/templates/documentation.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@

{{- end }}

| Unit | Metric Type | Value Type |{{ if $metric.Data.HasAggregated }} Aggregation Temporality |{{ end }}{{ if $metric.Data.HasMonotonic }} Monotonic |{{ end }}
| ---- | ----------- | ---------- |{{ if $metric.Data.HasAggregated }} ----------------------- |{{ end }}{{ if $metric.Data.HasMonotonic }} --------- |{{ end }}
| Unit | Metric Type | Value Type |{{ if $metric.Data.HasAggregated }} Aggregation Temporality |{{ end }}{{ if $metric.Data.HasMonotonic }} Monotonic |{{ end }}{{ if $metric.Stability.Level }} Stability |{{ end }}
| ---- | ----------- | ---------- |{{ if $metric.Data.HasAggregated }} ----------------------- |{{ end }}{{ if $metric.Data.HasMonotonic }} --------- |{{ end }}{{ if $metric.Stability.Level }} --------- |{{ end }}
| {{ $metric.Unit }} | {{ $metric.Data.Type }} | {{ $metric.Data.MetricValueType }} |
{{- if $metric.Data.HasAggregated }} {{ $metric.Data.AggregationTemporality }} |{{ end }}
{{- if $metric.Data.HasMonotonic }} {{ $metric.Data.Monotonic }} |{{ end }}
{{- if $metric.Stability.Level }} {{ $metric.Stability.Level }} |{{ end }}

{{- if $metric.Attributes }}

Expand Down Expand Up @@ -78,10 +79,11 @@

{{- end }}

| Unit | Metric Type | Value Type |{{ if $metric.Data.HasMonotonic }} Monotonic |{{ end }}
| ---- | ----------- | ---------- |{{ if $metric.Data.HasMonotonic }} --------- |{{ end }}
| Unit | Metric Type | Value Type |{{ if $metric.Data.HasMonotonic }} Monotonic |{{ end }}{{ if $metric.Stability.Level }} Stability |{{ end }}
| ---- | ----------- | ---------- |{{ if $metric.Data.HasMonotonic }} --------- |{{ end }}{{ if $metric.Stability.Level }} --------- |{{ end }}
| {{ $metric.Unit }} | {{ $metric.Data.Type }} | {{ $metric.Data.MetricValueType }} |
{{- if $metric.Data.HasMonotonic }} {{ $metric.Data.Monotonic }} |{{ end }}
{{- if $metric.Stability.Level }} {{ $metric.Stability.Level }} |{{ end }}

{{- if $metric.Attributes }}

Expand Down
6 changes: 6 additions & 0 deletions cmd/mdatagen/metadata-schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,12 @@ metrics:
input_type: string
# Optional: array of attributes that were defined in the attributes section that are emitted by this metric.
attributes: [string]
# Optional: the metric stability
stability:
# Optional: the level of stability
level: <development|alpha|beta|stable|deprecated>
# Optional: the version current stability was introduced
from:

# Optional: map of event names with the key being the event name and value
# being described below.
Expand Down
66 changes: 33 additions & 33 deletions exporter/exporterhelper/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,25 @@ The following telemetry is emitted by this component.

Number of log records failed to be added to the sending queue. [alpha]

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

### otelcol_exporter_enqueue_failed_metric_points

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

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

### otelcol_exporter_enqueue_failed_spans

Number of spans failed to be added to the sending queue. [alpha]

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

### otelcol_exporter_queue_batch_send_size

Expand All @@ -50,62 +50,62 @@ Number of bytes in batch that was sent. Only available on detailed level.

Fixed capacity of the retry queue (in batches). [alpha]

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

### otelcol_exporter_queue_size

Current size of the retry queue (in batches). [alpha]

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

### otelcol_exporter_send_failed_log_records

Number of log records in failed attempts to send to destination. [alpha]

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

### otelcol_exporter_send_failed_metric_points

Number of metric points in failed attempts to send to destination. [alpha]

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

### otelcol_exporter_send_failed_spans

Number of spans in failed attempts to send to destination. [alpha]

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

### otelcol_exporter_sent_log_records

Number of log record successfully sent to destination. [alpha]

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

### otelcol_exporter_sent_metric_points

Number of metric points successfully sent to destination. [alpha]

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

### otelcol_exporter_sent_spans

Number of spans successfully sent to destination. [alpha]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| {spans} | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {spans} | Sum | Int | true | alpha |
36 changes: 18 additions & 18 deletions processor/memorylimiterprocessor/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,46 +10,46 @@ The following telemetry is emitted by this component.

Number of log records successfully pushed into the next component in the pipeline. [deprecated since v0.110.0]

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

### otelcol_processor_accepted_metric_points

Number of metric points successfully pushed into the next component in the pipeline. [deprecated since v0.110.0]

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

### otelcol_processor_accepted_spans

Number of spans successfully pushed into the next component in the pipeline. [deprecated since v0.110.0]

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

### otelcol_processor_refused_log_records

Number of log records that were rejected by the next component in the pipeline. [deprecated since v0.110.0]

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

### otelcol_processor_refused_metric_points

Number of metric points that were rejected by the next component in the pipeline. [deprecated since v0.110.0]

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

### otelcol_processor_refused_spans

Number of spans that were rejected by the next component in the pipeline. [deprecated since v0.110.0]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| {spans} | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {spans} | Sum | Int | true | deprecated |
18 changes: 9 additions & 9 deletions processor/processorhelper/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ The following telemetry is emitted by this component.

Number of items passed to the processor. [alpha]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| {items} | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {items} | Sum | Int | true | alpha |

### otelcol_processor_internal_duration

Duration of time taken to process a batch of telemetry data through the processor. [alpha]

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| s | Histogram | Double |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| s | Histogram | Double | alpha |

### otelcol_processor_outgoing_items

Number of items emitted from the processor. [alpha]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| {items} | Sum | Int | true |
| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {items} | Sum | Int | true | alpha |
Loading