AIX SAP
AIX SAP input collects SAP instance processes, queue, enqueue, and advanced metrics through sapcontrol.
Configuration¶
[inputs]
# Global switch for middleware inputs.
enabled = true
[[inputs.sap]]
# Instance name, reported as the `instance` tag.
name = "sap00"
# Whether to enable this SAP instance collection.
enabled = true
# Collection interval.
interval = "60s"
# Optional file loaded before collection to set instance environment variables.
env_file = ""
# Whether to collect advanced metrics such as work process, alert, and instance metrics.
collect_advanced = false
# Optional custom metric command. Each output line should be `key=value`.
deep_metrics_command = ""
# SAP instance number.
instance_number = "00"
# sapcontrol command path.
sapcontrol = "sapcontrol"
Command Dependencies¶
| Command | Description |
|---|---|
sapcontrol -nr <nr> -function GetProcessList |
Collect instance process status. |
sapcontrol -nr <nr> -function GetQueueStatistic |
Collect queue statistics. |
sapcontrol -nr <nr> -function GetEnqueueStatistic |
Collect enqueue statistics. |
sapcontrol -nr <nr> -function ABAPGetWPTable |
Collect work processes when collect_advanced = true. |
sapcontrol -nr <nr> -function GetAlerts |
Collect alerts when collect_advanced = true. |
sapcontrol -nr <nr> -function GetSystemInstanceList |
Collect the system instance list when collect_advanced = true. |
deep_metrics_command |
Custom command that outputs key=value lines for custom metrics. |
Metrics¶
All metrics append host, input=sap, and instance=<name> tags.
sap¶
| Tags & Fields | Description |
|---|---|
| instance_number ( tag) |
SAP instance number. |
| up | Whether a running process exists. Type: int | (gauge) |
| running_processes | Number of running processes. Type: int | (gauge) Unit: count |
| stopped_processes | Number of stopped processes. Type: int | (gauge) Unit: count |
sap_queue¶
| Tags & Fields | Description |
|---|---|
| instance_number ( tag) |
SAP instance number. |
| queue_length | Current queue length. Type: int/float | (gauge) Unit: count |
| queue_high | Queue high-water mark. Type: int/float | (gauge) Unit: count |
| queue_max | Queue maximum. Type: int/float | (gauge) Unit: count |
| queue_writes | Queue write count. Type: int/float | (count) Unit: count |
| queue_reads | Queue read count. Type: int/float | (count) Unit: count |
sap_enqueue¶
| Tags & Fields | Description |
|---|---|
| instance_number ( tag) |
SAP instance number. |
| enqueue_locks | Enqueue lock count. Type: int/float | (gauge) Unit: count |
| enqueue_waits | Enqueue wait count. Type: int/float | (count) Unit: count |
| enqueue_errors | Enqueue error count. Type: int/float | (count) Unit: count |
| enqueue_high | Enqueue high-water mark. Type: int/float | (gauge) Unit: count |
| enqueue_max | Enqueue maximum. Type: int/float | (gauge) Unit: count |
| used_pct | Usage percentage. Type: float | (gauge) Unit: percent |
sap_work_process¶
| Tags & Fields | Description |
|---|---|
| instance_number ( tag) |
SAP instance number. |
| wp_type ( tag) |
Work process type. |
| count | Work process count. Type: int | (gauge) Unit: count |
| running | Running work process count. Type: int | (gauge) Unit: count |
| waiting | Waiting work process count. Type: int | (gauge) Unit: count |
| held | Held work process count. Type: int | (gauge) Unit: count |
| stopped | Stopped work process count. Type: int | (gauge) Unit: count |
| errors | Error work process count. Type: int | (gauge) Unit: count |
sap_alert¶
| Tags & Fields | Description |
|---|---|
| instance_number ( tag) |
SAP instance number. |
| severity ( tag) |
Alert severity. |
| count | Number of alerts at the current severity. Type: int | (gauge) Unit: count |
sap_instance¶
| Tags & Fields | Description |
|---|---|
| instance_number ( tag) |
SAP instance number. |
| instance ( tag) |
SAP system instance name. |
| hostname ( tag) |
Instance hostname. |
| host ( tag) |
Instance host. |
| dispstatus ( tag) |
Instance status. |
| features ( tag) |
Instance feature list. |
| instance_nr | Instance number. Type: int | (gauge) |
| http_port | HTTP port. Type: int | (gauge) |
| https_port | HTTPS port. Type: int | (gauge) |
| start_priority | Start priority. Type: int | (gauge) |
| up | Whether the instance is running. Type: int | (gauge) |
Custom Metrics¶
Custom metric fields are determined by deep_metrics_command output. Fields listed in the table are used as tags; numeric values in other key=value pairs are reported as int/float | (gauge) fields, and non-numeric values are reported as tags. If no numeric field exists, count=1 is added with unit count.
| Measurement | Tags | Description |
|---|---|---|
sap_st03 |
metric, task_type, unit |
Custom ST03 metrics. |
sap_stad |
transaction, user, client |
Custom STAD metrics. |
sap_ccms |
node, severity, class |
Custom CCMS metrics. |
sap_deep_metric |
metric, unit |
Generic SAP custom metrics. |