Configuration d’OpenMetrics pour la Surveillance des Services
Remarque
Cette fonctionnalité est actuellement en version Beta et le format est sujet à modification.
Ce sujet décrit un exemple de configuration pour configurer le point de terminaison Prometheus / OpenMetrics dans l’API de Megaport.
OpenMetrics est une spécification pour représenter et échanger des données de métriques dans un format standardisé, principalement influencé par le format d’exposition Prometheus.
Avec le point de terminaison OpenMetrics intégré dans l’API de Megaport, cela vous permet d’exposer les informations de surveillance des services existants.
Dans l’exemple de configuration Prometheus ci-dessous, l’intervalle de scrape est défini sur une minute, mais le réseau est seulement interrogé toutes les cinq minutes. Vous devrez prendre cela en compte dans votre dashboarding PromQL/Grafana.
Avant de commencer, obtenez un jeton d’accès valide. Pour plus d’informations, voir Création d’une clé API.
Détails de l’API de Megaport
- API: /v1/openmetrics
- Authentification: Clé API/OAuth2
Exemple de Configuration 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: <clé api>
client_secret: <secret api>
Metrics
The endpoint currently exports these metrics for all services.
Port
# HELP megaport_service_input_errors_total Le nombre total d'erreurs d'entrée.
# TYPE megaport_service_input_errors_total counter
# HELP megaport_service_optical_receive_power_dbm Niveau de puissance optique reçue en dBm.
# TYPE megaport_service_optical_receive_power_dbm gauge
# HELP megaport_service_optical_transmit_power_dbm Niveau de puissance optique transmise en dBm.
# TYPE megaport_service_optical_transmit_power_dbm gauge
# HELP megaport_service_output_errors_total Le nombre total d'erreurs de sortie.
# TYPE megaport_service_output_errors_total counter
# HELP megaport_service_receive_bytes_total Le nombre total d'octets reçus.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total Le nombre total de paquets reçus.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total Le nombre total d'octets transmis.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total Le nombre total de paquets transmis.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Statut opérationnel du service.
# TYPE megaport_service_up gauge
VXC
# HELP megaport_service_receive_bytes_total Le nombre total d'octets reçus.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total Le nombre total de paquets reçus.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total Le nombre total d'octets transmis.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total Le nombre total de paquets transmis.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Statut opérationnel du service.
# TYPE megaport_service_up gauge
MCR
# HELP megaport_service_receive_bytes_total Le nombre total d'octets reçus.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total Le nombre total de paquets reçus.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total Le nombre total d'octets transmis.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total Le nombre total de paquets transmis.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Statut opérationnel du service.
# TYPE megaport_service_up gauge
MVE
# HELP megaport_service_receive_bytes_total Le nombre total d'octets reçus.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total Le nombre total de paquets reçus.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total Le nombre total d'octets transmis.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total Le nombre total de paquets transmis.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Statut opérationnel du service.
# TYPE megaport_service_up gauge