# SAP Cloud ALM

# Introduction

This plugin is designed to monitor the status and performance of services in SAP Cloud ALM, providing an overview of system operations and helping to detect potential incidents or performance degradation.

The plugin connects to the SAP Cloud ALM environment to collect relevant metrics from the various configured services, providing information on their status, activity, and behavior over time.

This information is then sent to Pandora FMS, where... This plugin aims to monitor the status and performance of services in SAP Cloud ALM, providing an overview of system operations and helping to detect potential incidents or performance degradations.

The plugin connects to the SAP Cloud ALM environment to collect relevant metrics from the various configured services, providing information on their status, activity, and behavior over time.

This information is then sent to Pandora FMS, where the necessary agents and modules are created for display on the monitoring console. This provides the customer with a clear, centralized view of the status of their SAP environment, enabling a rapid response to any issues.

# Compatibility matrix

<table border="1" id="bkmrk-sistemas-donde-se-ha-1" style="width: 647px; height: 59.2666px;"><tbody><tr style="height: 29.6333px;"><td style="width: 306px; height: 29.6333px;">**Systems where it has been tested**</td><td style="width: 341px; height: 29.6333px;">Rocky linux</td></tr><tr style="height: 29.6333px;"><td style="width: 306px; height: 29.6333px;">**Systems where it works**</td><td style="width: 341px; height: 29.6333px;">Any Linux system</td></tr></tbody></table>

# Prerrequisites

**Get the API key:** You can find it in the “Settings” section of your account.

# Parameters

**Parameters**

<table border="1" id="bkmrk---conf-ruta-al-archi" style="width: 516px;"><tbody><tr><td style="width: 113px;">--conf</td><td style="width: 403px;">Path to the configuration file</td></tr></tbody></table>

<div id="bkmrk-archivo-de-configura"><div><div>**Configuration file (--conf)** </div></div></div><div id="bkmrk-"></div>```
agents_group_name  = < Name of the target group for the created agents >
agent_name         = < Name of the agent that will contain the modules (only if agent_per_mv is not enabled) >
interval           = < Agent creation interval >
agent_prefix       = < Prefix for the created agents >
module_prefix      = < Prefix for the created modules >

# API
api_key            = < SAP Cloud ALM API KEY >

# Regexp filters
allow_regexp       = < Regexp pattern. Metrics matching the pattern will be monitored >
deny_regexp        = < Regexp pattern. Metrics matching the pattern will be discarded >

# Scan flags (0 = disabled, 1 = enabled)
scan_sap_s4hana_op = < Set to 1 to enable monitoring of SAP_S4HANA_OP statistics >
scan_scp_abap      = < Set to 1 to enable monitoring of SCP_ABAP statistics >
scan_sap_cpi       = < Set to 1 to enable monitoring of SAP_CPI statistics >
scan_scp_hcaas     = < Set to 1 to enable monitoring of SCP_HCAAS statistics >
scan_sap_cp_cf     = < Set to 1 to enable monitoring of SAP_CP_CF statistics >
scan_sap_cp_neo    = < Set to 1 to enable monitoring of SAP_CP_NEO statistics >
scan_sap_s4hana    = < Set to 1 to enable monitoring of SAP_S4HANA statistics >
```

<span style="text-decoration: underline;">Ejemplo</span>

```
# API
api_key=WFAFRGAAVFAUIFBAEGSRQj5AFAFA

# Filtros regexp
allow_regexp=.*
deny_regexp=

# Scan flags (0 = desactivado, 1 = activado)
scan_sap_s4hana_op=1
scan_scp_abap=1
scan_sap_cpi=1
scan_scp_hcaas=0
scan_sap_cp_cf=1
scan_sap_cp_neo=1
scan_sap_s4hana=1

# Configuración
agent_prefix=SAP_
agent_name=SAP Cloud ALM
module_prefix=SAP_MODULE_
agents_group_name=SAP_GROUP

# Intervalo de ejecución
interval=300
```

# Ejecución manual

The plugin's execution format is as follows

```
./pandora_sap_calm --conf < path to the configuration file >
```

For example:

```
./pandora_sap_calm --conf /usr/share/pandora_server/util/plugin/sapcalm.conf
```

The execution will return output in JSON format containing information about the execution, and will generate an XML file for each monitored agent, which it will send to the Pandora FMS server using the transfer method specified in the configuration.

For example:

```
{"summary": {"Total agents": 3}
```

# Discovery



# Agents generated by the plugin

- The execution will generate an agent for each unique SID found, with one module for each of its metrics in the selected service types.
- A generic agent will also be generated for metrics without an SID (optional).