OpenMetricsを使用したサービスモニタリングのセットアップ
注記
この機能は現在ベータ版であり、フォーマットは変更される可能性があります。
このトピックでは、MegaportのAPIでPrometheus / OpenMetricsエンドポイントをセットアップするための例としての設定を説明します。
OpenMetricsは、主にPrometheusの公開フォーマットに影響を受けた、標準化されたフォーマットでメトリクスデータを表現し交換するための仕様です。
MegaportのAPIにOpenMetricsエンドポイントが統合されることで、既存のサービスモニタリング情報を公開できます。
以下のPrometheus設定例では、スクレイピング間隔が1分に設定されていますが、ネットワークは5分ごとにポーリングされます。これをPromQL/Grafanaダッシュボードで考慮する必要があります。
始める前に、有効なアクセス・トークンを取得してください。詳細については、APIキーの作成を参照してください。
Megaport APIの詳細
- API: /v1/openmetrics
- 認証: APIキー/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>
Metrics
The endpoint currently exports these metrics for all services.
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