Einrichten von OpenMetrics für die Serviceüberwachung
Hinweis
Diese Funktion befindet sich derzeit in der Beta-Phase, und das Format kann sich ändern.
Dieses Thema beschreibt eine Beispielkonfiguration zum Einrichten des Prometheus- / OpenMetrics-Endpunkts in der API von Megaport.
OpenMetrics ist eine Spezifikation zur Darstellung und zum Austausch von Metrikdaten in einem standardisierten Format, das hauptsächlich vom Prometheus-Expositionsformat beeinflusst ist.
Mit dem in die API von Megaport integrierten OpenMetrics-Endpunkt können Sie vorhandene Informationen zur Serviceüberwachung bereitstellen.
Im untenstehenden Prometheus-Konfigurationsbeispiel ist das Scrape-Intervall auf eine Minute festgelegt, das Netzwerk wird jedoch nur alle fünf Minuten abgefragt. Dies müssen Sie in Ihrem PromQL/Grafana-Dashboarding berücksichtigen.
Bevor Sie beginnen, besorgen Sie sich ein gültiges Access Token. Weitere Informationen finden Sie unter Erstellen eines API-Schlüssels.
Megaport API-Details
- API: /v1/openmetrics
- Authentifizierung: API-Schlüssel/OAuth2
Beispielkonfiguration für 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
Der Endpunkt exportiert derzeit diese Metriken für alle Dienste.
Port
# HELP megaport_service_input_errors_total The total number of input errors.
# TYPE megaport_service_input_errors_total counter
# HELP megaport_service_optical_receive_power_dbm Optical receive power level in dBm.
# TYPE megapport_service_optical_receive_power_dbm gauge
# HELP megaport_service_optical_transmit_power_dbm Optical transmit power level in dBm.
# TYPE megaport_service_optical_transmit_power_dbm gauge
# HELP megaport_service_output_errors_total The total number of output errors.
# TYPE megaport_service_output_errors_total counter
# HELP megaport_service_receive_bytes_total The total number of bytes received.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total The total number of packets received.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total The total number of bytes transmitted.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total The total number of packets transmitted.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Operational status of the service.
# TYPE megaport_service_up gauge
VXC
# HELP megaport_service_receive_bytes_total The total number of bytes received.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total The total number of packets received.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total The total number of bytes transmitted.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total The total number of packets transmitted.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Operational status of the service.
# TYPE megaport_service_up gauge
MCR
# HELP megaport_service_receive_bytes_total The total number of bytes received.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total The total number of packets received.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total The total number of bytes transmitted.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total The total number of packets transmitted.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Operational status of the service.
# TYPE megaport_service_up gauge
MVE
# HELP megaport_service_receive_bytes_total The total number of bytes received.
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total The total number of packets received.
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total The total number of bytes transmitted.
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total The total number of packets transmitted.
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up Operational status of the service.
# TYPE megaport_service_up gauge