[chore] [pkg/translator/prometheus] Update documentation #23209
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
dmitryax
commented
Jun 6, 2023
Comment on lines
+23
to
+34
| | Case | Transformation | Example | | ||
| |----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| | ||
| | Unsupported characters and extraneous underscores | Replace unsupported characters with underscores (`_`). Drop redundant, leading and trailing underscores. | `(lambda).function.executions(#)` → `lambda_function_executions` | | ||
| | Standard unit | Convert the unit from [Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) to Prometheus standard and append | `system.filesystem.usage` with unit `By` → `system_filesystem_usage_bytes` | | ||
| | Non-standard unit (unit is surrounded with `{}`) | Drop the unit | `system.network.dropped` with unit `{packets}` → `system_network_dropped` | | ||
| | Non-standard unit (unit is **not** surrounded with `{}`) | Append the unit, if not already present, after sanitization (all non-alphanumeric chars are dropped) | `system.network.dropped` with unit `packets` → `system_network_dropped_packets` | | ||
| | Percentages (unit is `1`) | Append `_ratio` (for gauges only) | `system.memory.utilization` with unit `1` → `system_memory_utilization_ratio` | | ||
| | Percentages (unit is `%`) | Replace `%` with `percent` `_percent` | `storage.filesystem.utilization` with unit `%` → `storage_filesystem_utilization_percent` | | ||
| | Rates (unit contains `/`) | Replace `/` with `per` | `astro.light.speed` with unit `m/s` → `astro_light_speed_meters_per_second` | | ||
| | Dollars (unit is `$`) | Replace `$` with `dollars` | `crypto.dogecoin.value` with unit `$` → `crypto_dogecoin_value_dollars` | | ||
| | Counter | Append `_total` | `system.processes.created` → `system_processes_created_total` | | ||
|
|
There was a problem hiding this comment.
This block doesn't have any changes other than replacing ==> with → and fixing crypto.dogecoin.value_dollars with crypto_dogecoin_value_dollars
dmitryax
force-pushed
the
update-normalization-docs
branch
from
4f4edfc to
3a7dec2
Compare
dmitryax
changed the title
dmitryax
changed the title
crobert-1
approved these changes
Jun 7, 2023
dmitryax
force-pushed
the
update-normalization-docs
branch
2 times, most recently
from
5de2393 to
371ea99
Compare
Describe transformations currently applied in the Prometheus receiver in README.md
dmitryax
force-pushed
the
update-normalization-docs
branch
from
371ea99 to
2da3530
Compare
Caleb-Hurshman
pushed a commit
to observIQ/opentelemetry-collector-contrib
that referenced
this pull request
Jul 6, 2023
…try#23209) - Describe transformations currently applied in the Prometheus receiver - Fix `crypto.dogecoin.value_dollars`-> `crypto_dogecoin_value_dollars` typo
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.
crypto.dogecoin.value_dollars->crypto_dogecoin_value_dollarstypoMissing translations reported in #23208