メトリクス API を使用すると、アプリケーションとインフラストラクチャを監視、管理できます。 メトリクス API を使用すると、リアルタイムにデータを収集、集約でき、システムのパフォーマンスを把握できるようになります。 また、DevOps チームは、メトリクス API を使用して、アラートを設定し、問題を解決して、リソース割り当てを最適化できます。 これらのパフォーマンス指標を公開することで、異常とボトルネックが検出しやすくなり、システム保守を積極的に行えるようになります。 最後に、メトリクス API では、幅広い監視ツールと可視化ツールを統合して、複雑なシステムを監視する能力を強化できます。
管理者は、メトリクス API で PromQL クエリを使用して、未処理のメトリクスに対して直接クエリを実行して取得できます。これらのメトリクスは、クラスターの内外で実行されるサードパーティのビューアーやグラフィカル アプリケーション (Grafana など) で使用できます。
詳細は、「サービス使用状況の統計情報」をご参照ください。
メトリクス API では、Prometheus 監視システムを使用して、各 GIS サービス ポッドからこれらのメトリクスを収集し、時系列データベースに入力されるまでその情報を維持します。
メトリクス API は ArcGIS Enterprise 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 (認証情報の更新) 操作を使用します。
メトリクス 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 | リクエストを実行するユーザーのユーザー名。 |