Saltar a contenido

Metrics

Descripción

Este endpoint muestra un conjunto de métricas de NetinDS-Zavod.

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>:<Zavod_port>/v1/metrics.

Visualización

Al realizarse una petición GET al endpoint nos devuelve 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 7746.870344

# 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 1098.508695

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

# 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 1656588942

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

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

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

# HELP process_open_fds Number of open file descriptors.
# TYPE process_open_fds gauge
process_open_fds 38

# HELP process_max_fds Maximum number of open file descriptors.
# TYPE process_max_fds gauge
process_max_fds 1048576

# HELP nodejs_eventloop_lag_seconds Lag of event loop in seconds.
# TYPE nodejs_eventloop_lag_seconds gauge
nodejs_eventloop_lag_seconds 0

...

Listado de campos

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 NetinDS-Zavod.

  • api_all_map_publishing_job_total: indica el total de peticiones de publicación de maps procesadas de NetinDS-Zavod.

  • api_all_table_publishing_job_total: indica el total de peticiones de publicación de tables procesadas de NetinDS-Zavod.

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

  • api_all_datapoints_publishing_job_total: indica el total de datapoints publicados.

  • api_all_datapoints_total: indica el total de datapoint manejados por NetinDS-Zavod.

  • api_all_publishing_job_in_processing_total: indica el total de trabajos de publicación de NetinDS-Zavod 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.

  • api_publishing_job_duration_milliseconds_bucket (le, origin, datapointSet): para cada tripleta de le, origin y datapointSet configurados, tiene un contador que indica el tiempo de duración de las publicaciones de datos, en milisegundos.

  • api_publishing_job_duration_milliseconds_sum (origin, datapointSet): para cada par de origin y datapointSet configurados, indica la suma del tiempo de duración de las publicaciones de datos, en milisegundos.

  • api_publishing_job_duration_milliseconds_count (origin, datapointSet): para cada par de origin y datapointSet, indica el conteo del tiempo de duración de las publicaciones de datos, en milisegundos.

  • api_all_alarms_notified_total: indica el total de alarmas notificadas.

  • api_all_errors_alarms_notifying_total: indica el total de errores en el proceso de notificación de alarmas.

  • api_all_alarms_total: indica el total de alarmas manejadas por NetinDS-Zavod.

  • api_all_timepoints_notified_total: indica el total de timepoints notificados.

  • api_all_errors_timepoints_notifying_total: indica el total de errores durante el proceso de notificación de timepoints.

  • api_all_timepoints_total: indica el total de timepoints manejados por NetinDS-Zavod.