action.skip

Configuración de OpenMetrics para la supervisión de servicios

Nota

Esta función se encuentra actualmente en Beta y el formato está sujeto a cambios.

Este tema describe una configuración de ejemplo para configurar el endpoint de Prometheus / OpenMetrics en la API de Megaport.

OpenMetrics es una especificación para representar e intercambiar datos de métricas en un formato estandarizado, influenciada principalmente por el formato de exposición de Prometheus.

Con el endpoint de OpenMetrics integrado en la API de Megaport, podrá exponer la información de supervisión de servicios existente.

En el ejemplo de configuración de Prometheus que se muestra a continuación, el scrape interval está establecido en un minuto, pero la red solo se consulta cada cinco minutos. Deberá tener esto en cuenta en sus paneles de PromQL/Grafana.

Antes de comenzar, obtenga un token de acceso válido. Para obtener más información, consulte Creación de una clave de API.

Megaport detalles de la API

  • API (API): /v1/openmetrics
  • Authentication (Autenticación): API key/OAuth2

Ejemplo de configuración de Prometheus

global:
  scrape_interval: 5m

scrape_configs:
  - job_name: megaport
    static_configs:
      - targets: ["api.megaport.com"]
    scheme: https
    metrics_path: /v1/openmetrics
    oauth2:
      token_url: https://auth-m2m.megaport.com/oauth2/token
      client_id: <api key>
      client_secret: <api secret>

Metrics

El endpoint actualmente exporta estas métricas para todos los servicios.

Port

# HELP megaport_service_input_errors_total El número total de errores de entrada.
# TYPE megaport_service_input_errors_total counter
# HELP megaport_service_optical_receive_power_dbm Nivel de potencia óptica recibida en dBm.
# TYPE megaport_service_optical_receive_power_dbm gauge
# HELP megaport_service_optical_transmit_power_dbm Nivel de potencia óptica transmitida en dBm.
# TYPE megaport_service_optical_transmit_power_dbm gauge
# HELP megaport_service_output_errors_total El número total de errores de salida.
# TYPE megaport_service_output_errors_total counter
# HELP megaport_service_receive_bytes_total El número total de bytes recibidos.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total El número total de paquetes recibidos.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total El número total de bytes transmitidos.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total El número total de paquetes transmitidos.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Estado operativo del servicio.
# TYPE megaport_service_up gauge

VXC

# HELP megaport_service_receive_bytes_total El número total de bytes recibidos.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total El número total de paquetes recibidos.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total El número total de bytes transmitidos.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total El número total de paquetes transmitidos.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Estado operativo del servicio.
# TYPE megaport_service_up gauge

MCR

# HELP megaport_service_receive_bytes_total El número total de bytes recibidos.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total El número total de paquetes recibidos.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total El número total de bytes transmitidos.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total El número total de paquetes transmitidos.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Estado operativo del servicio.
# TYPE megaport_service_up gauge

MVE

# HELP megaport_service_receive_bytes_total El número total de bytes recibidos.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total El número total de paquetes recibidos.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total El número total de bytes transmitidos.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total El número total de paquetes transmitidos.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Estado operativo del servicio.
# TYPE megaport_service_up gauge

Referencias útiles