feat: add diag warning when metric name is invalid #2122
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If you are using the metric kind `counter` Prometheus expects the metric name to have the suffix `_total` as it will throw the following error: ``` failed_requests counter metrics should have "_total" suffix ``` This commit logs a warning message when the diag log level is DEBUG to assist implementors
weyert
requested review from
dyladan,
Flarna,
johnbley,
legendecas,
markwolff,
mayurkale22,
mwear,
naseemkullah,
obecny,
OlivierAlbertini and
vmarchaud
as code owners
naseemkullah
approved these changes
Apr 19, 2021
packages/opentelemetry-exporter-prometheus/src/PrometheusSerializer.ts
Outdated
Show resolved
Hide resolved
Codecov Report
@@ Coverage Diff @@
## main #2122 +/- ##
=======================================
Coverage 92.75% 92.76%
=======================================
Files 140 140
Lines 4981 4987 +6
Branches 1028 1029 +1
=======================================
+ Hits 4620 4626 +6
Misses 361 361
|
|
Added unit test :) |
dyladan
reviewed
Apr 19, 2021
packages/opentelemetry-exporter-prometheus/src/PrometheusSerializer.ts
Outdated
Show resolved
Hide resolved
naseemkullah
approved these changes
Apr 21, 2021
|
@naseemkullah I have moved it into its own function for now. |
obecny
approved these changes
Apr 21, 2021
packages/opentelemetry-exporter-prometheus/src/PrometheusSerializer.ts
Outdated
Show resolved
Hide resolved
updated it :) |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
If you are using the metric kind
counterPrometheus expects themetric name to have the suffix
_totalas it will throw the followingerror:
This commit logs a warning message when the diag log level is DEBUG to
assist implementors
Short description of the changes
Adds a log warning when an invalid metric name is given