This document describes the metrics exposed by sap_host_exporter
.
General notes:
- All the metrics are namespaced with the prefix
sap
, which is followed by a subsystem, and both are in turn composed into a Fully Qualified Name (FQN) of each metrics. - All the metrics and labels names are in snake_case, as conventional with Prometheus. That said, as much as we'll try to keep this consistent throughout the project, the label values may not actually follow this convention, though (e.g. label is a hostname).
These are the currently implemented subsystems.
The Start Service subsystem collects generic host-related metrics.
The SAP instances in the context of the whole SAP system.
The value of this metric follows the SAP state colors convention.
start_priority
: the instance start priorityfeatures
: a pipe-separated (|
) list of features running in the instance
e.g.ABAP|GATEWAY|ICMAN|IGS
# TYPE sap_start_service_instances gauge
sap_start_service_instances{features="MESSAGESERVER|ENQUE",hostname="sapha1as",instance_number="0",start_priority="1"} 2
sap_start_service_instances{features="ENQREP",hostname="sapha1er",instance_number="10",start_priority="0.5"} 2
sap_start_service_instances{features="ABAP|GATEWAY|ICMAN|IGS",hostname="sapha1pas",instance_number="1",start_priority="3"} 2
sap_start_service_instances{features="ABAP|GATEWAY|ICMAN|IGS",hostname="sapha1aas",instance_number="2",start_priority="3"} 2
The processes started by the SAP Start Service.
The value of this metric follows the SAP state colors convention.
name
: the name of the process.pid
: the PID of the process.status
: a textual status of the process, e.g.Running
The total number of lines for this metric will be the cardinality of pid
.
# TYPE sap_start_service_processes gauge
sap_start_service_processes{name="enserver",pid="30787",status="Stopping"} 3
sap_start_service_processes{name="msg_server",pid="30786",status="Running"} 2
The Enqueue Server (also known as the lock server) is the SAP system component that manages the lock table.
sap_enqueue_server_arguments_high
sap_enqueue_server_arguments_max
sap_enqueue_server_arguments_now
sap_enqueue_server_arguments_state
sap_enqueue_server_backup_requests
sap_enqueue_server_cleanup_requests
sap_enqueue_server_dequeue_all_requests
sap_enqueue_server_dequeue_errors
sap_enqueue_server_dequeue_requests
sap_enqueue_server_enqueue_errors
sap_enqueue_server_enqueue_rejects
sap_enqueue_server_enqueue_requests
sap_enqueue_server_lock_time
sap_enqueue_server_lock_wait_time
sap_enqueue_server_locks_high
sap_enqueue_server_locks_max
sap_enqueue_server_locks_now
sap_enqueue_server_locks_state
sap_enqueue_server_owner_high
sap_enqueue_server_owner_max
sap_enqueue_server_owner_now
sap_enqueue_server_owner_state
sap_enqueue_server_replication_state
sap_enqueue_server_reporting_requests
sap_enqueue_server_server_time
Peak number of different lock arguments that have been stored simultaneously in the lock table.
# TYPE sap_enqueue_server_arguments_high counter
sap_enqueue_server_arguments_high 104
Maximum number of lock arguments that can be stored in the lock table.
# TYPE sap_enqueue_server_arguments_max counter
sap_enqueue_server_arguments_max 56415
Current number of lock arguments in the lock table.
# TYPE sap_enqueue_server_arguments_now gauge
sap_enqueue_server_arguments_now 0
General state of lock arguments.
Refer to the appendix to know more about the possible values of this metric.
# TYPE sap_enqueue_server_arguments_state gauge
sap_enqueue_server_arguments_state 2
Number of requests forwarded to the update process.
# TYPE sap_enqueue_server_backup_requests counter
sap_enqueue_server_backup_requests 0
Requests to release of all the locks of an application server.
# TYPE sap_enqueue_server_cleanup_requests counter
sap_enqueue_server_cleanup_requests 4
Requests to release of all the locks of an LUW.
# TYPE sap_enqueue_server_dequeue_all_requests counter
sap_enqueue_server_dequeue_all_requests 150372
Lock release errors.
# TYPE sap_enqueue_server_dequeue_errors counter
sap_enqueue_server_dequeue_errors 0
Lock release requests.
# TYPE sap_enqueue_server_dequeue_requests counter
sap_enqueue_server_dequeue_requests 85213
Lock acquisition errors
# TYPE sap_enqueue_server_enqueue_errors counter
sap_enqueue_server_enqueue_errors 0
Rejected lock requests.
# TYPE sap_enqueue_server_enqueue_rejects counter
sap_enqueue_server_enqueue_rejects 4
Lock acquisition requests.
# TYPE sap_enqueue_server_enqueue_requests counter
sap_enqueue_server_enqueue_requests 109408
Total time spent in lock operations.
# TYPE sap_enqueue_server_lock_time counter
sap_enqueue_server_lock_time 174.574351
Total waiting time of all work processes for accessing lock table.
# TYPE sap_enqueue_server_lock_wait_time counter
sap_enqueue_server_lock_wait_time 0
Peak number of elementary locks that have been stored simultaneously in the lock table.
# TYPE sap_enqueue_server_locks_high counter
sap_enqueue_server_locks_high 104
Maximum number of elementary locks that can be stored in the lock table.
# TYPE sap_enqueue_server_locks_max gauge
sap_enqueue_server_locks_max 56415
Current number of elementary locks in the lock table.
# TYPE sap_enqueue_server_locks_now gauge
sap_enqueue_server_locks_now 0
General state of elementary locks.
Refer to the appendix to know more about the possible values of this metric.
# TYPE sap_enqueue_server_locks_state gauge
sap_enqueue_server_locks_state 2
Peak number of lock owners that have been stored simultaneously in the lock table.
# TYPE sap_enqueue_server_owner_high counter
sap_enqueue_server_owner_high 5
Maximum number of lock owner IDs that can be stored in the lock table.
# TYPE sap_enqueue_server_owner_max gauge
sap_enqueue_server_owner_max 56415
Current number of lock owners in the lock table.
# TYPE sap_enqueue_server_owner_now gauge
sap_enqueue_server_owner_now 0
General state of lock owners.
Refer to the appendix to know more about the possible values of this metric.
# TYPE sap_enqueue_server_owner_state gauge
sap_enqueue_server_owner_state 2
General state of lock server replication.
Refer to the appendix to know more about the possible values of this metric.
# TYPE sap_enqueue_server_replication_state gauge
sap_enqueue_server_replication_state 2
Number of reading operations on the lock table.
# TYPE sap_enqueue_server_reporting_requests counter
sap_enqueue_server_reporting_requests 0
Total time spent in lock operations by all processes in the enqueue server
# TYPE sap_enqueue_server_server_time counter
sap_enqueue_server_server_time 0
The Application Server Dispatcher is the component that manages the Work Process queues. We collect a set of queue stats for each type of Work Process queue.
sap_dispatcher_queue_now
sap_dispatcher_queue_high
sap_dispatcher_queue_max
sap_dispatcher_queue_writes
sap_dispatcher_queue_reads
Work process current queue length
type
: the type of the work queue.
# TYPE sap_dispatcher_queue_now gauge
sap_dispatcher_queue_now{type="ABAP/BTC"} 0
sap_dispatcher_queue_now{type="ABAP/DIA"} 0
sap_dispatcher_queue_now{type="ABAP/ENQ"} 0
sap_dispatcher_queue_now{type="ABAP/NOWP"} 0
sap_dispatcher_queue_now{type="ABAP/SPO"} 0
sap_dispatcher_queue_now{type="ABAP/UP2"} 0
sap_dispatcher_queue_now{type="ABAP/UPD"} 0
sap_dispatcher_queue_now{type="ICM/Intern"} 0
Work process highest queue length
type
: the type of the work queue.
# TYPE sap_dispatcher_queue_high counter
sap_dispatcher_queue_high{type="ABAP/BTC"} 2
sap_dispatcher_queue_high{type="ABAP/DIA"} 5
sap_dispatcher_queue_high{type="ABAP/ENQ"} 0
sap_dispatcher_queue_high{type="ABAP/NOWP"} 3
sap_dispatcher_queue_high{type="ABAP/SPO"} 1
sap_dispatcher_queue_high{type="ABAP/UP2"} 1
sap_dispatcher_queue_high{type="ABAP/UPD"} 2
sap_dispatcher_queue_high{type="ICM/Intern"} 1
Work process maximum queue length
type
: the type of the work queue.
# TYPE sap_dispatcher_queue_max gauge
sap_dispatcher_queue_max{type="ABAP/BTC"} 14000
sap_dispatcher_queue_max{type="ABAP/DIA"} 14000
sap_dispatcher_queue_max{type="ABAP/ENQ"} 14000
sap_dispatcher_queue_max{type="ABAP/NOWP"} 14000
sap_dispatcher_queue_max{type="ABAP/SPO"} 14000
sap_dispatcher_queue_max{type="ABAP/UP2"} 14000
sap_dispatcher_queue_max{type="ABAP/UPD"} 14000
sap_dispatcher_queue_max{type="ICM/Intern"} 6000
Work process queue writes
type
: the type of the work queue.
# TYPE sap_dispatcher_queue_writes counter
sap_dispatcher_queue_writes{type="ABAP/BTC"} 11229
sap_dispatcher_queue_writes{type="ABAP/DIA"} 479801
sap_dispatcher_queue_writes{type="ABAP/ENQ"} 0
sap_dispatcher_queue_writes{type="ABAP/NOWP"} 267333
sap_dispatcher_queue_writes{type="ABAP/SPO"} 41171
sap_dispatcher_queue_writes{type="ABAP/UP2"} 3743
sap_dispatcher_queue_writes{type="ABAP/UPD"} 3746
sap_dispatcher_queue_writes{type="ICM/Intern"} 37426
Work process queue reads.
type
: the type of the work queue.
# TYPE sap_dispatcher_queue_reads counter
sap_dispatcher_queue_reads{type="ABAP/BTC"} 11229
sap_dispatcher_queue_reads{type="ABAP/DIA"} 479801
sap_dispatcher_queue_reads{type="ABAP/ENQ"} 0
sap_dispatcher_queue_reads{type="ABAP/NOWP"} 267333
sap_dispatcher_queue_reads{type="ABAP/SPO"} 41171
sap_dispatcher_queue_reads{type="ABAP/UP2"} 3743
sap_dispatcher_queue_reads{type="ABAP/UPD"} 3746
sap_dispatcher_queue_reads{type="ICM/Intern"} 37426
The value of *_state
metrics is an integer status code that maps to the conventional SAP color-coded names as follows:
1
:GRAY
.2
:GREEN
.3
:YELLOW
.4
:RED
.
The following labels are shared among all the metrics.
SID
: the SAP System ID.instance_name
: the SAP instance name.instance_hostname
: the SAP instance virtual hostname. Note, this may differ from the actual hostname of the instance host.instance_number
: the SAP instance number,