メトリクス API の使用
メトリクス API を使用すると、アプリケーションとインフラストラクチャーを監視、管理できます。 メトリクス API を使用すると、リアルタイムにデータを収集、集約でき、システムのパフォーマンスを把握できるようになります。 また、DevOps チームは、メトリクス API を使用して、アラートを設定し、問題を解決して、リソース割り当てを最適化できます。 これらのパフォーマンス指標を公開することで、異常とボトルネックが検出しやすくなり、システム保守を積極的に行えるようになります。 最後に、メトリクス API では、幅広い監視ツールと可視化ツールを統合して、複雑なシステムを監視する能力を強化できます。
管理者は、メトリクス API で PromQL クエリを使用して、未処理のメトリクスに対して直接クエリーを実行して取得できます。これらのメトリクスは、クラスターの内外で実行されるサードパーティーのビューアーやグラフィカル アプリケーション (Grafana など) で使用できます。
メトリクス API は、サービス、ユーザー、コンテンツ アイテムに関する情報を収集します。 Prometheus 監視 システムは、収集された情報を時系列データベースに永続化するために、メトリクス API によって使用されます。
メトリクス API を使用してサービスの最適化やトラブルシューティングを行う方法の詳細については、「サービス メトリクス」をご参照ください。 メトリクス API で収集された情報の視覚化については、「指標の表示」をご参照ください。
メトリクス API へのアクセス
メトリクス 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 によって公開される情報
Prometheus を使用して ArcGIS Enterprise の指標を取得できます。 以下の各表にまとめたメトリクスやラベルを PromQL クエリーや結果フィルターで使用して、必要な情報にアクセスすることができます。
接尾辞 _created が付いたメトリクスは、対応するメトリクスが初めて収集された時点からのヒストグラムとサマリーの Unix 時間 (秒) を反映しています。 この値から、メトリクスのライフ サイクルを把握することができます。 これらのメトリクスは以下の表には含まれていません。
サービス メトリクス
サービス メトリクスは公開されているサービスごとにレポートされます。
|
名前 |
説明 |
タイプ |
ラベル |
|---|---|---|---|
|
requests_failed_total |
失敗したリクエストの数 |
カウンター |
apiType、folderName、instance、instancePool、job、nodeName、operation、podName、responseCached、serviceName、serviceType、username |
|
requests_response_time_seconds_bucket |
バケットの上限 (秒) 以下で完了した観測リクエストの累積数 |
ヒストグラム |
apiType、folderName、instance、instancePool、job、le、nodeName、operation、podName、responseCached、serviceName、serviceType |
|
requests_response_time_seconds_count |
すべてのバケットにおける観測リクエスト応答時間の総数 |
ヒストグラム |
apiType、folderName、instance、instancePool、job、nodeName、operation、podName、responseCached、serviceName、serviceType |
|
requests_response_time_seconds_sum |
すべての観測リクエストの累積応答時間 (秒) |
ヒストグラム |
apiType、folderName、instance、instancePool、job、nodeName、operation、podName、responseCached、serviceName、serviceType |
|
requests_response_time_seconds_counter_total |
リクエストの応答時間の合計 (秒) |
カウンター |
apiType、folderName、instance、instancePool、job、nodeName、operation、podName、responseCached、serviceName、serviceType、username |
|
requests_succeeded_total |
成功したリクエストの数 |
カウンター |
apiType、folderName、instance、instancePool、job、nodeName、operation、podName、responseCached、serviceName、serviceType |
|
requests_total |
リクエストの数 |
カウンター |
apiType、folderName、instance、instancePool、job、nodeName、operation、podName、responseCached、serviceName、serviceType、username |
|
requests_usage_timedout_total |
最大使用時間を超えたことでタイムアウトしたリクエストの数 |
カウンター |
apiType、folderName、nodeName、operation、podName、serviceName、serviceType、username |
|
requests_wait_time_seconds_bucket |
処理待ち時間がバケットの上限値 (秒) 以下であったリクエストの累積数 |
カウンター |
apiType、folderName、instance、instancePool、job、le、nodeName、podName、serviceName、serviceType |
|
requests_wait_time_seconds_count |
すべてのバケットにおける観測リクエスト待ち時間の総数 |
カウンター |
apiType、folderName、instance、instancePool、job、nodeName、podName、serviceName、serviceType |
|
requests_wait_time_seconds_sum |
すべての観測リクエストの累積待ち時間 (秒) |
カウンター |
apiType、folderName、instance、instancePool、job、nodeName、podName、serviceName、serviceType |
|
requests_wait_timedout_total |
最大待ち時間を超えたことでタイムアウトしたリクエストの数 |
カウンター |
apiType、folderName、nodeName、operation、podName、serviceName、serviceType、username |
|
up |
実行中のポッド |
カウンター |
instance、job |
組織メトリクス
|
名前 |
説明 |
タイプ |
ラベル |
|---|---|---|---|
|
items_added_total |
追加されたアイテムの総数 |
カウンター |
componentName、instance、job、nodeName |
|
items_count |
アイテムの総数 |
ゲージ |
componentName、instance、job、nodeName |
|
items_deleted_total |
削除されたアイテムの総数 |
カウンター |
componentName、instance、job、nodeName |
|
items_updated_total |
更新されたアイテムの総数 |
カウンター |
componentName、instance、job、nodeName |
|
items_viewed_total |
閲覧されたすべてのアイテムの総数 |
カウンター |
componentName、instance、job、nodeName |
|
users_added_total |
追加されたユーザーの総数 |
カウンター |
componentName、instance、job、nodeName |
|
users_count |
ユーザーの総数 |
ゲージ |
componentName、instance、job、nodeName |
|
users_login_total |
ユーザー ログインの総数 |
カウンター |
componentName、instance、job、nodeName |
|
users_logout_total |
ユーザー ログアウトの総数 |
カウンター |
componentName、instance、job、nodeName |
注意:
items_count メトリクスに Living Atlas コンテンツなどの Esri コンテンツ アイテムは含まれていません。
ラベルの説明
| ラベル名 | 説明 |
|---|---|
| apiType | メトリクスが収集される API。 |
| folderName | サービスが作成されるフォルダーの名前。 |
| instance | リクエストを処理するサービス ポッドのクラスター IP アドレスとポート。 |
| instancePool | サービスで使用されるインスタンス プール (共有または専用)。 |
| ジョブ | Prometheus 構成で定義されているジョブ名。 |
| le | ヒストグラム メトリクスにおけるバケットの上限。 |
| nodeName | リクエストを処理するサービスが動作しているコンピューターの名前。 |
| operation | リクエストされた操作 (query や export など)。 Operation 情報は REST リクエストの場合のみ入手可能です。 SOAP リクエストは値 soap のみを返します。 |
| podName | リクエストを処理するサービス ポッドの名前。 |
| responseCached | キャッシュから応答が送信されたかどうかを示すブール型インジケーター。 |
| serviceName | サービスが格納されるフォルダー名を含む、サービスの名前。 |
| serviceType | サービスのタイプ (MapService や FeatureService など)。 |
| username | リクエストを実行するユーザーのユーザー名。 |