Skip to content

Commit

Permalink
[scraperhelper] Update metric units (open-telemetry#10656)
Browse files Browse the repository at this point in the history
#### Description
`1` isn't an informative unit for metrics, this clarifies the unit.

#### Link to tracking issue
Fixes
open-telemetry#10649
  • Loading branch information
crobert-1 authored Jul 22, 2024
1 parent f085ac4 commit 6315785
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 6 deletions.
25 changes: 25 additions & 0 deletions .chloggen/scraperhelper_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: scraperhelper

# 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: [10649]

# (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: []
4 changes: 2 additions & 2 deletions receiver/scraperhelper/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Number of metric points that were unable to be scraped.

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

### otelcol_scraper_scraped_metric_points

Number of metric points successfully scraped.

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

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

4 changes: 2 additions & 2 deletions receiver/scraperhelper/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ telemetry:
scraper_scraped_metric_points:
enabled: true
description: Number of metric points successfully scraped.
unit: "1"
unit: "{datapoints}"
sum:
value_type: int
monotonic: true

scraper_errored_metric_points:
enabled: true
description: Number of metric points that were unable to be scraped.
unit: "1"
unit: "{datapoints}"
sum:
value_type: int
monotonic: true

0 comments on commit 6315785

Please sign in to comment.