Skip to content

Commit

Permalink
[receiverhelper] Update metric units (#10657)
Browse files Browse the repository at this point in the history
#### Description
`1` isn't an informative unit for metrics, this should clarify their
units.

#### Link to tracking issue
Fixes
#10650
  • Loading branch information
crobert-1 authored Jul 22, 2024
1 parent d628b96 commit a09ec93
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 18 deletions.
25 changes: 25 additions & 0 deletions .chloggen/receiverhelper_metric_units.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: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: receiverhelper

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Update units for internal telemetry

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

# (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: []
12 changes: 6 additions & 6 deletions receiver/receiverhelper/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,44 +12,44 @@ Number of log records successfully pushed into the pipeline.

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

### otelcol_receiver_accepted_metric_points

Number of metric points successfully pushed into the pipeline.

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

### otelcol_receiver_accepted_spans

Number of spans successfully pushed into the pipeline.

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

### otelcol_receiver_refused_log_records

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

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

### otelcol_receiver_refused_metric_points

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

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

### otelcol_receiver_refused_spans

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

| Unit | Metric Type | Value Type | Monotonic |
| ---- | ----------- | ---------- | --------- |
| 1 | Sum | Int | true |
| {spans} | Sum | Int | true |
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.

12 changes: 6 additions & 6 deletions receiver/receiverhelper/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,47 +12,47 @@ telemetry:
receiver_accepted_spans:
enabled: true
description: Number of spans successfully pushed into the pipeline.
unit: "1"
unit: "{spans}"
sum:
value_type: int
monotonic: true

receiver_refused_spans:
enabled: true
description: Number of spans that could not be pushed into the pipeline.
unit: "1"
unit: "{spans}"
sum:
value_type: int
monotonic: true

receiver_accepted_metric_points:
enabled: true
description: Number of metric points successfully pushed into the pipeline.
unit: "1"
unit: "{datapoints}"
sum:
value_type: int
monotonic: true

receiver_refused_metric_points:
enabled: true
description: Number of metric points that could not be pushed into the pipeline.
unit: "1"
unit: "{datapoints}"
sum:
value_type: int
monotonic: true

receiver_accepted_log_records:
enabled: true
description: Number of log records successfully pushed into the pipeline.
unit: "1"
unit: "{records}"
sum:
value_type: int
monotonic: true

receiver_refused_log_records:
enabled: true
description: Number of log records that could not be pushed into the pipeline.
unit: "1"
unit: "{records}"
sum:
value_type: int
monotonic: true

0 comments on commit a09ec93

Please sign in to comment.