Inconsistent requirements for suffixes

Abierto
#284 5 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
40/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado

Línea de trabajo

Comienza comparando los dos requisitos citados en la especificación de OpenMetrics, incluidos ABNF y los sufijos de formato de texto indicados. Determina si _created y los demás sufijos están prohibidos o simplemente desaconsejados y, a continuación, actualiza la redacción pertinente de la especificación para que la regla de nomenclatura permitida no sea ambigua.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

The spec says

The name of a MetricFamily MUST NOT result in a potential clash for sample metric names as per the ABNF with another MetricFamily in the Text Format within a MetricSet. An example would be a gauge called "foo_created" as a counter called "foo" could create a "foo_created" in the text format.

I read this as a counter name MUST NOT end in _created, because this results in a potential clash.

However, the spec also says

Exposers SHOULD avoid names that could be confused with the suffixes that text format sample metric names use.

Suffixes for the respective types are:

  • Counter: '_total', '_created'
  • Summary: '_count', '_sum', '_created', '' (empty)
  • Histogram: '_count', '_sum', '_bucket', '_created'
  • GaugeHistogram: '_gcount', '_gsum', '_bucket'
  • Info: '_info'
  • Gauge: '' (empty)
  • StateSet: '' (empty)
  • Unknown: '' (empty)

Here it says SHOULD NOT.

It would be good to have more clarity whether a suffix like _created is allowed in a metric name or not.

Lenguaje dominante
Go
Estrellas
2.5k
Forks
175
Merge medio
1 d 22 h
PR fusionados (30 d)
1

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de prometheus/OpenMetrics

Todos los issues de prometheus/OpenMetrics

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.