Process Monitoring 指標の収集を構成する

このガイドでは、SAP システムから Process Monitoring 指標を収集するように、Google Cloud の SAP 用エージェントを構成する方法について説明します。

この機能の詳細については、Google Cloud の SAP 用エージェントを使用したプロセスのモニタリングをご覧ください。

始める前に

Google Cloud の SAP 用エージェントのインストールを検証します。手順については、該当のインストールガイドをご覧ください。
Bare Metal Solution サーバーにエージェントがインストールされている場合は、必要な前提条件を満たしていることを確認して、サービスアカウントを設定します。手順については、Linux で Google Cloud の SAP 用エージェントを構成するをご覧ください。

IAM のロールを設定する

Google Cloud の SAP 用エージェントが Process Monitoring 指標を収集できるようにするには、Compute Engine VM インスタンスまたは Bare Metal Solution サーバーが使用するサービスアカウントに次のロールが付与されている必要があります。

Compute 閲覧者（roles/compute.viewer）
モニタリング指標の書き込み（roles/monitoring.metricWriter）ロール。
Secret Manager のシークレットアクセサー（roles/secretmanager.secretAccessor）（SAP HANA データベースのパスワードの保存に Secret Manager を使用する場合）。

これらの必要なロールをサービスアカウントに追加する手順は次のとおりです。

Google Cloud コンソールの [IAM] ページに移動します。

[IAM] に移動
Google Cloud プロジェクトを選択します。
ロールを追加するサービスアカウントを特定します。
- サービスアカウントがまだプリンシパルリストに含まれていない場合、サービスアカウントには何もロールが割り当てられていません。[追加] をクリックし、サービスアカウントのメールアドレスを入力します。
- このサービスアカウントがすでにプリンシパルリストに含まれている場合、サービスアカウントには既存のロールがあります。編集するサービスアカウントの [編集] ボタンをクリックします。
使用可能なロールのリストから必要なロールを選択します。
- Compute 閲覧者（）
- [Monitoring] > [モニタリング指標の書き込み]
- [Secret Manager] > [Secret Manager のシークレットアクセサー]
[追加] または [保存] をクリックして、サービスアカウントにロールを適用します。

Process Monitoring 指標の収集を有効にする

Google Cloud の SAP 用エージェントを使用した Process Monitoring 指標の収集を有効にする手順は次のとおりです。

ホスト VM インスタンスと SSH 接続を確立します。
エージェントの構成ファイルを開きます。
```
/etc/google-cloud-sap-agent/configuration.json
```
別の方法として、コマンドを実行してこの構成を行うこともできます。詳細については、Google Cloud の SAP 用エージェントの構成コマンドをご覧ください。
collection_configuration セクションで、次の操作を行います。
- collect_process_metrics パラメータに、値 true を指定します。
- SAP HANA データベースインスタンスに関連する Process Monitoring 指標の収集を有効にするには、hana_metrics_config セクションで追加のパラメータを構成する必要があります。これらのパラメータの詳細については、構成パラメータをご覧ください。
必要に応じて、cloud_properties セクションの自動的に設定されたパラメータ値を更新します。これを行うには、構成ファイルに cloud_properties セクションを追加した後、必要なパラメータとその値を指定します。
構成ファイルを保存します。
エージェントを再起動して、新しい設定を有効にします。
```
sudo systemctl restart google-cloud-sap-agent
```

構成ファイルの例

Compute Engine VM インスタンス

以下の例は、Compute Engine VM インスタンス上で実行されている Google Cloud の SAP 用エージェントの完全な構成ファイルを示しています。このファイルでは、Process Monitoring 指標の収集が有効になっています。

{
  "provide_sap_host_agent_metrics": true,
  "bare_metal": false,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "collect_process_metrics": true,
    "process_metrics_frequency": 5,
    "slow_process_metrics_frequency": 30,
    "hana_metrics_config": {
      "hana_db_user": "db_user_name",
      "sid": "DEH",
      "hana_db_password_secret_name": "db_pwd_secret_name",
      "hdbuserstore_key": "user_store_key"
    }
  },
  "cloud_properties": {
    "project_id": "my-project",
    "instance_name": "vm-instance-1",
    "image": "rhel-8"
  },
  "discovery_configuration": {
    "enable_discovery": true,
    "enable_workload_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}

Bare Metal Solution サーバー

以下の例は、Bare Metal Solution サーバー上で実行されている Google Cloud の SAP 用エージェントの完全な構成ファイルを示しています。このファイルでは、Process Monitoring 指標の収集が有効になっています。

{
  "provide_sap_host_agent_metrics": true,
  "bare_metal": true,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "collect_process_metrics": true,
    "process_metrics_frequency": 5,
    "slow_process_metrics_frequency": 30,
    "hana_metrics_config": {
      "hana_db_user": "db_user_name",
      "sid": "DEH",
      "hana_db_password_secret_name": "db_pwd_secret_name",
      "hdbuserstore_key": "user_store_key"
    }
  },
  "cloud_properties": {
    "project_id": "my-project",
    "instance_name": "bms-machine-1"
    "region": "us-central1",
    "image": "rhel-8"
  },
  "discovery_configuration": {
    "enable_discovery": true,
    "enable_workload_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}

構成パラメータ

次の表は、Process Monitoring 指標の収集に固有の Google Cloud の SAP 用エージェントの構成パラメータを示しています。

パラメータ
`provide_sap_host_agent_metrics`	`Boolean` SAP Host Agent に必要な指標の収集を有効にするには、`true` を指定します。デフォルトは `true` です。 Cloud カスタマーケアまたは SAP サポートから指示されない限り、`provide_sap_host_agent_metrics` を `false` に設定しないでください。
`bare_metal`	`Boolean` エージェントが Bare Metal Solution サーバーにインストールされている場合は、`true` を指定します。デフォルトは `false` です。
`log_level`	`String` エージェントのロギングレベルを設定するには、必要な値を設定します。使用可能なログレベルは次のとおりです。 `DEBUG` `INFO` `WARNING` `ERROR` デフォルトは `INFO` です。Cloud カスタマーケアから指示されない限り、ロギングレベルを変更しないでください。
`log_to_cloud`	`Boolean` エージェントのログを Cloud Logging にリダイレクトするには、`true` を指定します。デフォルトは `true` です。
`cloud_properties.project_id`	`String` SAP システムが Bare Metal Solution サーバーで実行されている場合は、Bare Metal Solution で使用する Google Cloud プロジェクトのプロジェクト ID を指定します。エージェントが VM インスタンスで実行されている場合、デフォルトでは、プロジェクト ID が自動的に検出されます。
`cloud_properties.instance_name`	`String` SAP システムが Compute Engine VM インスタンスで実行されている場合は、その VM インスタンスの名前を指定します。エージェントは、インストール時に VM インスタンス名を自動的に検出します。 SAP システムが Bare Metal Solution サーバーで実行されている場合は、そのサーバーの名前を指定します。
`cloud_properties.region`	`String` SAP システムが Bare Metal Solution サーバーで実行されている場合は、Bare Metal Solution サーバーのリージョンを指定します。エージェントが VM インスタンスで実行されている場合、デフォルトでは、エージェントがインストールされている VM インスタンスのリージョンが使用されます。
`cloud_properties.zone`	`String` エージェントが VM インスタンスで実行されている場合、デフォルトでは、エージェントがインストールされている VM インスタンスのゾーンが使用されます。
`cloud_properties.image`	`String` インスタンスの OS イメージ名を指定します。エージェントが VM インスタンスで実行されている場合、デフォルトでは、エージェントがインストールされている VM インスタンスの OS イメージが検出されます。
`cloud_properties.numeric_project_id`	`String` SAP システムが実行されている Google Cloud プロジェクトの数値 ID を指定します。エージェントが VM インスタンスで実行されている場合、デフォルトでは、プロジェクト ID（数値）が自動的に検出されます。
`discovery_configuration.enable_workload_discovery`	`Boolean` エージェントがホストで実行されている SAP プロダクトの名前とバージョンを収集できるようにするには、`true` を指定します。デフォルト値は `true` です。詳細については、GoogleCloudPlatform/sapagent の `google-cloud-sap-agent` GitHub リポジトリにあるエージェントのコードベースをご覧ください。
`discovery_configuration.enable_discovery`	`Boolean` エージェントがホストで実行されている SAP プロダクトについて収集した情報を Cloud Logging に送信するには、`true` を指定します。デフォルト値は `true` です。値 `false` を指定すると、エージェントは収集した情報をホストに保存し、Cloud Logging に送信しません。
`collection_configuration.collect_process_metrics`	`Boolean` Process Monitoring 指標の収集を有効にするには、`true` を指定します。デフォルトは `false` です。このパラメータは Linux にのみ適用されます。 SAP HANA のプロセス指標の収集を有効にする場合は、`hana_metrics_config` の下にリストされている追加のパラメータを設定する必要があります。
`collection_configuration.process_metrics_frequency`	`Int` バージョン 2.6 以降では、このパラメータによって急速に変化する Process Monitoring 指標の収集頻度（秒単位）が決定されます。急速に変化する Process Monitoring 指標は、`sap/hana/availability`、`sap/hana/ha/availability`、`sap/nw/availability` です。このパラメータのデフォルト値は `5` 秒です。このデフォルト値を使用することをおすすめします。変化が緩やかな他の Process Monitoring 指標はすべて、デフォルトの 30 秒の頻度で収集されます。変化が緩やかな Process Monitoring 指標の収集頻度を変更するには、`slow_process_metrics_frequency` パラメータを使用します。
`collection_configuration.slow_process_metrics_frequency`	`Int` 変化が緩やかな Process Monitoring 指標の収集頻度を秒単位で指定します。このパラメータのデフォルト値は `30` 秒です。
`collection_configuration.process_metrics_to_skip`	`Array` エージェントで収集しない Process Monitoring 指標を指定します。このパラメータには、Process Monitoring 指標名のカンマ区切り値を指定できます。例: `"process_metrics_to_skip": ["/sap/nw/abap/sessions", "/sap/nw/abap/rfc"]`。
`collection_configuration.hana_metrics_config.hana_db_user`	`String` エージェントが SAP HANA のクエリに使用するデータベースユーザーアカウントを指定します。デフォルトは `SYSTEM` です。
`collection_configuration.hana_metrics_config.hana_db_password`	`String` エージェントが SAP HANA のクエリに使用するデータベースユーザーアカウントのパスワード（書式なしテキスト）を指定します。書式なしテキストパスワードを指定する代わりに、次のいずれかのオプションを使用することをおすすめします。 `hana_db_password_secret_name`。Secret Manager に保存されているシークレットを指定します。 `hdbuserstore_key`。`hdbuserstore` キーを指定します。
`collection_configuration.hana_metrics_config.hana_db_password_secret_name`	`String` エージェントが SAP HANA のクエリに使用するデータベースユーザーアカウントのパスワードを安全に指定するには、データベースユーザーアカウントのセキュリティ認証情報を含むシークレットの名前を指定します。重要: Secret とホスト VM インスタンスは、同じ Google Cloud プロジェクト内に存在する必要があります。 `hana_db_password_secret_name`、`hdbuserstore_key`、または `hana_db_password` のいずれかを指定した場合にのみ、エージェントが SAP HANA 関連の指標を収集します。
`collection_configuration.hana_metrics_config.hdbuserstore_key`	`String` SAP HANA システムに安全に接続するには、そのシステム用に作成したセキュアユーザーストア（`hdbuserstore`）鍵を指定します。認証に `hdbuserstore` 鍵を使用するには、次の点に注意してください。 SAP ツール `hdbsql` と `hdduserstore` が、エージェントをホストする Compute インスタンスにインストールされている。 `hdbuserstore` キーが、特定の 1 つの SAP HANA インスタンスに対応している。複数の SAP HANA インスタンスのホスト名を含む鍵は使用できません。この構成パラメータは、エージェントのバージョン 3.3 以降でサポートされています。
`collection_configuration.hana_metrics_config.sid`	`String` SAP HANA インスタンスの SID を指定します。

収集された指標を表示する

エージェントが収集する Process Monitoring 指標を可視化するには、Google Cloud が提供する次のカスタムダッシュボードを使用します。

SAP 用エージェント - HANA の概要: このダッシュボードは、SAP HANA の可用性、SAP HANA HA の可用性、SAP HANA HA レプリケーション、SAP HANA サービスステータス、HA クラスタ - ノードの状態、HA クラスタ - SAP インスタンスのリソース状態の指標のステータスの概要を表示するグラフを提供します。

このダッシュボードの JSON ファイルは sap-agent-status-overview.json です。
SAP 用エージェント - HANA の元の指標: このダッシュボードは、SAP HANA の可用性、SAP HANA HA の可用性、SAP HANA HA レプリケーション、SAP HANA サービスステータス、HA クラスタ - ノードの状態、HA クラスタ - SAP インスタンスのリソース状態の指標の生の指標値を表示するグラフを提供します。

このダッシュボードの JSON ファイルは sap-agent-raw-metrics.json です。

ダッシュボードをインストールする

カスタムダッシュボードをインストールするには、次の手順を完了します。

Google Cloud コンソール

Google Cloud コンソールで、[Monitoring] ページに移動します。

[Monitoring] に移動
Monitoring のナビゲーションパネルで、[ダッシュボード] をクリックします。
[サンプルライブラリ] タブをクリックします。
エージェント固有のカスタムダッシュボードをフィルタするには、[フィルタ] フィールドに「Agent for SAP」と入力します。
（省略可）ダッシュボードの詳細を表示するか、コンテンツをプレビューするには、[プレビュー] をクリックします。
インストールするダッシュボードを選択します。
[インポート]、[確認] の順にクリックします。

ダッシュボードが Google Cloud プロジェクトで使用可能なダッシュボードに追加されます。ダッシュボードを表示するには、インストールされているダッシュボードを表示するの手順に沿って操作します。

Google Cloud CLI

Cloud Shell を開きます。

Cloud Shell を開く
Cloud Shell で、リポジトリのクローンを作成するか、リポジトリをダウンロードします。
```
git clone https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples/
```
Cloud Shell で、対応する JSON ファイルを使用して必要なダッシュボードをインストールします。
```
gcloud monitoring dashboards create --config-from-file=CONFIG_FROM_FILE
```
CONFIG_FROM_FILE は、ダッシュボード構成を含む JSON ファイルのパスに置き換えます。ダッシュボード構成ファイルはパス monitoring-dashboard-samples/dashboards/google-cloud-agent-for-sap にあります。

ダッシュボードが Google Cloud プロジェクトで使用可能なダッシュボードに追加されます。ダッシュボードを表示するには、インストールされているダッシュボードを表示するの手順に沿って操作します。

インストールされているダッシュボードを表示する

インストールされているダッシュボードを表示するには、次の操作を行います。

Google Cloud コンソールで、[Monitoring] ページに移動します。

[Monitoring] に移動
Monitoring のナビゲーションパネルで、[ダッシュボード] をクリックします。
リスト内のダッシュボード名をクリックします。

ダッシュボードの数が多い場合は、カスタムダッシュボードや新しいダッシュボードの名前でフィルタできます。このリストをフィルタする方法については、カスタムダッシュボードを表示するをご覧ください。

次の図は、Monitoring の SAP HANA 指標のカスタムダッシュボードの一部を示す例です。

Monitoring に SAP HANA 指標のカスタムダッシュボードが表示されているスクリーンキャプチャ。