Workload Manager 評価指標の収集を構成する

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

この機能については、Google Cloud の SAP 用エージェントを使用した Workload Manager の評価をご覧ください。

始める前に

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

Workload Manager API を有効にする

IAM のロールを設定する

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

Compute 閲覧者（roles/compute.viewer）
Workload Manager Insights ライター（roles/workloadmanager.insightWriter）
Secret Manager のシークレットアクセサー（roles/secretmanager.secretAccessor）（SAP HANA データベースのパスワードの保存に Secret Manager を使用する場合）。

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

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

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

エージェントのバージョンを確認する

SAP ワークロードを正確に評価するには、Agent for SAP の最新バージョンをインストールすることをおすすめします。Agent for SAP の定期的なリリースで、評価に使用される指標が追加または変更される可能性があります。

Google Cloud の SAP 用エージェントの最新バージョンを使用するには、定期的に更新を確認し、エージェントを更新する必要があります。

更新をインストールする

ご使用のオペレーティングシステムに応じて、次の操作を行います。

RHEL

インスタンスと SSH 接続を確立します。
エージェントインスタンスを更新します。
- （推奨）エージェントのバージョン 3.4（最新）に更新するには:
```
sudo yum --nogpgcheck update google-cloud-sap-agent
```
- エージェントを特定のバージョンに更新するには:
```
sudo yum install google-cloud-sap-agent-VERSION_NUMBER.x86_64
```
  VERSION_NUMBER は、インストールするエージェントのバージョン番号（3.1-606637668 など）に置き換えます。インストール可能なエージェントのバージョンについては、使用可能なすべてのエージェントバージョンを一覧表示するをご覧ください。

SLES

インスタンスと SSH 接続を確立します。
エージェントインスタンスを更新します。
- （推奨）エージェントのバージョン 3.4（最新）に更新するには:
```
sudo zypper --no-gpg-checks update google-cloud-sap-agent
```
- エージェントを特定のバージョンに更新するには:
```
sudo zypper install google-cloud-sap-agent-VERSION_NUMBER.x86_64
```
  VERSION_NUMBER は、インストールするエージェントのバージョン番号（3.1-606637668 など）に置き換えます。インストール可能なエージェントのバージョンについては、使用可能なすべてのエージェントバージョンを一覧表示するをご覧ください。

Workload Manager 評価指標の収集を有効にする

バージョン 3.2 以降、Google Cloud の SAP 用エージェントの新規インストールでは、Workload Manager 評価指標の収集がデフォルトで有効になります。以前のバージョンからバージョン 3.2 に更新する場合は、この機能を明示的に有効にすることもできます。手順は次のとおりです。

Compute Engine VM インスタンスまたは Bare Metal Solution サーバーと SSH 接続を確立します。
エージェントが Workload Manager 評価指標を収集できるようにするには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=workload_evaluation -enable
```
SAP HANA Insights と SAP HANA セキュリティのベストプラクティスの指標の収集を有効にするには:
1. エージェントの構成ファイルを開きます。
```
/etc/google-cloud-sap-agent/configuration.json
```
  別の方法として、コマンドを実行してこの構成を行うこともできます。詳細については、Google Cloud の SAP 用エージェントの構成コマンドをご覧ください。
2. collect_workload_validation_metrics の後に workload_validation_db_metrics_config セクションを追加し、次のパラメータを指定します。
  - hana_db_user: SAP HANA インスタンスのクエリに使用する SAP HANA データベースユーザーアカウントを指定します。
  - hostname: SAP HANA インスタンスをホストするマシン（ローカルまたはリモート）の識別子を指定します。
  - port: SAP HANA インスタンスがクエリを受け付けるポートを指定します。
  - sid: SAP HANA インスタンスの SID を指定します。
  - hana_db_password_secret_name: ユーザーアカウントのパスワードを格納する Secret Manager に Secret の名前を指定します。
    
    Secret の代わりに、hdbuserstore_key 構成パラメータを使用できます。
  - hdbuserstore_key: hana_db_user に指定したユーザーを認証する hdbuserstore 鍵を指定します。
    
    hdbuserstore_key を指定すると、hostname パラメータと port パラメータの指定をスキップします。
  これらのパラメータの詳細については、構成パラメータをご覧ください。
必要に応じて、cloud_properties セクションの自動的に設定されたパラメータ値を更新します。これを行うには、構成ファイルに cloud_properties セクションを追加した後、必要なパラメータとその値を指定します。
構成ファイルを保存します。
エージェントを再起動して、新しい設定を有効にします。
```
sudo systemctl restart google-cloud-sap-agent
```

構成ファイルの例

Compute Engine VM インスタンス

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

{
  "provide_sap_host_agent_metrics": true,
  "bare_metal": false,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "workload_validation_db_metrics_frequency": 3600,
    "workload_validation_db_metrics_config": {
      "hana_db_user": "system",
      "sid": "DEH",
      "hdbuserstore_key": "user_store_key",
      "hana_db_password_secret_name": "instance-id-hana-db-password-secret",
      "hostname": "localhost",
      "port": "30015"
    },
    "collect_process_metrics": false
  },
  "discovery_configuration": {
    "enable_discovery": true,
    "enable_workload_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}

Bare Metal Solution サーバー

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

{
  "provide_sap_host_agent_metrics": true,
  "bare_metal": true,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "workload_validation_db_metrics_frequency": 3600,
    "workload_validation_db_metrics_config": {
      "hana_db_user": "system",
      "sid": "DEH",
      "hdbuserstore_key": "user_store_key",
      "hana_db_password_secret_name": "instance-id-hana-db-password-secret",
      "hostname": "localhost",
      "port": "30015"
    },
    "collect_process_metrics": false
  },
  "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
  }
}

構成パラメータ

次の表に、Workload Manager 評価指標の収集に固有の 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_workload_validation_metrics`	`Boolean` Workload Manager 評価指標の収集を有効にするには、`true` を指定します。バージョン 3.2 以降、デフォルト値は `true` です。このパラメータは Linux にのみ適用されます。
`collection_configuration.workload_validation_metrics_frequency`	`Int` Workload Manager 評価指標の収集頻度（秒）。デフォルト値は `300` 秒です。デフォルトの収集頻度は、機能全体に影響する可能性があるため、変更しないことをおすすめします。 Workload Manager 指標の収集頻度を変更する必要がある場合は、`collection_configuration` セクションに `workload_validation_metrics_frequency` パラメータを追加して必要な値を指定します。
`collection_configuration.workload_validation_collection_definition.fetch_latest_config`	`Boolean` 省略可。デフォルト値は `true` です。これにより、エージェントを更新しなくても、エージェントは最新の Workload Manager 評価指標のセットを収集できます。この動作を無効にするには、構成ファイルでこのパラメータを指定し、値を `false` に設定します。
`collection_configuration.workload_validation_db_metrics_config.hana_db_user`	`String` SAP HANA インスタンスのクエリに使用するユーザーアカウントを指定します。ユーザーアカウントには、SAP HANA データベースに対する読み取り権限が必要です。
`collection_configuration.workload_validation_db_metrics_config.hana_db_password_secret_name`	`String` ユーザーアカウントのパスワードを保存する Secret Manager に Secret の名前を指定します。または、`hdbuserstore_key` 構成パラメータを指定して、指定した SAP HANA ユーザーを認証することもできます。
`collection_configuration.workload_validation_db_metrics_config.hdbuserstore_key`	`String` SAP HANA システムに安全に接続するには、そのシステム用に作成したセキュアユーザーストア（`hdbuserstore`）鍵を指定します。認証に `hdbuserstore` 鍵を使用するには、次の点に注意してください。 SAP ツール `hdbsql` と `hdduserstore` が、エージェントをホストする Compute インスタンスにインストールされている。 `hdbuserstore` キーが、特定の 1 つの SAP HANA インスタンスに対応している。複数の SAP HANA インスタンスのホスト名を含む鍵は使用できません。この構成パラメータは、エージェントのバージョン 3.3 以降でサポートされています。 `hdbuserstore_key` を指定する場合、`hostname` パラメータと `port` パラメータを省略できます。
`collection_configuration.workload_validation_db_metrics_config.sid`	`String` SAP HANA インスタンスの SID を指定します。
`collection_configuration.workload_validation_db_metrics_config.hostname`	`String` SAP HANA インスタンスをホストするマシン（ローカルまたはリモート）の識別子を指定します。サポートされている値は次のとおりです。ホストがローカルマシンの場合は、文字列 `localhost` または localhost ループバック IP アドレス（`127.0.0.1` など）を指定します。ホストがリモートマシンの場合は、内部 IP アドレスまたは外部 IP アドレスを指定します。
`collection_configuration.workload_validation_db_metrics_config.port`	`String` SAP HANA インスタンスがクエリを受け付けるポートを指定します。最初の、または唯一のテナントデータベースインスタンスの場合、ポートは `3NN15` になります。ここで、`NN` は、SAP HANA インスタンスのインスタンス番号です。
`collection_configuration.workload_validation_db_metrics_frequency`	`Int` Workload Manager の評価に関する SAP HANA データベース指標の収集頻度（秒）。デフォルトは `3600` 秒です。 SAP HANA データベースの指標の収集頻度は更新できますが、デフォルト値を使用することをおすすめします。デフォルト値を変更する必要がある場合は、`collection_configuration` セクションに `workload_validation_db_metrics_frequency` パラメータを追加して必要な値を指定します。収集頻度は `3600` 秒以下にしてください。

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

エージェントが収集した Workload Manager 評価指標を表示するには、次の操作を行います。

エージェントのログファイルを表示します。

エージェントのログレベルを DEBUG に設定します。
```
sudo /usr/bin/google_cloud_sap_agent configure -loglevel=debug
```
エージェントを再起動して新しいログレベルを適用したら、エージェントのログファイルを確認します。
```
/var/log/google-cloud-sap-agent.log
```

ログファイルで、次のようなエントリを探します。

workload.googleapis.com/sap/validation/

エージェントのログファイルに Workload Manager 評価指標が表示されている例を次に示します。

{"level":"debug","timestamp":"2024-05-31T20:13:39.439Z",..."context":"WorkloadManagerMetrics",
"metric":"workload.googleapis.com/sap/validation/system","value":1}
{"level":"debug","timestamp":"2024-05-31T20:13:39.439Z",..."context":"WorkloadManagerMetrics",
"key":"instance_name","value":"n1-hana-sles15"}
{"level":"debug","timestamp":"2024-05-31T20:13:39.439Z",..."context":"WorkloadManagerMetrics",
"key":"os","value":"sles-15-SP4"}
...
{"level":"debug","timestamp":"2024-05-31T20:13:39.439Z",..."context":"WorkloadManagerMetrics",
"metric":"workload.googleapis.com/sap/validation/corosync","value":0}
...

エージェントインスタンスが Cloud Logging にログを送信するように構成されている場合は、Cloud Logging でエージェントのログを表示できます。
Workload Manager で SAP ワークロードの評価を作成して実行します。詳細については、評価を作成して実行するをご覧ください。

Google Cloud で実行されている SAP ワークロードの評価で Workload Manager がサポートするベストプラクティスについては、SAP 向けの Workload Manager のベストプラクティスをご覧ください。