为服务监控设置 OpenMetrics
注意
此功能目前为 Beta 版,格式可能会发生变化。
本文介绍在 Megaport 的 API 中设置 Prometheus / OpenMetrics 端点的示例配置。
OpenMetrics 是一种用于以标准化格式表示和交换指标数据的规范,主要受 Prometheus 暴露格式的影响。
将 OpenMetrics 端点集成到 Megaport 的 API 后,您可以暴露现有的服务监控信息。
在下面的 Prometheus 配置示例中,抓取间隔设置为 1 分钟,但网络仅每 5 分钟轮询一次。您需要在 PromQL/Grafana 仪表盘中考虑这一点。
开始之前,请获取有效的访问令牌。有关更多信息,请参见 创建 API 密钥。
Megaport API 详细信息
- API (接口): /v1/openmetrics
- Authentication (身份验证): API key/OAuth2
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>
指标
该端点目前为所有服务导出以下指标。
Port
# HELP megaport_service_input_errors_total 输入错误的总数。
# TYPE megaport_service_input_errors_total counter
# HELP megaport_service_optical_receive_power_dbm 接收光功率(单位:dBm)。
# TYPE megaport_service_optical_receive_power_dbm gauge
# HELP megaport_service_optical_transmit_power_dbm 发射光功率(单位:dBm)。
# TYPE megaport_service_optical_transmit_power_dbm gauge
# HELP megaport_service_output_errors_total 输出错误的总数。
# TYPE megaport_service_output_errors_total counter
# HELP megaport_service_receive_bytes_total 接收的总字节数。
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total 接收的数据包总数。
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total 发送的总字节数。
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total 发送的数据包总数。
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up 服务的运行状态。
# TYPE megaport_service_up gauge
VXC
# HELP megaport_service_receive_bytes_total 接收的总字节数。
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total 接收的数据包总数。
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total 发送的总字节数。
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total 发送的数据包总数。
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up 服务的运行状态。
# TYPE megaport_service_up gauge
MCR
# HELP megaport_service_receive_bytes_total 接收的总字节数。
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total 接收的数据包总数。
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total 发送的总字节数。
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total 发送的数据包总数。
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up 服务的运行状态。
# TYPE megaport_service_up gauge
MVE
# HELP megaport_service_receive_bytes_total 接收的总字节数。
# TYPE megaport_service_receive_bytes_total counter
# HELP megaport_service_receive_packets_total 接收的数据包总数。
# TYPE megaport_service_receive_packets_total counter
# HELP megaport_service_transmit_bytes_total 发送的总字节数。
# TYPE megaport_service_transmit_bytes_total counter
# HELP megaport_service_transmit_packets_total 发送的数据包总数。
# TYPE megaport_service_transmit_packets_total counter
# HELP megaport_service_up 服务的运行状态。
# TYPE megaport_service_up gauge