Skip to content

Commit

Permalink
[service] update telemetry level to reflect their state (#11729)
Browse files Browse the repository at this point in the history
This sets the level of all metrics that where not previously stabilized
as alpha. Since many of these metrics will change as a result of
#11406, it
made sense to me to set their stability as alpha.

---------

Signed-off-by: Alex Boten <223565+codeboten@users.noreply.github.com>
  • Loading branch information
codeboten authored Nov 22, 2024
1 parent 827888d commit f74890a
Show file tree
Hide file tree
Showing 14 changed files with 125 additions and 48 deletions.
25 changes: 25 additions & 0 deletions .chloggen/codeboten_update-metric-stability.yaml
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: service

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: label metrics as alpha to communicate their stability

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

# (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: []
2 changes: 2 additions & 0 deletions cmd/mdatagen/internal/testdata/with_telemetry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,7 @@ telemetry:
description: Latency (in microseconds) of a given sampling policy
unit: µs
enabled: true
stability:
level: alpha
histogram:
value_type: int
22 changes: 11 additions & 11 deletions exporter/exporterhelper/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,87 +8,87 @@ The following telemetry is emitted by this component.

### otelcol_exporter_enqueue_failed_log_records

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

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

### otelcol_exporter_enqueue_failed_metric_points

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

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

### otelcol_exporter_enqueue_failed_spans

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

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

### otelcol_exporter_queue_capacity

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

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

### otelcol_exporter_queue_size

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

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

### otelcol_exporter_send_failed_log_records

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

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

### otelcol_exporter_send_failed_metric_points

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

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

### otelcol_exporter_send_failed_spans

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

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

### otelcol_exporter_sent_log_records

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

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

### otelcol_exporter_sent_metric_points

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

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

### otelcol_exporter_sent_spans

Number of spans successfully sent to destination.
Number of spans successfully sent to destination. [alpha]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
Expand Down
18 changes: 9 additions & 9 deletions exporter/exporterhelper/internal/metadata/generated_telemetry.go

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

22 changes: 22 additions & 0 deletions exporter/exporterhelper/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ telemetry:
metrics:
exporter_sent_spans:
enabled: true
stability:
level: alpha
description: Number of spans successfully sent to destination.
unit: "{spans}"
sum:
Expand All @@ -19,6 +21,8 @@ telemetry:

exporter_send_failed_spans:
enabled: true
stability:
level: alpha
description: Number of spans in failed attempts to send to destination.
unit: "{spans}"
sum:
Expand All @@ -27,6 +31,8 @@ telemetry:

exporter_enqueue_failed_spans:
enabled: true
stability:
level: alpha
description: Number of spans failed to be added to the sending queue.
unit: "{spans}"
sum:
Expand All @@ -35,6 +41,8 @@ telemetry:

exporter_sent_metric_points:
enabled: true
stability:
level: alpha
description: Number of metric points successfully sent to destination.
unit: "{datapoints}"
sum:
Expand All @@ -43,6 +51,8 @@ telemetry:

exporter_send_failed_metric_points:
enabled: true
stability:
level: alpha
description: Number of metric points in failed attempts to send to destination.
unit: "{datapoints}"
sum:
Expand All @@ -51,6 +61,8 @@ telemetry:

exporter_enqueue_failed_metric_points:
enabled: true
stability:
level: alpha
description: Number of metric points failed to be added to the sending queue.
unit: "{datapoints}"
sum:
Expand All @@ -59,6 +71,8 @@ telemetry:

exporter_sent_log_records:
enabled: true
stability:
level: alpha
description: Number of log record successfully sent to destination.
unit: "{records}"
sum:
Expand All @@ -67,6 +81,8 @@ telemetry:

exporter_send_failed_log_records:
enabled: true
stability:
level: alpha
description: Number of log records in failed attempts to send to destination.
unit: "{records}"
sum:
Expand All @@ -75,6 +91,8 @@ telemetry:

exporter_enqueue_failed_log_records:
enabled: true
stability:
level: alpha
description: Number of log records failed to be added to the sending queue.
unit: "{records}"
sum:
Expand All @@ -83,6 +101,8 @@ telemetry:

exporter_queue_size:
enabled: true
stability:
level: alpha
description: Current size of the retry queue (in batches)
unit: "{batches}"
optional: true
Expand All @@ -92,6 +112,8 @@ telemetry:

exporter_queue_capacity:
enabled: true
stability:
level: alpha
description: Fixed capacity of the retry queue (in batches)
unit: "{batches}"
optional: true
Expand Down
12 changes: 6 additions & 6 deletions receiver/receiverhelper/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,47 +8,47 @@ The following telemetry is emitted by this component.

### otelcol_receiver_accepted_log_records

Number of log records successfully pushed into the pipeline.
Number of log records successfully pushed into the pipeline. [alpha]

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

### otelcol_receiver_accepted_metric_points

Number of metric points successfully pushed into the pipeline.
Number of metric points successfully pushed into the pipeline. [alpha]

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

### otelcol_receiver_accepted_spans

Number of spans successfully pushed into the pipeline.
Number of spans successfully pushed into the pipeline. [alpha]

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

### otelcol_receiver_refused_log_records

Number of log records that could not be pushed into the pipeline.
Number of log records that could not be pushed into the pipeline. [alpha]

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

### otelcol_receiver_refused_metric_points

Number of metric points that could not be pushed into the pipeline.
Number of metric points that could not be pushed into the pipeline. [alpha]

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

### otelcol_receiver_refused_spans

Number of spans that could not be pushed into the pipeline.
Number of spans that could not be pushed into the pipeline. [alpha]

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
Expand Down
12 changes: 6 additions & 6 deletions receiver/receiverhelper/internal/metadata/generated_telemetry.go

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

Loading

0 comments on commit f74890a

Please sign in to comment.