The **SAP Cloud ALM Health Monitoring** monitor retrieves health metrics from your SAP Cloud ALM tenant and publishes them into the monitoring system. It can also evaluate thresholds and raise alarms based on a selected measure per row.
Network connectivity from the collector to your SAP Cloud ALM tenant API endpoint (e.g. https://your-tenant.api.xxx.hana.ondemand.com).
The monitor requires a Web Service connector with authentication type CLOUD_ALM. SAP Cloud ALM Connector
This connector is based on a service key of the SAP Cloud ALM API service instance in the BTP subaccount that contains your Cloud ALM entitlement.
The following OAuth scopes must be included in the instance parameters (in the authorities list):
$XSMASTERAPPNAME.calm-api.hm.read$XSMASTERAPPNAME.calm-api.metrics.readEven if you already created a service key for the ALM connector, you do not need to delete the instance.
authorities array in the parameters JSON and save.| Endpoint | Purpose |
|---|---|
| POST /oauth/token | Authentication (BTP UAA) |
| GET /api/calm-metrics/v1/metrics?provider=hm | Retrieve health monitoring metrics |
The metrics endpoint is paged. The monitor reads all pages on every run. If any page fails, the run fails with the HTTP code and the API message, so that no partial data is published.
Each run reads the latest 5 minute bucket that has data. The monitor samples the state at run time, it does not replay the buckets between two runs. With a schedule longer than 5 minutes, a short peak between two runs is not seen. Keep the schedule at 5 or 10 minutes when the thresholds matter.
The monitor can collect and publish the following measures for Cloud ALM health metrics:
Only usage is published with the PERCENT unit. The other measures are published without a unit.
G2W:80 W2M:90 syntax. Multi Threshold Syntax*) for Metric, Service name and Attributes Filter, alone or inside a name, e.g. S4H* or *Workprocess*The monitor supports both global and row-level metric publishing:
When row-level publishing is used, Alarm on only selects the measure evaluated for alarms, it does not filter the published metrics.
To let a later row publish the datapoints of an earlier row that does not send them, disable Exclusive on the earlier row.
ABAP.Certificates, appear in the list but are present in the monitor run only during the 5 minutes after their collection. Alarms on them are not reliable at the default schedule* and/or Service name = * to monitor everything or a broad subset* can also be part of a name, for example Service name = S4H* or Metric = ABAP.*| Field | Description | Default |
|---|---|---|
| Active | Enable/disable this configuration row | true |
| Service name | Service to match, exact name or a pattern with * (see below) | * |
| Metric | Metric to match, exact name or a pattern with * (see below) | * |
| Attributes Filter | Optional filter applied to datapoint attributes before alarm evaluation / row matching, see below | (empty) |
| Alarm on | Which measure to evaluate for alarms (NONE / USAGE / VALUE / OK_STATUS / WARNING_STATUS / CRITICAL_STATUS) | USAGE |
| Thresholds | Multi-level thresholds (G2W / W2M / etc.) | G2W:80 W2M:90 |
| Alarm tag | Optional tag added to the alarm message | (empty) |
| Exclusive | If enabled, later rows do not alarm on the datapoints evaluated by this row and do not publish any datapoint matched by this row | true |
| Alarm | Enable/disable alarm creation for this row | true |
| Send metric | Publish every measure of the matching metrics for this row when Send all metrics is disabled | true |
| Send all metrics | Publish all returned metrics and measures globally | true |
Each run reads the latest bucket of every metric of every service in the tenant. For each metric, the active rows are tried in table order. A row applies to a datapoint when its three filters all match:
service.name resource attribute, or sap.service.name when the first is absent).ABAP.Workprocess.Usage.Wp_type=DIA, together with the resource attributes of its service.Service name and Metric take an exact name or a pattern. Comparison ignores case.
| Value | Meaning |
|---|---|
* or empty | Any name |
S4H.100 | Exactly this name |
S4H* | Names starting with S4H |
*PRD* | Names containing PRD |
ABAP.*.Usage | Names starting with ABAP. and ending with .Usage |
Without a * the name must match in full: PRD does not match S4H-PRD. A * at the start or at the end lifts that side; several * are allowed.
When a datapoint matches a row, the row evaluates its thresholds on the measure selected in Alarm on, publishes the datapoint when row-level publishing is active, and consumes it when Exclusive is enabled so that the rows below do not see it. For publishing, an Exclusive row hides every datapoint it matches from the rows below, also the measures it does not alarm on and also when its Send metric is disabled. A datapoint matched by no row is still published when Send all metrics is enabled, and never alarms.
The Attributes Filter is an optional rule used to narrow down which datapoints a row can match.
The filter is a comma separated list of clauses. All clauses must match for the datapoint to be used by the row.
| Clause | Meaning | Example |
|---|---|---|
name | The datapoint has the attribute, whatever its value | Wp_type |
name:value | The datapoint has the attribute with this exact value | Wp_type:DIA |
* | No restriction, same as an empty filter | * |
name:* | The datapoint has the attribute, whatever its value, same as name | Wp_type:* |
name:val* | * inside a name or a value matches any part of it, as in the Metric column | Wp_type:DI*, *type:DIA |
A malformed clause, such as a missing name or value around the colon, is ignored and logged; the other clauses still apply, and a filter with no valid clause matches everything. Attribute names and values are compared without regard to case. Resource attributes such as service.name can be used as well as datapoint attributes.
When you use Load ALM Health Metrics, the Attributes Filter column of the loaded rows lists the attribute names available for each metric, for example Wp_type or Client. Loaded as is, such a filter only requires the attributes to be present. Add :value to a name to restrict the row to one value.
It checks the datapoint’s attributes before the row is used for:
All metrics are stored with the base key:
promonitor.cloud_alm.hm.*
Supported metric keys include:
| Metric Key | Unit | Description | Tags |
|---|---|---|---|
promonitor.cloud_alm.hm.<metric>.usage | % | Current utilization percentage | service.name, sap.service.name, service.namespace, service.instance.id, sap.service.display_name, plus datapoint-specific tags |
promonitor.cloud_alm.hm.<metric>.value | - | Current measured value | same as above |
promonitor.cloud_alm.hm.<metric>.limit | - | Configured limit | same as above |
promonitor.cloud_alm.hm.<metric>.okstatus | - | OK status datapoint | same as above |
promonitor.cloud_alm.hm.<metric>.warningstatus | - | Warning status datapoint | same as above |
promonitor.cloud_alm.hm.<metric>.criticalstatus | - | Critical status datapoint | same as above |
The displayed metric name in the UI is:
<metric> (usage), <metric> (value), <metric> (limit), <metric> (okStatus), <metric> (warningStatus), or <metric> (criticalStatus)
G2W:1, which fires as soon as any time was spent in that status. OK_STATUS is 100 when the service is fine, so a threshold on it cannot detect a failure[Tags: Wp_type=DIA]No rows needed. Empty table = publish everything. Send all metrics = true by default.
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | * | * | (empty) | USAGE | G2W:80 W2M:90 | (empty) | true | true | true |
Alarms when usage crosses 80% on any metric for any service.
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | S4H.100 | * | (empty) | USAGE | G2W:80 W2M:90 | (empty) | true | true | true |
Only datapoints for S4H.100 are evaluated. Other services not matched.
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | S4H.100 | ABAP.Workprocess.Usage | (empty) | USAGE | G2W:70 W2M:85 | WP_OVERLOAD | true | true | true |
Stricter threshold for work process usage only. Other metrics for S4H.100 not matched by this row.
The ABAP.Workprocess.Usage metric returns one datapoint per Wp_type (DIA BTC UPD UP2 SPO). Use Attributes Filter to target dialog processes only.
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | S4H.100 | ABAP.Workprocess.Usage | Wp_type:DIA | USAGE | G2W:70 W2M:85 | (empty) | true | true | true |
Only datapoints where Wp_type = DIA are evaluated. Batch and update processes not alarmed.
ABAP.ShortDumps.Today returns one datapoint per Client. To alarm only on client 100:
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | S4H.100 | ABAP.ShortDumps.Today | Client:100 | VALUE | G2W:50 W2M:200 | DUMPS_100 | true | true | true |
Alarm on = VALUE because this metric has no usage percentage. Threshold is a raw count.
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | S4H.100 | ABAP.Batchjobs.Aborted | Client:100 | VALUE | G2W:1 W2M:5 | BTC_ABORT | true | true | true |
Alarms as soon as 1 aborted job appears in client 100. G2W:1 means any non-zero value triggers warning.
Hana.Disk.Usage returns one datapoint per Usagetype (DATA LOG TRACE DATA_BACKUP etc.).
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | S4H.100 | Hana.Disk.Usage | Usagetype:DATA | VALUE | G2W:300 W2M:400 | HANA_DISK | true | true | true |
Value is in GB. Threshold is a raw size. Adjust to your disk capacity.
ABAP.ResponseTime returns one datapoint per Tasktype (RFC Batch Update). To alarm on slow batch jobs:
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | S4H.100 | ABAP.ResponseTime | Tasktype:Batch | VALUE | G2W:2000 W2M:5000 | SLOW_BTC | true | true | true |
Value is in ms. G2W:2000 = warning above 2 seconds. W2M:5000 = major above 5 seconds.
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | * | * | (empty) | USAGE | G2W:80 W2M:90 | (empty) | true | true | false |
Send metric = false and Send all metrics disabled: alarms fire but no datapoints written to time-series.
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | S4H.100 | ABAP.Workprocess.Usage | (empty) | USAGE | G2W:70 W2M:85 | S4H_PROD | true | true | true |
| true | * | ABAP.Workprocess.Usage | (empty) | USAGE | G2W:80 W2M:95 | (empty) | true | true | true |
Row 1 consumes S4H.100 datapoints (Exclusive = true). Row 2 applies a looser threshold to all other services.
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | *PRD* | * | (empty) | USAGE | G2W:70 W2M:85 | PROD | true | true | true |
| true | * | * | (empty) | USAGE | G2W:85 W2M:95 | (empty) | true | true | true |
Row 1 matches every service whose name contains PRD. Row 2 handles the other services with a looser threshold.
DataCollector.Version and ABAP.Version are informational metrics that report 0 and should not alarm.
| Active | Service name | Metric | Attributes Filter | Alarm on | Thresholds | Alarm tag | Exclusive | Alarm | Send metric |
|---|---|---|---|---|---|---|---|---|---|
| true | * | DataCollector.Version | (empty) | NONE | G2W:80 W2M:90 | (empty) | true | false | false |
| true | * | ABAP.Version | (empty) | NONE | G2W:80 W2M:90 | (empty) | true | false | false |
| true | * | * | (empty) | USAGE | G2W:80 W2M:90 | (empty) | true | true | true |
Rows 1 and 2 consume the version metrics (Exclusive = true, Alarm = false, Send metric = false). Row 3 handles everything else.