Extend OpenMetrics by a stability data type
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
Línea de trabajo
Comienza leyendo la especificación de OpenMetrics y el issue #189 relacionado de OpenObservability, ya que aquí no se nombran archivos de implementación ni pruebas. El trabajo estará terminado cuando los campos del ciclo de vida, la sintaxis, la semántica y las implicaciones de compatibilidad se hayan acordado e incorporado a la especificación.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
In order to improve metrics experience, I would like to propose two fields to be added to the spec.
Stability
Stability is a string that is used to describe the maturity of the MetricFamily. If it is unset, the MetricFamily is considered stable
Recommended values for lifecycle:
* Alpha for metrics that might be renamed or are unstable in terms of other features (e.g. units or dimensions).
* Beta for metrics that will be considered stable soon.
* Stable This is the default and what consumers can assume if the Stability string is not set.
* Deprecated for metrics that should not be used anymore.
StabilityHint
StabilityHint is string that is used to provide a human-readable hint for the MetricFamily. This can include e.g. a replacement for the MetricFamily.
As an example:
# TYPE process_cpu_microseconds_total counter
# UNIT process_cpu_microseconds_total seconds
# HELP process_cpu_microseconds_total Total user and system CPU time spent in seconds.
# STABILITY process_cpu_microseconds_total Deprecated
# STABILITYHINT process_cpu_microseconds_total This metric going to be replaced by process_cpu_seconds_total.
process_cpu_microseconds_total 4.20072246e+06
This could allow consumers to warn when an unstable metric is used and improve metrics lifecycle. We currently see issues where e.g. grafana dashboards use a deprecated metric and users only figure out when the metric is gone on the consumer side.
This is similar to https://github.com/OpenObservability/OpenMetrics/issues/189 but with a clearer focus on lifecycle.
- 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
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de prometheus/OpenMetrics
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
prometheus/OpenMetrics#323 ·
-
OM 2.0
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
prometheus/OpenMetrics#312 · 13 comentarios ·
-
OM 2.0
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
prometheus/OpenMetrics#310 · 4 comentarios · 1 reacción ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
prometheus/OpenMetrics#304 · 1 comentario ·
-
RFC next stepsAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
prometheus/OpenMetrics#301 ·
Todos los issues de prometheus/OpenMetrics
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
txn2/mcp-data-platform#2728 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
blinklabs-io/dingo#6504 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
SocialGouv/iterion#3413 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
orion-belt-dev/orion-belt#181 ·
Los mantenedores suelen responder en 1 día
-
documentation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 79/100
kubesmarts/logic-operator#105 ·
Los mantenedores suelen responder en 1 día