APIの監視ダッシュボードを設定

APIウィンドウのアクティビティタイルが最新の10件のリクエストステータスに制限されています。ただし、データセットのAPIが有効になっている場合には、メトリクスが収集され、任意の監視ダッシュボードによって消費できます。

利用できるメトリクスの詳細は、APIに利用できるメトリクスをご覧ください。

手順

Remote Engine Gen2ディレクトリーのdefault/nginx/nginx.confファイルに次の設定を追加し、メトリクスエンドポイントを表示させます。

location /metrics {
      proxy_pass http://dataset-api-server/api/v1/metrics;
    }

この設定はファイルのlocation /apisエレメントの下に追加できます。例:

events { }
http {
  server {
    listen 9102;

    location /apis {
      proxy_pass http://dataset-api-server/apis;
    }

    location /metrics {
      proxy_pass http://dataset-api-server/api/v1/metrics;
    }

  }
}

Remote Engine Gen2インスタンスを再起動して新しい設定を適用させます。

任意の監視システムで、正しいパラメーターで次のURLを使って、Remote Engine Gen2で実行中のAPIに関するメトリクスを取得します:

protocol://remote_engine_host:DATASET_API_SHARING_EXTERNAL_PORT/metrics

URLを構成するさまざまなパラメーター
パラメーター	値
protocol	デフォルトではhttpで、設定されている場合はhttps。
remote_engine_host	Remote Engine Gen2がインストール済みであるホスト。これはインフラストラクチャー固有のものです。ホストがわからない場合は、管理者にご連絡ください。
DATASET_API_SHARING_EXTERNAL_PORT	Remote Engine Gen2ディレクトリー内にあるdefault/.envファイルでのDATASET_API_SHARING_EXTERNAL_PORTパラメーターの値。

必要に応じて、監視システムを設定します。
例
Prometheusでは、次の設定を使えます。詳細は、Prometheusドキュメンテーションをご覧ください。
```
 - job_name: 'dataset_api_sharing'
   scrape_interval: 10s
   metrics_path: /metrics
   static_configs:
    - targets: [ 'localhost:8080' ]
```

タスクの結果

Prometheusのデータ(メモリ使用量、APIごとのリクエスト数、平均待ち時間など)をクエリーするGrafanaダッシュボードの例です。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。

こちらにフィードバックをお寄せください

APIの監視ダッシュボードを設定

手順

例

タスクの結果

このセクション内

このページは役に立ちましたか?