Supported Keys and Macros¶

This section provides a comprehensive list of both system-wide and tenant-specific item keys supported by the SAP HANA plugin.

System-Level Keys¶

sap.hana.cpu¶

Returns system-wide CPU utilization metrics for the HANA host. This is a master item that collects all CPU states in a single request.

Parameters:

Name	Description
common_params	Connection string (URI or Session), username and password.

Returns:

JSON object containing:
- cpu_user_time: Percentage of CPU spent in user mode.
- cpu_system_time: Percentage of CPU spent in system/kernel mode.
- cpu_idle_time: Percentage of idle CPU.
- cpu_waitio_time: Percentage of CPU waiting for I/O operations.

sap.hana.memory¶

Returns system-wide memory utilization for the HANA host and instance processes.

Parameters:

Name	Description
common_params	Connection details.

Returns:

JSON object containing:
- allocation_limit: Total memory limit for the instance.
- instance_memory_used: Memory currently used by instance processes.
- instance_memory_allocated: Memory pool allocated for instance processes.
- physical_memory_free: Free physical memory on the host.
- swap_space_used: Used swap space on the host.

sap.hana.storage¶

Returns storage utilization metrics for the HANA host paths.

Parameters:

Name	Description	Default
common_params	Connection details.
mode	Operation mode.	(empty)

Returns:

If mode is empty: JSON array with usage stats for all paths.
If mode is discovery: LLD JSON array containing {#STORAGE.PATH} and {#STORAGE.SOURCE} macros.

sap.hana.network¶

Returns host-wide network performance statistics.

Parameters:

Name	Description
common_params	Connection details.

Returns:

JSON object containing:
- network_sent: Total packets sent.
- network_received: Total packets received.
- network_retransmitted: Count of retransmitted segments.
- network_bad: Count of bad segments received.

sap.hana.license¶

Retrieves information about the SAP HANA database license installed on the instance.

Parameters:

Name	Description
common_params	Connection details.

Returns:

JSON object containing:
- product_name: Name of the licensed product.
- expiration_date: License expiry timestamp.
- product_limit: Memory limit imposed by the license.
- product_usage: Peak memory usage recorded.
- valid: Boolean status of the license.

sap.hana.version¶

Retrieves the full database software version string.

Parameters:

Name	Description
common_params	Connection details.

Returns:

String value (e.g., 2.00.061.00.1644229047).

sap.hana.plugin.license¶

Returns the current status of the plugin license.

Returns:

JSON object containing:
- state: License status (e.g., VALID, EXPIRED, NOT_FOUND).
- expiry: License expiration timestamp in Unix format.
- message: Detailed status or error message.

Tenant-Level Keys¶

sap.hana.db.discovery¶

Discovers all tenant databases running in the SAP HANA instance.

License Required

A valid license key is required to enable tenant database discovery.

Parameters:

Name	Description
common_params	Connection details.

Returns:

LLD JSON format containing:
- {#DBNAME}: Name of the tenant database.
- {#DBHOST}: Hostname where the database is running.
- {#DBURI}: Connection URI.
- {#DBUSER}: Configured monitoring user.
- {#DBPASS}: Password macro for the user.

sap.hana.db.ping¶

Tests if a connection to a specific tenant database is alive.

Parameters:

Name	Description	Default
common_params	Connection details.
database	Name of the tenant database.	`SYSTEMDB`

Returns:

1 — Database is alive and reachable.
0 — Database is broken or unreachable.

sap.hana.db.uptime¶

Returns the uptime of the specified tenant database.

License Required

A valid license key is required to retrieve tenant uptime metrics.

Parameters:

Name	Description
common_params	Connection details.
database	Target tenant database.

Returns:

Integer value in seconds.

sap.hana.db.size¶

Returns the total data and log size of the specified tenant database.

License Required

A valid license key is required to retrieve tenant database size metrics.

Parameters:

Name	Description
common_params	Connection details.
database	Target tenant database.

Returns:

Integer value in bytes.

sap.hana.db.memory¶

Returns detailed memory usage statistics for the specific tenant database.

License Required

A valid license key is required to retrieve detailed tenant memory statistics.

Parameters:

Name	Description
common_params	Connection details.
database	Target tenant database.

Returns:

JSON object containing resident memory, effective limit and peak usage for the tenant.

sap.hana.db.cpu¶

Returns CPU utilization metrics for the processes belonging to the specific tenant.

License Required

A valid license key is required to retrieve tenant CPU utilization metrics.

Parameters:

Name	Description
common_params	Connection details.
database	Target tenant database.

Returns:

Float value (Percentage).

sap.hana.db.alerts¶

Returns current alerts from the database statistics server for a specific tenant.

License Required

A valid license key is required to retrieve database alerts.

Parameters:

Name	Description	Default
common_params	Connection details.
database	Target tenant database.
discovery	If set to `discovery`, returns alert types for LLD.	(empty)

Returns:

JSON object containing alert counts and severity details.

sap.hana.db.backup¶

Returns metadata about the latest successful backups for the tenant.

License Required

A valid license key is required to retrieve backup metadata.

Parameters:

Name	Description	Accepted Values
common_params	Connection details.
database	Target tenant database.
type	Type of backup to query.	`data`, `log`, `snapshot`

Returns:

JSON object containing:
- backup_status: Status of the backup (e.g., successful).
- backup_duration: Duration in seconds.
- backup_size: Total size in bytes.
- backup_timestamp: Completion timestamp.

sap.hana.db.replication¶

Retrieves the status of the SAP HANA System Replication (HSR) for the specific tenant.

License Required

A valid license key is required to retrieve system replication status.

Parameters:

Name	Description
common_params	Connection details.
database	Target tenant database.
discovery	If set, returns discovery data for replication sites.

Returns:

JSON object with replication status (Primary/Secondary, Sync status).

sap.hana.db.volume¶

Returns I/O statistics and latency for volumes belonging to the tenant.

License Required

A valid license key is required to retrieve volume I/O statistics.

Parameters:

Name	Description	Accepted Values
common_params	Connection details.
database	Target tenant database.
type	Volume type.	`data`, `log`, `trace`

Returns:

JSON object with I/O throughput and latency metrics.

sap.hana.db.features¶

Returns information about the database features currently in use by the tenant.

License Required

A valid license key is required to retrieve database feature information.

Parameters:

Name	Description	Default
common_params	Connection details.
database	Target tenant database.
discovery	If set, returns feature list for LLD.	(empty)

Returns:

JSON object or LLD JSON array.

sap.hana.db.services¶

Returns the status and health of the database services (e.g., indexserver, nameserver) for the tenant.

License Required

A valid license key is required to retrieve database service status.

Parameters:

Name	Description	Default
common_params	Connection details.
database	Target tenant database.
discovery	If set, returns service list for LLD.	(empty)

Returns:

JSON object with service status and memory/CPU per service.

sap.hana.custom.query¶

Executes a custom SQL query defined in a .sql file on the plugin host.

License Required

A valid license key is required to enable custom SQL query execution.

Parameters:

Name	Description
common_params	Connection details.
database	Target tenant database.
query_name	Name of the file in `CustomQueriesPath` (without `.sql`).
query_params	(Optional) Positional parameters to pass to the SQL query.

Returns:

The result set of the query in JSON format.
Note: Requires the Plugins.SAPHANA.CustomQueriesPath to be configured and a valid plugin license.

Macros¶

Macro	Default Value	Description
`{$SAP.HANA.URI}`	`hdb://localhost:30013`	Connection URI for the instance.
`{$SAP.HANA.USER}`	`ZABBIX`	Monitoring user (requires appropriate grants).
`{$SAP.HANA.PASSWORD}`		Password for the monitoring user.