Saltar a contenido

Metrics

Descripción

Este endpoint muestra las métricas de mqtt en formato prometheus.

Se debe consultar este endpoint cuando se desee conocer las distintas métricas que ofrecen información sobre el estado del proceso, de node o de las distintas estadísticas del API.

Estas métricas se corresponden con las definidas en el estándar de prometheus, pero además existen algunas adicionales que se explican a continuación.

Podemos encontrarlo en la ruta <ip>:<mqtt_port>/v1/metrics.

Visualización

Al realizar la petición GET se obtiene la siguiente respuesta:

# HELP process_cpu_user_seconds_total Total user CPU time spent in seconds.
# TYPE process_cpu_user_seconds_total counter
process_cpu_user_seconds_total 16.171011

# HELP process_cpu_system_seconds_total Total system CPU time spent in seconds.
# TYPE process_cpu_system_seconds_total counter
process_cpu_system_seconds_total 3.920032

# HELP process_cpu_seconds_total Total user and system CPU time spent in seconds.
# TYPE process_cpu_seconds_total counter
process_cpu_seconds_total 20.091043

# HELP process_start_time_seconds Start time of the process since unix epoch in seconds.
# TYPE process_start_time_seconds gauge
process_start_time_seconds 1658406103

# HELP process_resident_memory_bytes Resident memory size in bytes.
# TYPE process_resident_memory_bytes gauge
process_resident_memory_bytes 59994112

# HELP process_virtual_memory_bytes Virtual memory size in bytes.
# TYPE process_virtual_memory_bytes gauge
process_virtual_memory_bytes 372219904

# HELP process_heap_bytes Process heap size in bytes.
# TYPE process_heap_bytes gauge
process_heap_bytes 134422528

Aquí podemos encontrar el formato de Prometheus [https://prometheus.io/]

Además de dichas métricas definidas por el estándar de Prometheus, también devolvemos unas métricas adicionales:

  • api_all_publishing_job_total: indica el total de peticiones de publicación procesadas de mqtt.

  • api_all_map_publishing_job_total: indica el total de peticiones de publicación de maps procesadas de mqtt.

  • api_all_table_publishing_job_total: indica el total de peticiones de publicación de tables procesadas de mqtt.

  • api_all_errors_publishing_job_total: indica el total de todas los trabajos de publicación con errores de mqtt.

  • api_all_datapoints_publishing_job_total: indica el total de datapoints publicados.

  • api_all_datapoints_total: indica el total de datapoint manejados por mqtt.

  • api_all_publishing_job_in_processing_total: indica el total de trabajos de publicación de mqtt que están procesándose.

  • api_publishing_job_total (origin, datapointSet): para cada par de origin y datapointSet configurados, indica el total de datos publicados.