Connect with SAP Cloud ALM

Overview

Within the SAP system a high volume of events originating from multiple objects and instances are sent. These events will produce requests that result in various statuses, including both successful completions and errors.

To maintain system health visibility, organizations can calculate a key performance metric: the error ratio. This metric represents the proportion of failed requests relative to the total number of requests processed for each corresponding object.

Once calculated, this error rate metric can be transmitted via API to SAP Cloud ALM, where it becomes accessible through the Health Monitoring dashboard. This integration enables proactive monitoring and facilitates timely identification of objects experiencing elevated error rates.

With the January 2026 release we also added support to send exception messages to SAP Cloud ALM. This information can then be used in the Exception Monitoring dashboard.

Purpose

To fulfill the monitoring requirements outlined above, the error rate metric is calculated at the object level for a specified time range (measured in minutes from the current time). The system provides flexible calculation options:

Instance-level calculation: Compute metrics separately for all objects within one or more specified instances
Object-level calculation: Calculate metrics for specific designated objects

Prerequisites

Cloud ALM configuration must be established in the instance object for all data transmission operations. All metric calculations are based on the defined time range in minutes
Cloud ALM API usage needs to be activated in Cloud ALM (https://help.sap.com/docs/cloud-alm/apis/enabling-sap-cloud-alm-apis?locale=en-US&version=LATEST )

Used API

Metrics

The API to transmit this metric is the Raw Data Inbound Metrics API (https://help.sap.com/docs/cloud-alm/apis/raw-data-inbound-metrics-api?locale=en-US&version=LATEST ). Each execution transmits a single JSON file containing multiple metrics via the Raw Data API. The JSON structure adheres to the OpenTelemetry format (key-value pairs) as mandated by API requirements.

Logs

The API to transmit the exceptions is the Raw Data Inbound Logs API (https://help.sap.com/docs/cloud-alm/apis/raw-data-inbound-logs?locale=en-US&version=LATEST ). Each execution transmits log data, often a batch of records, via the Raw Data API. The data structure must adhere to the OpenTelemetry Protocol (OTLP) and specifically conform to the OpenTelemetry Logs format as mandated by API requirements.

Authentication and Service Configuration

Authentication Method

The system utilizes OAuth authentication, requiring the following credentials from Cloud ALM:

Client ID
Client Secret

Service Setup Requirements

A dedicated service must be created and activated for Health Monitoring purposes. This service generates a unique Service ID that is required for all subsequent operations.

Configuration in Cloud ALM

Retrieving Cloud ALM Credentials

All necessary authentication data and configuration parameters for the Cloud ALM platform can be accessed through the following path: Navigation Path:
Administration → Landscape Management → Services & Systems → Configuration → SAP Cloud ALM Service Key (section)

The existing service key file can be downloaded directly from this location and contains all required authentication and configuration information.

Creating and Activating a Service for Health Monitoring

This will be used to send the metrics information to Cloud ALM.

Step 1: Create a New Service

Navigate to:
Administration → Landscape Management → Services & Systems → Add → New Service
Complete the following required fields:

Name: Service identifier
Description: Service description
Deployment Model: Select appropriate model
Service Type: Select “Unspecified Cloud Service HTTP” (for third-party services)
Role: Assign appropriate role
System Number: Specify system number

Step 2: Configure Health Monitoring Scope

Navigate to: Operations → Health Monitoring
Click the Select a Scope button
In the scope selection window:
- Clear all existing filters
- Locate and select the service you created
- Click Apply

Step 3: Activate the Service

Navigate to: Configuration tab
Locate the Services section
Find your service in the list
Toggle the status to ON

Your service is now active for Health Monitoring.

Creating and Activating a Service for Integration & Exception Monitoring

This will be used to send the exception / log information to Cloud ALM.

Step 1: Create a New Service

Navigate to:
Administration → Landscape Management → Services & Systems → Add → New Service
Complete the following required fields:

Name: Service identifier
Description: Service description
Deployment Model: Select appropriate model
Service Type: Select “Unspecified Cloud Service HTTP” (for third-party services)
Role: Assign appropriate role
System Number: Specify system number

Step 2: Configure Health Monitoring Scope

Navigate to: Operations → Integration & Exception Monitoring
Click the Select a Scope button
In the scope selection window:
- Clear all existing filters
- Locate and select the service you created
- Click Apply

Step 3: Activate the Service

Navigate to: Configuration tab
Locate the Services section
Find your service in the list
Toggle the status to ON

Your service is now active for Integration & Exception Monitoring.

Retrieving the Service ID

To obtain your Service ID:

Navigation Path:
Administration → Landscape Management → Services & Systems

Select your service from the list
Locate the ID field
The value displayed is your Service ID

Configuration in SAP System

SAP System Configuration (SPRO)

Cloud ALM configuration must be activated in the designated instances through SPRO customization in Connection and Replication Object Customizing.

Instance Default Values Configuration

Configure the following parameters in the default values of your primary instance:

Default Attribute	Default Attribute Value
CALM_INSTANCE	<instance name pointing to metrics endpoint>
CALM_SERVICEID	<service_id_for_metrics_service>
CALM_LOGS_INSTANCE	<instance name pointing to logs endpoint>
CALM_LOG_SERVICEID	<service_id_for_logs_service>

Create Cloud ALM Instance for Metrics Endpoint

Create a new Cloud ALM instance with the RFC destination CLOUD_ALM_METRICS_API and the default values as shown below.

RFC Destinations:

CLOUD_ALM_METRICS_API: RFC destination of type G containing the URL endpoint for metric data transmission – use this a the destination in your Cloud ALM instance
CLOUD_ALM_METRICS_TOKEN: RFC destination of type G containing the URL endpoint for OAuth token retrieval, which is required for authenticated data transmission

Cloud ALM Instance Default Values

Configure the following parameters in the default values of the CLOUD_ALM instance:

Default Attribute	Default Attribute Value
AUTH_TYPE	OAUTH
CLIENT_ID	<client_id>
TOKEN_DESTINATION	CLOUD_ALM_METRICS_TOKEN

Create Cloud ALM Instance for Logs Endpoint

Create a new Cloud ALM instance with the RFC destination CLOUD_ALM_LOGS_API and the default values as shown below.