Google Cloud の SAP 用エージェントの構成コマンド

このドキュメントでは、Google Cloud の SAP 用エージェントの構成を変更するために使用できるコマンドについて説明します。これらのコマンドは、エージェントのバージョン 3.2 以降でサポートされています。

構成コマンドは、エージェントの構成ファイル（/etc/google-cloud-sap-agent/configuration.json）を編集する代わりに使用できます。各構成コマンドの変更を反映するには、エージェントを再起動する必要があります。

エージェントの再起動の上限

Google Cloud の SAP 用エージェントは 60 秒間に最大 3 回再起動できます。この枠内であれば、構成コマンドを実行してエージェントの構成を続行できますが、この制限を超える自動再起動オペレーションはすべて失敗し、Could not restart the agent が出力されます。

この出力が表示された場合は、必要な構成コマンドをすべて実行した後に、エージェントを手動で再起動して変更を有効にする必要があります。手順については、エージェントを再起動するをご覧ください。

ヘルプコマンド

エージェントの google_cloud_sap_agent configure コマンドの概要ヘルプを出力して終了するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -help
```
エージェントインスタンスの機能のステータスを出力するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -showall
```
エージェントインスタンスのバージョンを出力するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -version
```

google_cloud_sap_agent configure コマンドでサポートされている引数については、サポートされている引数をご覧ください。

最上位の設定

Bare Metal Solution サーバーにエージェントを構成するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -setting=bare_metal -enable
```
Compute Engine VM インスタンスのエージェントを構成するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -setting=bare_metal -disable
```
エージェントのロギングレベルを設定するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -loglevel=LOG_LEVEL
```
LOG_LEVEL は、サポートされているログレベル（debug、info、warn、error）のいずれかに置き換えます。
エージェントがホストで実行されている SAP システムを検出できるようにするには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=sap_discovery -enable
```
エージェントが SAP システムを検出できないようにするには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=sap_discovery -disable
```

SAP Host Agent 指標の収集

エージェントが SAP Host Agent 指標を収集できるようにするには:

sudo /usr/bin/google_cloud_sap_agent configure -feature=host_metrics -enable

SAP Host Agent の指標の収集を停止するには:

sudo /usr/bin/google_cloud_sap_agent configure -feature=host_metrics -disable

エージェントの健全性指標の収集

エージェントの健全性指標の収集を有効にするには:

sudo /usr/bin/google_cloud_sap_agent configure -feature=agent_metrics -enable

エージェントの健全性指標の収集を無効にするには:

sudo /usr/bin/google_cloud_sap_agent configure -feature=agent_metrics -disable

エージェントがデーモンプロセスの CPU 使用率とメモリ使用率を収集して Cloud Monitoring に送信する頻度を変更するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=agent_metrics -agent_metrics_frequency=FREQUENCY
```
FREQUENCY は、必要な値（秒単位）に置き換えます。頻度は 5 秒以上にしてください。
エージェントがオペレーションの健全性を確認して、その情報を Cloud Monitoring に送信する頻度を変更するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=agent_metrics -agent_health_frequency=FREQUENCY
```

Process Monitoring 指標の収集

エージェントによる Process Monitoring 指標の収集を許可するには:

sudo /usr/bin/google_cloud_sap_agent configure -feature=process_metrics -enable

Process Monitoring 指標の収集を停止するには:

sudo /usr/bin/google_cloud_sap_agent configure -feature=process_metrics -disable

エージェントが変化の激しい Process Monitoring 指標を収集する頻度を変更するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=process_metrics -process_metrics_frequency=FREQUENCY
```
エージェントが変化の緩やかな Process Monitoring 指標を収集する頻度を変更するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=process_metrics -slow_process_metrics_frequency=FREQUENCY
```
FREQUENCY は、エージェントが指標を収集する頻度（秒単位）に置き換えます。
Process Monitoring 指標の収集を停止するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=process_metrics -process_metrics_to_skip="LIST_OF_METRICS" -add
```
エージェントの停止時に Process Monitoring 指標の収集を再開するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=process_metrics -process_metrics_to_skip="LIST_OF_METRICS" -remove
```
LIST_OF_METRICS は、エージェントが収集を再開するプロセスモニタリング指標の名前に置き換えます。指標名はカンマで区切ります。

Workload Manager 評価指標の収集

エージェントが Workload Manager 評価指標を収集できるようにするには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=workload_validation -enable
```

Workload Manager 評価指標の収集を停止するには:

sudo /usr/bin/google_cloud_sap_agent configure -feature=workload_validation -disable

エージェントが Workload Manager 評価指標を収集する頻度を変更するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=workload_validation -workload_validation_metrics_frequency=FREQUENCY
```
FREQUENCY は、エージェントが Workload Manager 評価指標を収集する頻度（秒単位）に置き換えます。
Workload Manager の評価でエージェントが SAP HANA データベース指標を収集する頻度を変更するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=workload_validation -workload_validation_db_metrics_frequency=FREQUENCY
```
FREQUENCY は、Workload Manager の評価のためにエージェントが SAP HANA データベースの指標を収集する頻度（秒単位）に置き換えます。

SAP HANA モニタリング指標の収集

エージェントが SAP HANA モニタリング指標を収集できるようにするには:

sudo /usr/bin/google_cloud_sap_agent configure -feature=hana_monitoring -enable

SAP HANA モニタリング指標の収集を停止するには:

sudo /usr/bin/google_cloud_sap_agent configure -feature=hana_monitoring -disable

エージェントが SAP HANA モニタリング指標を収集するサンプル間隔を変更するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=hana_monitoring -sample_interval_sec=SAMPLE_INTERNAL
```
SAMPLE_INTERNAL は、間隔（秒単位）に置き換えます。間隔は 5 秒以上にする必要があります。
SAP HANA インスタンスに実行するクエリのタイムアウト値を変更するには:
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=hana_monitoring -query_timeout_sec=QUERY_TIMEOUT
```
QUERY_TIMEOUT は、値（秒単位）に置き換えます。

サポートされている引数

次の表に、google_cloud_sap_agent configure コマンドで使用できる引数を示します。

引数	説明
`-add`	この引数により、`-process_metrics_to_skip` 引数で指定した Process Monitoring 指標の収集が停止します。
`-disable`	指定されたエージェントの機能またはパラメータを無効にします。
`-enable`	指定されたエージェントの機能またはパラメータを有効にします。
`-f`=`FEATURE_NAME` または `-feature`=`FEATURE_NAME`	`STRING` 構成するエージェントの機能を設定します。サポートされている値は次のとおりです。 `host_metrics` `process_metrics` `agent_metrics` `hana_monitoring` `workload_validation` `sap_discovery`
`-h` または `-help`	コマンドのヘルプ情報を表示します。
`-loglevel`=`LOG_LEVEL`	`STRING` エージェントのロギングレベルを設定します。サポートされている値は `debug`、`info`、`warn`、`error` です。
`-path`=`PATH`	`STRING` エージェントの構成ファイルのパスを設定します。 `/etc/google-cloud-sap-agent/configuration.json`
`-process_metrics_to_skip`="`LIST_OF_METRICS`"	`STRING` エージェントが収集を停止する必要がある Process Monitoring 指標を指定します。指標名はカンマで区切ります。`-process_metrics_to_skip` で `-add` 引数と `-remove` 引数を使用します。
`-process_metrics_frequency`=`FREQUENCY`	`INT` エージェントが変化の激しい Process Monitoring 指標を収集する頻度を設定します。デフォルト値は `5` 秒です。
`-slow_process_metrics_frequency`=`FREQUENCY`	`INT` エージェントが変化の緩やかな Process Monitoring 指標を収集する頻度を設定します。デフォルト値は `30` 秒です。
`-query_timeout_sec`=`TIMEOUT`	`INT` SAP HANA モニタリング指標の収集のクエリタイムアウト（秒単位）を設定します。
`-remove`	この引数により、`-process_metrics_to_skip` 引数を使用して停止した Process Monitoring 指標の収集が再開されます。
`-sample_interval_sec`=`INTERVAL`	`INT` エージェントが SAP HANA インスタンスにクエリを実行して SAP HANA モニタリング指標を収集する頻度（秒単位）を設定します。
`-setting`=`SETTING`	`STRING` 構成するエージェントの設定を指定します。
`-showall`	エージェントインスタンスの機能のステータスを出力します。
`-slow_process_metrics_frequency`=`FREQUENCY`	`INT` 変化の緩やかな Process Monitoring 指標の収集頻度を秒単位で指定します。
`-v` または `-version`	エージェントのバージョンを出力します。
`-workload_validation_metrics_frequency`=`FREQUENCY`	`INT` エージェントが Workload Manager 評価指標を収集する頻度を設定します。
`-workload_validation_db_metrics_frequency`=`FREQUENCY`	`INT` Workload Manager の評価のためにエージェントが SAP HANA データベースの指標を収集する頻度を設定します。