管理者は、メトリクス API で PromQL クエリを使用して、未処理のメトリクスに対して直接クエリを実行して取得できます。これらのメトリクスは、クラスターの内外で実行されるサードパーティのビューアーやグラフィカル アプリケーション (Grafana など) で使用できます。
メトリクス API では、Prometheus 監視システムを使用して、各 GIS サービス ポッドからこれらのメトリクスを収集し、時系列データベースに入力されるまでその情報を維持します。 このメトリクス ビューアーは、メトリクス API をデータ ストアとして登録することで、メトリクス API に対してクエリを実行して使用状況指標を取得できます。
メトリクス API は Administrator Directory の usagestatistics API で公開されます。 メトリクス API にアクセスするには、次の手順に従います。
- Administrator Directory の usagestatistics API (https://organization.example.com/<context>/admin/usagestatistics) に移動します。
- [Rest Metrics API] をクリックします。
新しいタブにメトリクス API が開きます。
- Prometheus Web ページにサイン インします。
デフォルトでは、システムで生成される認証情報がサイン インに使用されます。 Prometheus ダッシュボードにサイン インする前に、組織を構成し、認証情報を更新します。 これらの認証情報を更新するには、admin/usagestatistics にある Update Credentials (認証情報の更新) 操作を使用します。 新しいパスワードは 8 文字以上で、次の文字をそれぞれ 1 つ以上含んでいる必要があります。
- A 〜 Z の ASCII 文字 (大文字または小文字)
- 0 〜 9 の数字
- サポートされている特殊文字 (# ! % & , - . / : ; < = > @ _ ` ~ ^ ? \ * + \ | $ および空白文字)
メトリクス API で収集される未処理のメトリクス
次の表に、メトリクス API で収集される未処理のメトリクスの説明を示します。
| システム番号 | メトリクス名 | 説明 | タイプ |
|---|---|---|---|
1 | requests | リクエストの比率を検出するために使用できるリクエスト。 | カウンター |
2 | requests_succeeded | 成功したリクエストの比率を検出するために使用できる成功したリクエスト。 | カウンター |
3 | requests_failed | 失敗したリクエストの比率を検出するために使用できる失敗したリクエスト。 | カウンター |
4 | requests_usage_timedout | 使用状況のタイムアウトを超過したリクエストの比率を検出するために使用できる、使用状況のタイムアウトを超過したリクエスト。 | カウンター |
5 | requests_wait_timedout | 待機タイムアウトを超過したリクエストの比率を検出するために使用できる、待機タイムアウトを超過したリクエスト。 | カウンター |
6 | requests_response_time_seconds | 秒単位の応答時間。 サンプル、観測データ、およびカウントは 0.05、0.1、0.25、0.5、0.75、1、2.5、5、7.5、10、および Inf のバケットに含まれます。 | ヒストグラム |
7 | gp_job_wait_time_seconds | 実行するジオプロセシング ジョブが選択されるのにかかる時間 (秒)。 サンプル、観測データ、およびカウントは 0.05、0.1、0.25、0.5、0.75、1、2.5、5、7.5、10、および Inf のバケットに含まれます。 | ヒストグラム |
メトリクス API で取得されるラベル
メトリクス API で収集される未処理のメトリクスごとに、次の表に示すラベルも収集されます。これらのラベルは、メトリクス API で PromQL クエリと結果フィルターを使用してメトリクスのクエリを実行するために使用できます。
| ラベル名 | 説明 |
|---|---|
nodeName | リクエストを処理するサービス ポッドを使用するコンピューターの名前。 |
podName | リクエストを処理するサービス ポッドの名前。 |
apiType | メトリクスが収集される API。 現在使用できる値は service で、これはサービス リクエストを表します。 |
folderName | サービスが作成されるフォルダーの名前。 |
serviceName | サービスが格納されるフォルダー名を含む、サービスの名前。 |
serviceType | サービスのタイプ (MapService や FeatureService など)。 |
操作 | リクエストされた操作 (query や export など)。 注意:Operation 情報は REST リクエストの場合のみ入手可能です。 SOAP リクエストは soap の値のみを返します。 |
orgId | 組織 ID。 |
username | リクエストを実行するユーザーのユーザー名。 |