メトリクスへのアクセスの構成

メトリクス API は、ArcGIS Enterprise のコンポーネント、およびそれらのコンポーネントが稼働しているコンピューターに関する情報を収集します。メトリクス API で公開された情報を利用するには、メトリクスへのアクセスを認可するキーまたはトークンを作成し、Prometheus でメトリクスをスクレイピングするように構成して、オプションとして Grafana がメトリクスを視覚化するに構成する必要があります。

メトリクスはデフォルトで有効ですが、必要に応じてメトリクスを無効化することもできます。

アクセス権限の構成

メトリクスをスクレイピングする前に、正しいアクセス権限を有効にします。

各ソフトウェアコンポーネントを実行するアカウントは、コンピューターのメトリクスを収集するために、パフォーマンスモニターグループ に属している必要があります。

ArcGIS Enterprise のデプロイメントでは、フェデレーションサーバーも含めて、API キーでリクエストを認証します。スタンドアロンの ArcGIS Server サイトでは、管理トークンを使用してリクエストを認証します。

注意:

ArcGIS Enterprise コンポーネントのメトリクスを取得するための認証に成功するには、Portal for ArcGIS サービスにアクセスできる必要があります。 ArcGIS Data Store のメトリクスの認証には、ホスティングサーバーにアクセス可能な必要もあります。

ArcGIS Enterprise を使用して API キーを取得する

ArcGIS Enterprise を使用して、メトリクス API にアクセスするための適切な API キーを取得するには、次の手順を実行します:

管理者として組織にサインインします。
コンテンツページの マイコンテンツ タブから 新しいアイテム をクリックし、開発者の認証情報 をクリックします。
API キーの認証情報 を選択し、次へをクリックします。
選択した権限とアクセス権を持つプライベートアプリケーション を選択してから、次へをクリックします。
アイテムへのアクセスなし を選択してから、次へをクリックします。
可観測性 権限を選択してから、次へをクリックします。
有効期限日と、オプションとして参照元 URL を選択してから、次へをクリックします。
API キー項目のタイトルと、オプションとしてタグやサマリーを追加してから、次へをクリックします。
API キーの構成が正確かどうか確認してから、次へをクリックします。
今すぐ API キーを生成する オプションが選択されていることを確認してから、次へをクリックします。
API キーをコピーします。

ArcGIS Server を使用した管理トークンの取得

単独の ArcGIS Server サイトでは、ArcGIS Server を使用して管理トークンを取得できます。フェデレーション ArcGIS Server サイトの場合は、代わりに API キーを取得します。

管理権限を持つユーザーとして、ArcGIS Server Administrator Directory にサインインします。
トークンを生成 をクリックします。
次の情報を入力します。
- ユーザー名 - 管理者権限を持つユーザーのユーザー名
- パスワード - 指定したユーザー名のパスワード
- クライアント - HTTP リファラー
- HTTP リファラー - Prometheus の構成で指定したリファラーと一致する URL Prometheus 構成の例では、ARCGIS.COM をリファラーとして使用します。
オプションとして、有効期限を分単位で設定することもできます。

注意:

デフォルトの有効期限は 60 分です。デフォルトの最大有効期限は 1440 分 (24 時間) です。これより有効期限の長いトークンを生成するには、管理者がトークンを生成する前にトークンの構成を更新して longTimeout プロパティの値を増やす必要があります。 longTimeout の値を増やすときは、更新された値がセキュリティー要件を満たすことを注意深く確認してください。
生成をクリックします。
トークンをコピーします。

Prometheus Server の構成

メトリクス API をスクレイプターゲットに追加するには、Prometheus の構成を更新する必要があります。 Prometheus のデプロイ手順については、「デプロイメントガイド」をご参照ください。

メトリクスを取得する ArcGIS Enterprise の各コンポーネントごとに、別のスクレイプジョブを構成します。各スクレイプの構成には次の情報が必要です:

job_name - ジョブの一意の名前。
http_sd_configs - サービスディスカバリーエンドポイントの構成。以下の情報が必要です。
- url - サービスディスカバリーエンドポイントの URL。この URL は <scheme>://<machine fqdn>/<context>/monitoring/discovery の形式です。
  
  Portal for ArcGIS および ArcGIS Server の場合は、ArcGIS Web Adaptor の URL またはリバースプロキシーの使用が推奨されます。たとえば、ある組織はポータルのメトリクスのサービスディスカバリーには https://portal.example.com/portal/monitoring/discovery を、ArcGIS Server サイトのサービスディスカバリーには https://gisserver.example.com/server/monitoring/discovery を使用することがあります。
  
  ArcGIS Data Store では、リレーショナルストアがインストールされているコンピューターと、ポート番号を指定する必要があります。例: https://relational.example.com:2443/arcgis/monitoring/discovery
- bearer_token または bearer_token_file - 作成した ArcGIS Enterprise API キーまたは ArcGIS Server 管理トークン。
  
  トークンは、サービスディスカバリーエンドポイントへ認証するための http_sd_configs の一部として提供されます。
bearer_token または bearer_token_file - 作成した ArcGIS Enterprise API キーまたは ArcGIS Server 管理トークン。

トークンは、メトリクス収集エンドポイントへ認証するためのスクレイプ構成の一部として再度提供されます。
metrics_path - 値は常に /arcgis/monitoring/metrics

コンピューターのメトリクスをスクレイピングするには、それぞれのコンピューターに直接リクエストを送る必要があります。これらのリクエストは、構成した ArcGIS Web Adaptor やリバースプロキシーを経由しません。 Prometheus Server がポート 6443 経由で各 ArcGIS Server コンピューターにアクセスし、ポート 7443 経由で各 Portal for ArcGIS コンピューターにアクセスできることを確認します。
scheme - https_sd_configs で指定された URL が http と https のどちらでアクセス可能に構成されているかによって、http または https のいずれかです。

ArcGIS Enterprise のメトリクスをスクレイピングするための YAML テンプレートファイルについては、Prometheus 構成の例をご参照ください。ダッシュボードテンプレートの例を使用して、Prometheus でメトリクスを収集した後に Grafana で視覚化するように構成できます。

メトリクスのクリーニング間隔の構成

システムからメトリクスを消去するデフォルトの間隔は 1 時間で、ほとんどの組織に適しています。消去の間隔を変更する際に考慮すべき事項については「メトリクスの消去」をご参照ください。

消去の間隔を変更する必要がある場合、その手順は ArcGIS Enterprise コンポーネントによって異なります。

ArcGIS Server でメトリクスを消去する間隔の構成

管理権限を持つユーザーとして、ArcGIS Server Administrator Directory にサインインします。
システム > プロパティ > 更新 に移動します。
プロパティ テキストボックスで、metricsClearingIntervalInHours キーの値を JSON として追加します。

たとえば、2 時間の間隔を設定するには、次の JSON を使用します:
```
{
   "isMetricsEnabled": true,
   "metricsClearingIntervalInHours": 2
}
```
更新をクリックします。
ArcGIS Server サービスを再起動します。

Portal for ArcGIS でメトリクスを消去する間隔の構成

組織の管理者として Portal Administrator Directory にサインインします。
システム > プロパティ > プロパティの更新 の順に移動します。
プロパティ テキストボックスで、metricsClearingIntervalInHours キーの値を JSON として追加します。

たとえば、2 時間の間隔を設定するには、次の JSON を使用します:
```
{
   "isMetricsEnabled": true,
   "metricsClearingIntervalInHours": 2
}
```
Update Properties をクリックします。

この操作により、Portal for ArcGIS サービスが自動的に再起動します。

ArcGIS Data Store でメトリクスを消去する間隔の構成

リレーショナルストアがインストールされているコンピューターで datastoremetrics ユーティリティーを実行し、interval パラメーターを指定します。たとえば、2 時間の間隔を設定するには、次のコマンドを使用します:

./datastoremetrics --enabled true --interval 2

datastoremetrics --enabled true --interval 2

プライマリーとスタンバイの両方のリレーショナルストアでメトリクスを消去する間隔を変更するには、両方でユーティリティーを実行する必要があります。

メトリクスの無効化

メトリクスを無効化する手順は、ArcGIS Enterprise コンポーネントによって異なります。

ArcGIS Server サイトのメトリクスの無効化

管理権限を持つユーザーとして、ArcGIS Server Administrator Directory にサインインします。
システム > プロパティ > 更新 に移動します。
プロパティ テキストボックスで、isMetricsEnabled キーを false に設定します:
```
{"isMetricsEnabled": false}
```
更新をクリックします。
ArcGIS Server サービスを再起動します。

Portal for ArcGIS のメトリクスの無効化

組織の管理者として Portal Administrator Directory にサインインします。
システム > プロパティ > プロパティの更新 の順に移動します。
プロパティ テキストボックスで、isMetricsEnabled キーを false に設定します:
```
{"isMetricsEnabled": false}
```
Update Properties をクリックします。

この操作により、Portal for ArcGIS サービスが自動的に再起動します。

ArcGIS Data Store のメトリクスの無効化

ArcGIS Data Store のメトリクスを無効化するには、リレーショナルストアがインストールされているコンピューターで次のコマンドを使用し、datastoremetrics ユーティリティーを実行します:

./datastoremetrics --enabled false

datastoremetrics --enabled false

プライマリーとスタンバイの両方のリレーショナルストアでメトリクスを消去するには、両方でユーティリティーを実行する必要があります。