Supported metrics
The Access Gateway /metrics REST API Endpoint returns metrics about these items:
- Cluster metrics
- CPU usage metrics
- Disk and file system usage
- Access Gateway engine metrics
- Input and output metrics
- Memory usage metrics
- Network usage metrics
- Memory swap usage
The following tables are a partial list of data returned by the metrics monitoring subsystem. For a complete list, run this curl command:
curl http://{access gateway host}:8889/metrics | grep OAG_Cluster metrics
| Field | Type | Description | Sample |
|---|---|---|---|
| OAG_ha_worker_node_number_master | Gauge | The total number of worker nodes in a high-availability cluster | OAG_ha_worker_node_number_master.2 |
| OAG_ha_last_sync_timestamp_worker[1-N].okta.com | Gauge | The last time this worker synched its configuration with the admin node. | OAG_ha_last_sync_timestamp_worker1.okta.com 2021-07-13T17:14:30.245111414-050 OAG_ha_last_sync_timestamp_worker2.okta.com 2021-07-13T17:14:30.245111414-050 . . . |
| OAG_autoupdate_cluster_status | Gauge | The status of the last update of the cluster. |
OAG_autoupdate_cluster_status 1 Status codes:
|
| OAG_autoupdate_seconds_since_last_update | Gauge | The time in seconds since the last update. | OAG_autoupdate_cluster_seconds_since_last_update 3600 |
| OAG_autoupdate_{node}_status | Gauge | The status of the last update for a particular node. |
OAG_autoupdate_worker1_status 0 Status codes:
|
CPU usage metrics
| Field | Type | Description | Sample |
|---|---|---|---|
| OAG_node_cpu_guest_seconds_total | Counter | The number of seconds that the CPUs spent in guests (VMs) for each mode (idle, iowait, irg, nice, softirq, steal, system, user). | OAG_node_cpu_guest_seconds_total{cpu="0",mode="nice"} 0 OAG_node_cpu_guest_seconds_total{cpu="0",mode="user"} 0 |
| OAG_node_cpu_seconds_total Seconds | Counter | CPU seconds spent in each mode (idle, iowait, irg, nice, softirq, steal, system, user). | OAG_node_cpu_seconds_total {cpu="0",mode="idle"} 107901.23000000001 |
| OAG_process_cpu_seconds_total | Counter | The total user and system CPU time spent in seconds. | OAG_process_cpu_seconds_total 1609.11 |
Disk and file system usage
Disk
| Field | Type | Description | Sample |
|---|---|---|---|
| OAG_node_disk_write_time_seconds_total | Counter | The total number of seconds spent on all write operations. | OAG_node_disk_write_time_seconds_total{device="sda"} 263.004 |
| OAG_node_disk_io_now | Gauge | The number of inputs and outputs (I/Os) currently in progress. | OAG_node_disk_io_now{device="sda"} 0 |
| OAG_node_disk_read_bytes_total | Counter | The total number of bytes read successfully. | OAG_node_disk_read_bytes_total {device="sda"} 3.2292334592e+10 |
| OAG_node_disk_writes_completed_total | Counter | The total number of writes completed successfully. | OAG_node_disk_writes_completed_total{device="sda"} 462522 |
File system
| Field | Type | Description | Sample |
|---|---|---|---|
| OAG_node_filesystem_avail_bytes | Gauge | The number of bytes currently available for the given device. | OAG_node_filesystem_avail_bytes {device="/dev/sda1",fstype= "xfs",mountpoint="/boot"} 8.90068992e+08 |
| OAG_node_filesystem_device_error | Gauge | The current errors for the given device. | OAG_node_filesystem_device_error{device="/dev/sda1",fstype ="xfs",mountpoint="/boot"} 0 |
| OAG_node_filesystem_files | Gauge | The current total number of files in use for the given device. | OAG_node_filesystem_files {device="/dev/sda1",fstype ="xfs",mountpoint="/boot"} 524288 |
| OAG_node_filesystem_files_free | Gauge | The current number of free files for the given device. | OAG_node_filesystem_files_free {device="/dev/sda1",fstype ="xfs",mountpoint="/boot"} 523986 |
| OAG_node_filesystem_free_bytes | Gauge | The current number of free bytes for the given device. | OAG_node_filesystem_free_bytes {device="/dev/sda1",fstype ="xfs",mountpoint="/boot"} 8.90068992e+08 |
| OAG_node_filesystem_readonly | Gauge | The read-only indicator for a given device. | OAG_node_filesystem_readonly {device="/dev/sda1",fstype ="xfs",mountpoint="/boot"} 0 |
| OAG_node_filesystem_size_bytes | Gauge | Size, in bytes, of the given device. | OAG_node_filesystem_size_bytes {device="/dev/sda1",fstype ="xfs",mountpoint="/boot"} 1.063256064e+09 |
Access Gateway engine metrics
| Field | Type | Description | Sample |
|---|---|---|---|
| OAG_nginx_accepted_connections | Gauge | The total number of accepted client connections. | OAG_nginx_accepted_connections 1872 |
| OAG_nginx_active_connections | Gauge | The current number of active client connections, including waiting connections. | OAG_nginx_active_connections 1 |
| OAG_nginx_handled_connections | Gauge | The total number of handled connections. | OAG_nginx_handled_connections 1872 |
| OAG_nginx_reading_number | Gauge | The current number of connections where NGINX is reading the request header. | OAG_nginx_reading_number 0 |
| OAG_nginx_requests_number | Gauge | The total number of client requests. | OAG_nginx_requests_number 1872 |
| OAG_nginx_waiting_number | Gauge | The current number of idle client connections waiting for a request. | OAG_nginx_waiting_number 1 |
| OAG_nginx_writing_number | Gauge | The current number of connections where NGINX is writing the response back to the client. | OAG_nginx_writing_number 1 |
Input and output metrics
| Field | Type | Description | Sample |
|---|---|---|---|
| OAG_node_disk_io_now | Gauge | The number of I/Os currently in progress. | OAG_node_disk_io_now{device="sda"} 0 |
| OAG_node_disk_read_bytes_total | Counter | The total number of bytes read successfully for the given device. | OAG_node_disk_read_bytes_total {device="dm-0"} 4.544185344e+09 |
| OAG_node_disk_reads_completed_total | Counter | The total number of reads completed successfully. | OAG_node_disk_reads_completed_total {device="sda"} 794780 |
| OAG_node_disk_written_bytes_total | Counter | The total number of bytes written successfully. | OAG_node_disk_written_bytes_total {device="dm-0"} 6.45924352e+08 |
| OAG_node_disk_write_time_seconds_total | Counter | The total number of seconds spent by all writes. | OAG_node_disk_write_time_seconds_total {device="sda"} 263.004 |
Memory usage metrics
| Field | Type | Description | Sample |
|---|---|---|---|
| OAG_node_memory_MemTotal_bytes | Gauge | The total amount of memory in bytes. | OAG_node_memory_MemTotal_bytes 8.50817024e+08 |
| OAG_node_memory_MemAvailable_bytes | Gauge | The total amount of memory available in bytes. | node_memory_MemAvailable_bytes 3.12557568e+08 |
Network usage metrics
| Field | Type | Description | Sample |
|---|---|---|---|
| OAG_node_network_up | Gauge | The value is 1 if it's up, and 0 if it's down. | OAG_node_network_up{device="eth0"} 1 |
| OAG_node_network_receive_drop_total | Counter | The number of bytes dropped by the receiver, by device. | OAG_node_network_receive_drop_total {device="eth0"} 0 |
| OAG_node_network_receive_errs_total | Counter | The number of receive errors, by device. | OAG_node_network_receive_errs_total {device="eth0"} 0 |
| OAG_node_network_receive_bytes_total | Counter | The total number of bytes received, by device. | OAG_node_network_receive_bytes_total {device="eth0"} 2.67075139e+08 |
| OAG_node_network_info | Gauge | Data from /sys/class/net/<iface>. The value is always 1. | OAG_node_network_info {address="00:0c:29:21:07:37",broadcast ="ff:ff:ff:ff:ff:ff",device="eth0", duplex="full",ifalias="",operstate="up"} 1 |
Memory swap usage
| Field | Type | Description | Sample |
|---|---|---|---|
| OAG_node_memory_SwapCached_bytes | Gauge | The amount of memory in the swap cache, in bytes. | OAG_node_memory_SwapCached_bytes 6.5548288e+07 |
| OAG_node_memory_SwapFree_bytes | Gauge | The amount of free memory in the memory swap, in bytes. | OAG_node_memory_SwapFree_bytes 1.595404288e+09 |
| OAG_node_memory_SwapTotal_bytes | Gauge | The total amount of memory allocated to the memory swap, in bytes. | OAG_node_memory_SwapTotal_bytes 2.147479552e+09 |