Google Cloud's Agent for SAP is required for SAP support of SAP systems running on Google Cloud, including SAP NetWeaver, SAP HANA, SAP ASE, SAP MaxDB, and others.
When you install Google Cloud's Agent for SAP on a Compute Engine instance, for SAP Host Agent metrics, the agent combines monitoring data from Cloud Monitoring and the Compute Engine APIs and provides that data to the SAP Host Agent.
If you use the following RHEL or SLES "for SAP" OS images that Google Cloud provides, then Google Cloud's Agent for SAP is packaged with the OS images:
- RHEL: all "for SAP" images
- SLES: SLES 15 SP4 for SAP and later versions
For information about the operating systems supported by Google Cloud's Agent for SAP, see Supported operating systems.
To install and configure version 3.6 (latest) of Google Cloud's Agent for SAP on a Bare Metal Solution server, see Install Google Cloud's Agent for SAP on a Bare Metal Solution server.
Installation overview
On Linux, you install Google Cloud's Agent for SAP by using standard operating
system package management commands: on RHEL, the yum command; on SLES, the
zypper command. The package management command completes the following tasks:
- Downloads the latest version of Google Cloud's Agent for SAP.
- Creates the agent as a Linux
systemdservice, namedgoogle-cloud-sap-agent. - Enables and starts the service,
google-cloud-sap-agent.
On Windows, you install Google Cloud's Agent for SAP by using the GooGet package
management command, googet. The package management command completes the
following tasks:
- Downloads the latest version of Google Cloud's Agent for SAP.
Creates a Windows service named
google-cloud-sap-agentand a scheduled task that runs every minute to check if the service is still running and, if necessary, restart it.
Prerequisites for the agent
Before you install Google Cloud's Agent for SAP, you need to ensure that the following prerequisites are met.
Set the required IAM roles
At a minimum, the
service account
that Google Cloud's Agent for SAP uses must include the
Compute Viewer (roles/compute.viewer),
Monitoring Viewer (roles/monitoring.viewer),
and Workload Manager Insights Writer (roles/workloadmanager.insightWriter)
roles.
To add a required role to your service account, follow these steps:
In the Google Cloud console, go to the IAM page.
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 Engine > Compute Viewer
- Monitoring > Monitoring Viewer
- Workload Manager > Workload Manager Insights Writer
Click Add or Save to apply the roles to the service account.
Enable access to Google Cloud APIs
Compute Engine recommends configuring your compute instances to allow all access scopes to all Cloud APIs and using only the IAM permissions of the instance service account to control access to Google Cloud resources. For more information, see Create a VM that uses a user-managed service account.
If you do limit access to the Cloud APIs, then Google Cloud's Agent for SAP requires the following minimum Cloud API access scopes on the host Compute Engine instance:
- Cloud Platform: Enabled
- Compute Engine: Read Only
- Stackdriver Monitoring API: Read Only
If you are running SAP applications on a compute instance that does not have an external IP address, then you need to enable Private Google Access on the subnet of the compute instance so that Google Cloud's Agent for SAP can access Google APIs and services. To enable Private Google Access on a subnet, see Configuring Private Google Access.
Install the agent
To install Google Cloud's Agent for SAP on your Compute Engine instance, select your operating system, and then complete the following steps.
Linux
To install the agent on a Compute Engine instance, follow these steps:
- Establish an SSH connection to your compute instance.
- In your terminal, install the agent by running the command that is specific
to your operating system:
- (Recommended) To install version 3.6 (latest) of the
agent:
RHEL
sudo tee /etc/yum.repos.d/google-cloud-sap-agent.repo << EOM [google-cloud-sap-agent] name=Google Cloud Agent for SAP baseurl=https://packages.cloud.google.com/yum/repos/google-cloud-sap-agent-el$(cat /etc/redhat-release | cut -d . -f 1 | tr -d -c 0-9)-x86_64 enabled=1 gpgcheck=1 repo_gpgcheck=0 gpgkey=https://packages.cloud.google.com/yum/doc/yum-key.gpg https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg EOM sudo yum install google-cloud-sap-agent
SLES15
sudo zypper addrepo --refresh https://packages.cloud.google.com/yum/repos/google-cloud-sap-agent-sles15-x86_64 google-cloud-sap-agent sudo zypper install google-cloud-sap-agent
SLES 12
sudo zypper addrepo --refresh https://packages.cloud.google.com/yum/repos/google-cloud-sap-agent-sles12-x86_64 google-cloud-sap-agent sudo zypper install google-cloud-sap-agent
- To install a specific version of the agent:
RHEL
sudo tee /etc/yum.repos.d/google-cloud-sap-agent.repo << EOM [google-cloud-sap-agent] name=Google Cloud Agent for SAP baseurl=https://packages.cloud.google.com/yum/repos/google-cloud-sap-agent-el$(cat /etc/redhat-release | cut -d . -f 1 | tr -d -c 0-9)-x86_64 enabled=1 gpgcheck=1 repo_gpgcheck=0 gpgkey=https://packages.cloud.google.com/yum/doc/yum-key.gpg https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg EOM sudo yum install google-cloud-sap-agent-VERSION_NUMBER.x86_64
SLES15
sudo zypper addrepo --refresh https://packages.cloud.google.com/yum/repos/google-cloud-sap-agent-sles15-x86_64 google-cloud-sap-agent sudo zypper install google-cloud-sap-agent-VERSION_NUMBER.x86_64
SLES 12
sudo zypper addrepo --refresh https://packages.cloud.google.com/yum/repos/google-cloud-sap-agent-sles12-x86_64 google-cloud-sap-agent sudo zypper install google-cloud-sap-agent-VERSION_NUMBER.x86_64
Replace
VERSION_NUMBERwith the agent's version number that you want to install, such as3.1-606637668. For information about the agent versions that you can install, see List all available versions of the agent.For information about downgrading the agent to a specific version, see Downgrade Google Cloud's Agent for SAP.
- (Recommended) To install version 3.6 (latest) of the
agent:
Windows
To install the agent on a Compute Engine instance, follow these steps:
- Use RDP to connect to the compute instance.
- As an administrator, run the following command from PowerShell:
googet addrepo google-cloud-sap-agent https://packages.cloud.google.com/yuck/repos/google-cloud-sap-agent-windows googet install google-cloud-sap-agent
After you install Google Cloud's Agent for SAP and the SAP Host Agent, validate the installation of Google Cloud's Agent for SAP, as described in Validate your installation of the agent.
Validate your installation of the agent
To verify that the agent is running, select your operating system, and then follow the steps:
Linux
Establish an SSH connection with your Compute Engine instance.
Run the following command:
systemctl status google-cloud-sap-agent
If the agent is functioning properly, then the output contains
active (running). For example:google-cloud-sap-agent.service - Google Cloud Agent for SAP Loaded: loaded (/usr/lib/systemd/system/google-cloud-sap-agent.service; enabled; vendor preset: disabled) Active: active (running) since Fri 2022-12-02 07:21:42 UTC; 4 days ago Main PID: 1337673 (google-cloud-sa) Tasks: 9 (limit: 100427) Memory: 22.4 M (max: 1.0G limit: 1.0G) CGroup: /system.slice/google-cloud-sap-agent.service └─1337673 /usr/bin/google-cloud-sap-agentOn SLES images, to ensure you're using the latest version of Google Cloud's Agent for SAP, run the following commands.
sudo zypper remove google-cloud-sap-agent sudo zypper addrepo -p 98 --refresh https://packages.cloud.google.com/yum/repos/google-cloud-sap-agent-sles15-\$basearch google-cloud-sap-agent sudo zypper install google-cloud-sap-agent
Windows
Use RDP to connect to the Compute Engine instance.
As an administrator, run the following command from PowerShell:
$(Get-Service -Name 'google-cloud-sap-agent' -ErrorAction Ignore).Status
If the agent is running, then the status showsRunning.
If the agent isn't running, then restart the agent.
Verify that SAP Host Agent is receiving metrics
To verify that the infrastructure metrics are collected by Google Cloud's Agent for SAP and sent correctly to the SAP Host Agent, follow these steps:
- In your SAP system, enter transaction
ST06. In the overview pane, check the availability and content of the following fields for the correct end-to-end setup of the SAP and Google monitoring infrastructure:
- Cloud Provider:
Google Cloud Platform - Enhanced Monitoring Access:
TRUE - Enhanced Monitoring Details:
ACTIVE
- Cloud Provider:
Configure Google Cloud's Agent for SAP on Linux
After you install Google Cloud's Agent for SAP, optionally, you can enable other features of the agent by performing the following configurations. By default, the collection of SAP Host Agent metrics and Workload Manager evaluation metrics is enabled.
The following features are supported only on Linux. They are not supported on Windows.
- Configure Process Monitoring metrics collection
- Configure Workload Manager evaluation metrics collection
- Configure SAP HANA monitoring metrics collection.
- Configure Backint based backup and recovery for SAP HANA.
- Back up and recover SAP HANA by using a disk snapshot.
Default configuration file
The following snippet is an example of the default configuration of version 3.6 (latest) of Google Cloud's Agent for SAP:
{
"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": false
},
"discovery_configuration": {
"enable_discovery": true,
"enable_workload_discovery": true
},
"hana_monitoring_configuration": {
"enabled": false
}
}
To view feature-specific example configuration files, see the configuration guide for that feature.
Configuration parameters
The following table describes the configuration parameters of Google Cloud's Agent for SAP that is running on a Compute Engine instance, including the parameters related to the collection of metrics. For information about the configuration parameters related to the Backint feature of the agent, see Configuration parameters.
| Parameters | |
|---|---|
provide_sap_host_agent_metrics |
To enable the collection of the metrics required by the
SAP Host Agent, specify |
bare_metal |
When the agent is installed on a Bare Metal Solution server, specify
|
log_level |
To set the logging level of the agent, set the required value. The available log levels are as follows:
Default is |
log_to_cloud |
To redirect the agent's logs to
Cloud Logging, specify
|
cloud_properties.project_id |
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. |
cloud_properties.instance_name
|
Specify the name of your Compute Engine instance. The agent automatically detects this upon installation. |
cloud_properties.region |
If your SAP system is running on a Bare Metal Solution server,
then specify the region of the Bare Metal Solution server. |
cloud_properties.zone |
When the agent runs on a compute instance, by default, the agent uses the zone where the compute instance is deployed. |
cloud_properties.image |
Specify the OS image name of the instance. |
cloud_properties.numeric_project_id |
Specify the numeric ID of the Google Cloud project where the SAP system
is running. |
discovery_configuration.enable_workload_discovery |
To let the agent collect the names and versions of the SAP products
running on the host, specify For more information, see the agent's codebase in the
|
discovery_configuration.enable_discovery |
To send to Cloud Logging the information that the agent collects about
the SAP products running on the host, specify If you specify the value |
collection_configuration.collect_process_metrics |
To enable Process Monitoring metrics collection, specify |
collection_configuration.process_metrics_frequency |
From version 2.6, this parameter determines the collection frequency of the
fast-changing Process Monitoring metrics,
in seconds. Fast-changing Process Monitoring metrics are: The default value for this parameter is
All other (slow-changing) Process Monitoring metrics are collected at a
default frequency of 30 seconds. To change the collection frequency of
the slow-changing Process Monitoring metrics, use the parameter
|
collection_configuration.slow_process_metrics_frequency |
Specify the collection frequency of the slow-changing Process Monitoring metrics, in seconds. The default value for this parameter is |
collection_configuration.process_metrics_to_skip |
Specify the
Process Monitoring metrics
that you don't want the agent to collect. This parameter accepts a
comma-separated value of Process Monitoring metric names. For example:
|
collection_configuration.hana_metrics_config.hana_db_user |
Specify the database user account that the agent uses to query
SAP HANA. Default is |
collection_configuration.hana_metrics_config.hana_db_password |
Specify the plain text password for the database user account that the agent uses to query SAP HANA. Instead of specifying a plain text password, we recommend that you use one of the following options:
For SAP HANA authentication, the agent uses the following order of
preference: if specified, the |
collection_configuration.hana_metrics_config.hana_db_password_secret_name |
To securely provide the password for the database user account that the agent uses to query SAP HANA, specify the name of the secret that contains the security credentials for the database user account. The agent collects the SAP HANA related metrics only when you specify
either For SAP HANA authentication, the agent uses the following order of
preference: if specified, the |
collection_configuration.hana_metrics_config.hdbuserstore_key
|
To securely connect to an SAP HANA system, specify a
Secure user store ( To use an
This configuration parameter is supported from version 3.3 of the agent. For SAP HANA authentication, the agent uses the following order of
preference: if specified, the |
collection_configuration.hana_metrics_config.sid |
Specify the SID of your SAP HANA instance.
If you're using an |
collection_configuration.collect_workload_validation_metrics |
To enable Workload Manager evaluation metrics collection,
specify |
collection_configuration.workload_validation_metrics_frequency |
The collection frequency of the Workload Manager
evaluation metrics in seconds. The default value is If you need to modify the collection frequency of the
Workload Manager metrics, then add the
|
collection_configuration.workload_validation_collection_definition.fetch_latest_config |
Optional. The default value is |
collection_configuration.workload_validation_db_metrics_config.hana_db_user |
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 |
Specify the password for the user account that is used to query the SAP HANA instance. For SAP HANA authentication, the agent uses the following order of
preference: if specified, the |
collection_configuration.workload_validation_db_metrics_config.hana_db_password_secret_name |
Specify the name of the secret in Secret Manager that stores the user account's password. Alternatively, you can specify the For SAP HANA authentication, the agent uses the following order of
preference: if specified, the |
collection_configuration.workload_validation_db_metrics_config.hdbuserstore_key
|
To securely connect to an SAP HANA system, specify a
Secure user store ( To use an
This configuration parameter is supported from version 3.3 of the agent. If you specify For SAP HANA authentication, the agent uses the following order of
preference: if specified, the |
collection_configuration.workload_validation_db_metrics_config.sid |
Specify the SID of your SAP HANA instance. |
collection_configuration.workload_validation_db_metrics_config.hostname |
Specify the identifier for the machine, either local or remote, that hosts your SAP HANA instance. The following are the supported values:
|
collection_configuration.workload_validation_db_metrics_config.port |
Specify the port on which your SAP HANA instance accepts queries. For
the first or only tenant database instance, the port is
|
collection_configuration.workload_validation_db_metrics_frequency |
The collection frequency of the SAP HANA database metrics, in seconds,
for Workload Manager evaluation.
Default is |
hana_monitoring_configuration.enabled |
Optional. To enable Google Cloud's Agent for SAP to collect the SAP HANA
monitoring metrics, specify hana_monitoring_configuration.enabled: true.
|
hana_monitoring_configuration.sample_interval_sec |
Optional. Specify the sample interval, in seconds, which determines the frequency at which Google Cloud's Agent for SAP queries your SAP HANA instances to collect the SAP HANA monitoring metrics. The default value is 300 seconds. For each query defined in the configuration file of
Google Cloud's Agent for SAP, you can overwrite the global sample interval
by specifying the required interval to the parameter
|
hana_monitoring_configuration.query_timeout_sec |
Optional. Specify the timeout for each query made to the SAP HANA instances. The default value is 300 seconds. |
hana_monitoring_configuration.execution_threads |
Optional. Specify the number of threads used to send queries to the SAP HANA instances. Each query runs on its own thread. The default value is 10. |
hana_monitoring_configuration.hana_instances.name |
Specify the name identifier for your SAP HANA instance. |
hana_monitoring_configuration.hana_instances.sid |
Specify the SID of your SAP HANA instance. This string is added as a label to all the metrics resulting from querying your SAP HANA instances. |
hana_monitoring_configuration.hana_instances.host |
Specify the identifier for the machine, either local or remote, that hosts your SAP HANA instance. The following are the supported values:
|
hana_monitoring_configuration.hana_instances.port |
Specify the port on which your SAP HANA instance accepts queries. For
the first or only tenant database instance, the port is
|
hana_monitoring_configuration.hana_instances.user |
Specify the user account that is used to query the SAP HANA instance. Make sure that this user has the privilege to read the monitoring views in your SAP HANA database. If this privilege is not granted, then the SAP HANA monitoring metrics related to the monitoring views contain no data. |
hana_monitoring_configuration.hana_instances.password |
Optional. Specify the password, as plain text, that authenticates the user account for querying the SAP HANA instance. For authentication, you must specify one of the following:
For SAP HANA authentication, the agent uses the following order of
preference: if specified, the |
hana_monitoring_configuration.hana_instances.secret_name |
Optional. Specify the name of the secret in Secret Manager that stores the user account's password. For SAP HANA authentication, the agent uses the following order of
preference: if specified, the |
hana_monitoring_configuration.hana_instances.hdbuserstore_key
|
To securely connect to an SAP HANA system, specify a
Secure user store ( To use an
This configuration parameter is supported from version 3.3 of the agent. If you specify |
hana_monitoring_configuration.hana_instances.enable_ssl |
Optional. Specifies whether or not SSL is enabled in your SAP HANA
instance. The default value is |
hana_monitoring_configuration.hana_instances.host_name_in_certificate |
If you specify |
hana_monitoring_configuration.hana_instances.tls_root_ca_file |
If you specify |
hana_monitoring_configuration.queries.enabled |
Optional. To enable a SQL query for all your SAP HANA instances,
specify the value |
hana_monitoring_configuration.queries.name |
If you have defined custom queries in your configuration file, then you must specify a unique name for each custom query. The query name must be unique because it is used to build the metric's default URL in Monitoring. |
hana_monitoring_configuration.queries.sql |
Specify the SQL statement that the agent issues to your SAP HANA instances. The SQL statement must conform to the SQL syntax defined by SAP in SAP HANA SQL and System Views Reference. |
hana_monitoring_configuration.queries.sample_interval_sec |
Optional. Specify the sample interval for the SQL query. This overrides the global sample interval. The value must be 5 seconds or longer. |
hana_monitoring_configuration.queries.columns.name |
Specify a name that uniquely identifies each column. The column name must be unique because it is used to build the metric's default URL in Monitoring. |
hana_monitoring_configuration.queries.columns.metric_type |
For handling by Monitoring, specify one of the following
metric types: Metrics of type |
hana_monitoring_configuration.queries.columns.value_type |
For handling by Monitoring, specify a data type that is supported by the metric type. The supported data types are as follows: |
hana_monitoring_configuration.queries.columns.name_override |
Optional. For handling by Monitoring, specify the path that you want to show in the metric URL instead of the query and column names. For example:
|
Troubleshooting
For information about diagnosing and resolving issues that you might encounter when you install and configure Google Cloud's Agent for SAP, see Google Cloud's Agent for SAP troubleshooting guide.
Get support
If you need help resolving problems with Google Cloud's Agent for SAP, then collect all available diagnostic information and contact Cloud Customer Care. For information about contacting Customer Care, see Getting support for SAP on Google Cloud.