Skip to content

Commit

Permalink
fix comments for unit support
Browse files Browse the repository at this point in the history
Signed-off-by: Arianna Vespri <arianna.vespri@yahoo.it>
  • Loading branch information
vesari committed Dec 2, 2023
1 parent 88a6d8b commit 56657f4
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions expfmt/openmetrics_create.go
Expand Up @@ -47,12 +47,15 @@ import (
// Prometheus to OpenMetrics or vice versa:
//
// - Counters are expected to have the `_total` suffix in their metric name. In
// the output, the suffix will be truncated from the `# TYPE` and `# HELP`
// line. A counter with a missing `_total` suffix is not an error. However,
// the output, the suffix will be truncated from the `# TYPE`, `# HELP` and `# UNIT`
// lines. A counter with a missing `_total` suffix is not an error. However,
// its type will be set to `unknown` in that case to avoid invalid OpenMetrics
// output.
//
// - No support for the following (optional) features: `# UNIT` line, `_created`
// - The `# UNIT` line is optional, but if populated, the unit has to be present in the metric
// name as its suffix (see https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#unit)
//
// - No support for the following (optional) features: `_created`
// line, info type, stateset type, gaugehistogram type.
//
// - The size of exemplar labels is not checked (i.e. it's possible to create
Expand Down

0 comments on commit 56657f4

Please sign in to comment.