Google Cloud 的 Agent for SAP 的配置命令

本文档介绍可用于修改 Google Cloud 的 Agent for SAP 配置的命令。这些命令从代理版本 3.2 开始受支持。

这些配置命令是修改代理配置文件 /etc/google-cloud-sap-agent/configuration.json 的替代方法。每个配置命令还会重启代理，以确保更改生效。

代理重启限制

您可以在 60 秒内最多重启 Google Cloud 的 Agent for SAP 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 命令支持的参数，请参阅支持的参数。

对于顶级设置

如需为裸金属解决方案服务器配置代理，请运行以下命令：

sudo /usr/bin/google_cloud_sap_agent configure -setting=bare_metal -enable

如需为 Compute Engine 虚拟机实例配置代理，请运行以下命令：

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 系统发现

如需让代理收集 SAP 系统使用的 SAP 产品的名称和版本，请执行以下操作：
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=workload_discovery -enable
```
如需停止代理收集 SAP 系统使用的 SAP 产品的名称和版本，请执行以下操作：
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=workload_discovery -disable
```
如需让代理将发现的 SAP 系统信息发送到 Cloud Logging，以及在您的 Google Cloud 项目中启用 Workload Manager API 后将其发送到 Workload Manager，请执行以下操作：
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=sap_discovery -enable
```
如需停止代理将发现的信息发送到 Cloud Logging 和 Workload Manager，请执行以下操作：
```
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 指标，请运行以下命令：

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 替换为您希望代理继续收集的 Process Monitoring 指标的名称。使用英文逗号分隔指标名称。

对于 Workload Manager 评估指标收集

如需让代理收集 Workload Manager 评估指标，请运行以下命令：

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

如需停止收集 Workload Manager 评估指标，请运行以下命令：

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

如需修改代理必须收集 Workload Manager 评估指标的频率，请运行以下命令：
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=workload_evaluation -workload_evaluation_metrics_frequency=FREQUENCY
```
将 FREQUENCY 替换为代理必须收集 Workload Manager 评估指标的频率（以秒为单位）。
如需修改代理必须收集 SAP HANA 数据库指标以进行 Workload Manager 评估的频率，请运行以下命令：
```
sudo /usr/bin/google_cloud_sap_agent configure -feature=workload_evaluation -workload_evaluation_db_metrics_frequency=FREQUENCY
```
将 FREQUENCY 替换为代理必须收集 SAP HANA 数据库指标以进行 Workload Manager 评估的频率（以秒为单位）。

对于 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_evaluation` `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 指标。使用英文逗号分隔指标名称。将 `-add` 和 `-remove` 参数与 `-process_metrics_to_skip` 搭配使用。
`-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_evaluation_metrics_frequency`=`FREQUENCY`	`INT` 设置代理收集 Workload Manager 评估指标的频率。
`-workload_evaluation_db_metrics_frequency`=`FREQUENCY`	`INT` 设置代理收集 SAP HANA 数据库指标以进行 Workload Manager 评估的频率。