Skip to content

Commit 68fb07b

Browse files
crobert-1codeboten
andauthored
[exporterhelper] Update metric units (#10655)
#### Description Updated the metric units for metrics in the `exporterhelper`. As described in the issue, `1` isn't an informative unit to use, so this should hopefully clarify metrics for users. #### Link to tracking issue Fixes #10648 --------- Co-authored-by: Alex Boten <[email protected]>
1 parent efc630a commit 68fb07b

File tree

4 files changed

+58
-33
lines changed

4 files changed

+58
-33
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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: bug_fix
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
7+
component: exporterhelper
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Update units for internal telemetry
11+
12+
# One or more tracking issues or pull requests related to the change
13+
issues: [10648]
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+
20+
# Optional: The change log or logs in which this entry should be included.
21+
# e.g. '[user]' or '[user, api]'
22+
# Include 'user' if the change is relevant to end users.
23+
# Include 'api' if there is a change to a library API.
24+
# Default: '[user]'
25+
change_logs: []

exporter/exporterhelper/documentation.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,84 +12,84 @@ Number of log records failed to be added to the sending queue.
1212

1313
| Unit | Metric Type | Value Type | Monotonic |
1414
| ---- | ----------- | ---------- | --------- |
15-
| 1 | Sum | Int | true |
15+
| {records} | Sum | Int | true |
1616

1717
### otelcol_exporter_enqueue_failed_metric_points
1818

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

2121
| Unit | Metric Type | Value Type | Monotonic |
2222
| ---- | ----------- | ---------- | --------- |
23-
| 1 | Sum | Int | true |
23+
| {datapoints} | Sum | Int | true |
2424

2525
### otelcol_exporter_enqueue_failed_spans
2626

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

2929
| Unit | Metric Type | Value Type | Monotonic |
3030
| ---- | ----------- | ---------- | --------- |
31-
| 1 | Sum | Int | true |
31+
| {spans} | Sum | Int | true |
3232

3333
### otelcol_exporter_queue_capacity
3434

3535
Fixed capacity of the retry queue (in batches)
3636

3737
| Unit | Metric Type | Value Type |
3838
| ---- | ----------- | ---------- |
39-
| 1 | Gauge | Int |
39+
| {batches} | Gauge | Int |
4040

4141
### otelcol_exporter_queue_size
4242

4343
Current size of the retry queue (in batches)
4444

4545
| Unit | Metric Type | Value Type |
4646
| ---- | ----------- | ---------- |
47-
| 1 | Gauge | Int |
47+
| {batches} | Gauge | Int |
4848

4949
### otelcol_exporter_send_failed_log_records
5050

5151
Number of log records in failed attempts to send to destination.
5252

5353
| Unit | Metric Type | Value Type | Monotonic |
5454
| ---- | ----------- | ---------- | --------- |
55-
| 1 | Sum | Int | true |
55+
| {records} | Sum | Int | true |
5656

5757
### otelcol_exporter_send_failed_metric_points
5858

5959
Number of metric points in failed attempts to send to destination.
6060

6161
| Unit | Metric Type | Value Type | Monotonic |
6262
| ---- | ----------- | ---------- | --------- |
63-
| 1 | Sum | Int | true |
63+
| {datapoints} | Sum | Int | true |
6464

6565
### otelcol_exporter_send_failed_spans
6666

6767
Number of spans in failed attempts to send to destination.
6868

6969
| Unit | Metric Type | Value Type | Monotonic |
7070
| ---- | ----------- | ---------- | --------- |
71-
| 1 | Sum | Int | true |
71+
| {spans} | Sum | Int | true |
7272

7373
### otelcol_exporter_sent_log_records
7474

7575
Number of log record successfully sent to destination.
7676

7777
| Unit | Metric Type | Value Type | Monotonic |
7878
| ---- | ----------- | ---------- | --------- |
79-
| 1 | Sum | Int | true |
79+
| {records} | Sum | Int | true |
8080

8181
### otelcol_exporter_sent_metric_points
8282

8383
Number of metric points successfully sent to destination.
8484

8585
| Unit | Metric Type | Value Type | Monotonic |
8686
| ---- | ----------- | ---------- | --------- |
87-
| 1 | Sum | Int | true |
87+
| {datapoints} | Sum | Int | true |
8888

8989
### otelcol_exporter_sent_spans
9090

9191
Number of spans successfully sent to destination.
9292

9393
| Unit | Metric Type | Value Type | Monotonic |
9494
| ---- | ----------- | ---------- | --------- |
95-
| 1 | Sum | Int | true |
95+
| {spans} | Sum | Int | true |

exporter/exporterhelper/internal/metadata/generated_telemetry.go

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

exporter/exporterhelper/metadata.yaml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,79 +12,79 @@ telemetry:
1212
exporter_sent_spans:
1313
enabled: true
1414
description: Number of spans successfully sent to destination.
15-
unit: "1"
15+
unit: "{spans}"
1616
sum:
1717
value_type: int
1818
monotonic: true
1919

2020
exporter_send_failed_spans:
2121
enabled: true
2222
description: Number of spans in failed attempts to send to destination.
23-
unit: "1"
23+
unit: "{spans}"
2424
sum:
2525
value_type: int
2626
monotonic: true
2727

2828
exporter_enqueue_failed_spans:
2929
enabled: true
3030
description: Number of spans failed to be added to the sending queue.
31-
unit: "1"
31+
unit: "{spans}"
3232
sum:
3333
value_type: int
3434
monotonic: true
3535

3636
exporter_sent_metric_points:
3737
enabled: true
3838
description: Number of metric points successfully sent to destination.
39-
unit: "1"
39+
unit: "{datapoints}"
4040
sum:
4141
value_type: int
4242
monotonic: true
4343

4444
exporter_send_failed_metric_points:
4545
enabled: true
4646
description: Number of metric points in failed attempts to send to destination.
47-
unit: "1"
47+
unit: "{datapoints}"
4848
sum:
4949
value_type: int
5050
monotonic: true
5151

5252
exporter_enqueue_failed_metric_points:
5353
enabled: true
5454
description: Number of metric points failed to be added to the sending queue.
55-
unit: "1"
55+
unit: "{datapoints}"
5656
sum:
5757
value_type: int
5858
monotonic: true
5959

6060
exporter_sent_log_records:
6161
enabled: true
6262
description: Number of log record successfully sent to destination.
63-
unit: "1"
63+
unit: "{records}"
6464
sum:
6565
value_type: int
6666
monotonic: true
6767

6868
exporter_send_failed_log_records:
6969
enabled: true
7070
description: Number of log records in failed attempts to send to destination.
71-
unit: "1"
71+
unit: "{records}"
7272
sum:
7373
value_type: int
7474
monotonic: true
7575

7676
exporter_enqueue_failed_log_records:
7777
enabled: true
7878
description: Number of log records failed to be added to the sending queue.
79-
unit: "1"
79+
unit: "{records}"
8080
sum:
8181
value_type: int
8282
monotonic: true
8383

8484
exporter_queue_size:
8585
enabled: true
8686
description: Current size of the retry queue (in batches)
87-
unit: "1"
87+
unit: "{batches}"
8888
optional: true
8989
gauge:
9090
value_type: int
@@ -93,7 +93,7 @@ telemetry:
9393
exporter_queue_capacity:
9494
enabled: true
9595
description: Fixed capacity of the retry queue (in batches)
96-
unit: "1"
96+
unit: "{batches}"
9797
optional: true
9898
gauge:
9999
value_type: int

0 commit comments

Comments
 (0)