prometheus / prometheus/client_python

Metrics without labels missing breaks some codepath

Abierto
#949 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Python
Estrellas
4.4k
Forks
876
Merge medio
8 d 4 h
PR fusionados (30 d)
1

Descripción

When initialized without labels, it seems that the resulting metrics objects will lack some instance variables.

Minimal example:

from prometheus_client import Gauge, generate_latest

cc = Gauge("dummy_count", "POC")

if __name__ == '__main__':
    cc.set(42)
    print(generate_latest().decode())  # OK

    cc.clear()    # raises

"""
Traceback (most recent call last):
  File "prom_example.py", line 10, in <module>
    cc.clear()    # raises
    ^^^^^^^^^^
  File …/site-packages/prometheus_client/metrics.py", line 213, in clear
    with self._lock:
         ^^^^^^^^^^
AttributeError: 'Gauge' object has no attribute '_lock'
"""

The same code with declared labels will properly clear the metrics data

I came up upon this when adding a new metric and forgetting to add the labels.

(I'm using .clear() to reset the metrics during tests)

Guía de contribución

Abrir la guía de contribución

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.

Línea de trabajo

Reproduce el ejemplo mínimo del issue y, después, inspecciona el método clear en metrics.py, línea 213, y la ruta de inicialización de un Gauge sin etiquetas. Confirma que llamar a clear() en una métrica sin etiquetas declaradas ya no provoca el AttributeError indicado y que el caso con etiquetas sigue funcionando.

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

Evaluación

Stack tecnológico
python
Área
observability
Tipo de issue
Error
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.