Configurando OpenMetrics para Monitoramento de Serviços
Nota
Este recurso está atualmente em Beta e o formato está sujeito a alterações.
Este tópico descreve uma configuração de exemplo para configurar o endpoint Prometheus / OpenMetrics na API da Megaport.
OpenMetrics é uma especificação para representar e trocar dados de métricas em um formato padronizado, influenciado principalmente pelo formato de exposição do Prometheus.
Com o endpoint OpenMetrics integrado à API da Megaport, você pode expor as informações existentes de monitoramento de serviços.
No exemplo de configuração do Prometheus abaixo, o intervalo de coleta (scrape interval) está definido para um minuto, mas a rede é consultada apenas a cada cinco minutos. Você precisará considerar isso nos seus dashboards PromQL/Grafana.
Antes de começar, obtenha um access token válido. Para mais informações, consulte Criando uma API Key.
Detalhes da API da Megaport
- API: /v1/openmetrics
- Autenticação: API key/OAuth2
Exemplo de Configuração do 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>
Métricas
O endpoint atualmente exporta estas métricas para todos os serviços.
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 megaport_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