Version 2: Configure Workload Manager evaluation metrics collection

This guide shows you how to configure version 2 of Google Cloud's Agent for SAP to collect the Workload Manager evaluation metrics from your SAP systems.

For information about this feature, see Workload Manager evaluation using Google Cloud's Agent for SAP.

Before you begin

Validate your installation of Google Cloud's Agent for SAP. For instructions, see the installation guide for your scenario.
If you have installed the agent on a Bare Metal Solution server, then make sure that you have completed the required prerequisites and set up a service account. For instructions, see Configure Google Cloud's Agent for SAP on Linux.

Set IAM roles

To allow Google Cloud's Agent for SAP collect the Workload Manager evaluation metrics, you must ensure that the service account being used by your Compute Engine instance or Bare Metal Solution server includes the following roles:

Compute Viewer (roles/compute.viewer)
Monitoring Metric Writer (roles/monitoring.metricWriter)
Secret Manager Secret Accessor (roles/secretmanager.secretAccessor), if you use Secret Manager for storing SAP HANA database password.

To add these required roles to your service account, follow these steps:

In the Google Cloud console, go to the IAM page.

Go to IAM
Select your Google Cloud project.
Identify the service account to which you want to add a role.
- If the service account isn't already on the principals list, then it doesn't have any roles assigned to it. Click Add and enter the email address of the service account.
- If the service account is already on the principals list, then it has existing roles. Click the Edit button for the service account that you want to edit.
Select the required role from the list of available roles:
- Compute Viewer
- Monitoring > Monitoring Metric Writer
- Secret Manager > Secret Manager Secret Accessor
Click Add or Save to apply the roles to the service account.

Enable Workload Manager evaluation metrics collection

To enable the collection of Workload Manager evaluation metrics using Google Cloud's Agent for SAP, follow these steps:

Establish an SSH connection with your Compute Engine instance or Bare Metal Solution server.

Open the agent's configuration file:

/etc/google-cloud-sap-agent/configuration.json

In the collection_configuration section, for the parameter collect_workload_validation_metrics, set the value true.
To enable the collection of workload.googleapis.com/sap/validation/hanasecurity metric that enables the security evaluation rules in Workload Manager, add the workload_validation_db_metrics_config section after collect_workload_validation_metrics, and then specify the following parameters:
- hana_db_user: specify the user account that is used to query the SAP HANA instance.
- hana_db_password_secret_name: specify the name of the secret in Secret Manager that stores the user account's password.
- hostname: specify the identifier for the machine, either local or remote, that hosts your SAP HANA instance.
- port: specify the port on which your SAP HANA instance accepts queries.
For information about these parameters, see Configuration parameters.
Optionally, under the cloud_properties section, you can update the parameter values that are set automatically. To do so, add the cloud_properties section to your configuration file, and then specify the required parameters and their values.
Save the configuration file.
Restart the agent for the new settings to take effect:
```
sudo systemctl restart google-cloud-sap-agent
```

Example configuration files

Compute Engine instance

The following example is a completed configuration file of version 2 of Google Cloud's Agent for SAP running on a Compute Engine instance, where the collection of Workload Manager evaluation metrics is enabled:

{
  "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",
      "hana_db_password_secret_name": "instance-id-hana-db-password-secret",
      "hostname": "localhost",
      "port": "30015"
    },
    "collect_process_metrics": false,
    "sap_system_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}

Bare Metal Solution server

The following example is a completed configuration file of version 2 of Google Cloud's Agent for SAP running on a Bare Metal Solution server, where the collection of Workload Manager evaluation metrics is enabled:

{
  "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",
      "hana_db_password_secret_name": "instance-id-hana-db-password-secret",
      "hostname": "localhost",
      "port": "30015"
    },
    "collect_process_metrics": false,
    "sap_system_discovery": true
  },
  "cloud_properties": {
    "project_id": "my-project",
    "instance_name": "bms-machine-1",
    "region": "us-central1"
    "image": "rhel-8"
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}

Configuration parameters

The following table explains the configuration parameters of Google Cloud's Agent for SAP that are specific to the collection of the Workload Manager evaluation metrics.

Parameters
`provide_sap_host_agent_metrics`	`Boolean` To enable the collection of the metrics required by the SAP Host Agent, specify `true`. Default is `true`. Don't set `provide_sap_host_agent_metrics` to `false` unless you are directed by Cloud Customer Care or SAP Support.
`bare_metal`	`Boolean` When the agent is installed on a Bare Metal Solution server, specify `true`. Default is `false`.
`log_level`	`String` To set the logging level of the agent, set the required value. The available log levels are as follows: `DEBUG` `INFO` `WARNING` `ERROR` Default is `INFO`. Don't change the logging level unless you are directed by Cloud Customer Care.
`log_to_cloud`	`Boolean` To redirect the agent's logs to Cloud Logging, specify `true`. The default is `true`.
`sap_system_discovery`	`Boolean` To enable the SAP system discovery, specify `true`. Default is `true`.
`cloud_properties.project_id`	`String` If your SAP system is running on a Bare Metal Solution server, then specify the project ID of the Google Cloud project that you are using with Bare Metal Solution. When the agent runs on a Compute Engine instance, by default, the agent detects the project ID automatically.
`cloud_properties.instance_name`	`String` If your SAP system is running on a Compute Engine instance, then specify the name of that compute instance. The agent automatically detects the compute instance name upon installation. If your SAP system is running on a Bare Metal Solution server, then specify the name of that server. In agent version 2.5 or earlier, specify the Bare Metal Solution server name for the property `instance_id`.
`cloud_properties.region`	`String` If your SAP system is running on a Bare Metal Solution server, then specify the region of the Bare Metal Solution server. When the agent runs on a compute instance, by default, the agent uses the region where the compute instance is deployed.
`cloud_properties.zone`	`String` When the agent runs on a compute instance, by default, the agent uses the zone where the compute instance is deployed.
`cloud_properties.image`	`String` Specify the OS image name of the instance. When the agent runs on a compute instance, by default, the agent automatically detects the OS image used by the compute instance.
`cloud_properties.numeric_project_id`	`String` Specify the numeric ID of the Google Cloud project where the SAP system is running. When the agent runs on a compute instance, by default, the agent automatically detects project number.
`collection_configuration.collect_workload_validation_metrics`	`Boolean` To enable Workload Manager evaluation metrics collection, specify `true`. From version 3.2, the default value is `true`. This parameter is applicable only for Linux.
`collection_configuration.workload_validation_metrics_frequency`	`Int` The collection frequency of the Workload Manager evaluation metrics in seconds. The default value is `300` seconds. We recommend that you don't modify the default collection frequency as it might impact the entire feature itself. If you need to modify the collection frequency of the Workload Manager metrics, then add the `workload_validation_metrics_frequency` parameter under the `collection_configuration` section and provide the required value.
`collection_configuration.workload_validation_db_metrics_config.hana_db_user`	`String` Specify the user account that is used to query the SAP HANA instance. The user account must have the read permission to the SAP HANA database.
`collection_configuration.workload_validation_db_metrics_config.hana_db_password`	`String` Specify the password for the user account that is used to query the SAP HANA instance.
`collection_configuration.workload_validation_db_metrics_config.hana_db_password_secret_name`	`String` Specify the name of the secret in Secret Manager that stores the user account's password.
`collection_configuration.workload_validation_db_metrics_config.sid`	`String` Specify the SID of your SAP HANA instance.
`collection_configuration.workload_validation_db_metrics_config.hostname`	`String` Specify the identifier for the machine, either local or remote, that hosts your SAP HANA instance. The following are the supported values: If the host is a local machine, then specify the string `localhost` or the localhost loopback IP address, like `127.0.0.1`. If the host is a remote machine, then specify its internal or external IP address.
`collection_configuration.workload_validation_db_metrics_config.port`	`String` Specify the port on which your SAP HANA instance accepts queries. For the first or only tenant database instance, the port is `3NN15`, where `NN` is the instance number of the SAP HANA instance.
`collection_configuration.workload_validation_db_metrics_frequency`	`Int` The collection frequency of the SAP HANA database metrics, in seconds, for Workload Manager evaluation. Default is `3600` seconds. Although you can update the collection frequency of the SAP HANA database metrics, we recommend that you use the default value. If you need to modify the default value, then add the `workload_validation_db_metrics_frequency` parameter under the `collection_configuration` section and provide the required value. Make sure that you don't set a collection frequency greater than `3600` seconds.