YugabyteDB account ID.

YugabyteDB project ID.

Access token for the YugabyteDB API.

Sets the HTTP proxy value. If this macro is empty, then no proxy is used.

Get raw data about clusters.

Item for gathering all the cluster item errors.

Preprocessing

• JSON Path: $.error

  ⛔️Custom on fail: Discard value

• Discard unchanged with heartbeat: 12h

Failed to fetch data about cluster.

Discovery of the available clusters.

Preprocessing

• JavaScript: The text is too long. Please see the template.

• Discard unchanged with heartbeat: 1d

Name of cluster.

ID of cluster.

The percentage of memory use on the cluster - for the Warning trigger expression.

The percentage of memory use on the cluster - for the High trigger expression.

The percentage of disk use in the cluster - for the Warning trigger expression.

The percentage of disk use in the cluster - for the High trigger expression.

The percentage of connections in the cluster - for the Warning trigger expression.

The percentage of connections in the cluster - for the High trigger expression.

The threshold of CPU utilization for the High trigger expression, expressed in percent.

The threshold of CPU utilization for the Warning trigger expression, expressed in percent.

The percentage of IOPS use on the node - for the Warning trigger expression.

The percentage of IOPS use on the node - for the High trigger expression.

Sets the HTTP proxy value. If this macro is empty, then no proxy is used.

Get raw data about clusters.

Item for gathering all the cluster item errors.

Preprocessing

• JSON Path: $.error

  ⛔️Custom on fail: Discard value

• Discard unchanged with heartbeat: 12h

Get raw data about keyspaces.

Item for gathering all the keyspace item errors.

Preprocessing

• JSON Path: $.error

  ⛔️Custom on fail: Discard value

• Discard unchanged with heartbeat: 12h

Get raw data about nodes.

Item for gathering all the node item errors.

Preprocessing

• JSON Path: $.error

  ⛔️Custom on fail: Discard value

• Discard unchanged with heartbeat: 12h

Getting metrics for the cluster.

Item for gathering all the cluster item errors.

Preprocessing

• JSON Path: $.error

  ⛔️Custom on fail: Discard value

• Discard unchanged with heartbeat: 12h

Getting SQL statistics for the cluster.

Item for gathering all the cluster query statistics item errors.

Preprocessing

• JSON Path: $.error

  ⛔️Custom on fail: Discard value

• Discard unchanged with heartbeat: 12h

The current state of the cluster. One of the following:

- INVALID

- QUEUED

- INIT

- BOOTSTRAPPING

- VPC_PEERING

- NETWORK_CREATING

- PROVISIONING

- CONFIGURING

- CREATING_LB

- UPDATING_LB

- ACTIVE

- PAUSING

- PAUSED

- RESUMING

- UPDATING

- MAINTENANCE

- RESTORE

- FAILED

- CREATE_FAILED

- DELETING

- STARTING_NODE

- STOPPING_NODE

- REBOOTING_NODE

- CREATE_READ_REPLICA_FAILED

- DELETE_READ_REPLICA_FAILED

- DELETE_CLUSTER_FAILED

- EDIT_CLUSTER_FAILED

- EDIT_READ_REPLICA_FAILED

- PAUSE_CLUSTER_FAILED

- RESUME_CLUSTER_FAILED

- RESTORE_BACKUP_FAILED

- CERTIFICATE_ROTATION_FAILED

- UPGRADE_CLUSTER_FAILED

- UPGRADE_CLUSTER_GFLAGS_FAILED

- UPGRADE_CLUSTER_OS_FAILED

- UPGRADE_CLUSTER_SOFTWARE_FAILED

- START_NODE_FAILED

- STOP_NODE_FAILED

- REBOOT_NODE_FAILED

- CONFIGURE_CMK

- ENABLING_CMK

- DISABLING_CMK

- UPDATING_CMK

- ROTATING_CMK

- STOPPING_METRICS_EXPORTER

- STARTING_METRICS_EXPORTER

- CONFIGURING_METRICS_EXPORTER

- STOP_METRICS_EXPORTER_FAILED

- START_METRICS_EXPORTER_FAILED

- CONFIGURE_METRICS_EXPORTER_FAILED

- REMOVING_METRICS_EXPORTER

- REMOVE_METRICS_EXPORTER_FAILED

Preprocessing

• JavaScript: The text is too long. Please see the template.

• Discard unchanged with heartbeat: 12h

The kind of cluster deployment: SYNCHRONOUS or GEO_PARTITIONED.

Preprocessing

• JSON Path: $.data.spec.cluster_info.cluster_type

• Replace: SYNCHRONOUS -> 0

• Replace: GEO_PARTITIONED -> 1

• Discard unchanged with heartbeat: 1d

How many nodes are in the cluster.

Preprocessing

• JSON Path: $.data.spec.cluster_info.num_nodes

• Discard unchanged with heartbeat: 12h

The current version of YugabyteDB installed on the cluster.

Preprocessing

• JSON Path: $.data.info.software_version

• Discard unchanged with heartbeat: 12h

The current version of the YB controller installed on the cluster.

Preprocessing

• JSON Path: $.data.info.ybc_version

• Discard unchanged with heartbeat: 12h

Current state regarding the health of the cluster:

- HEALTHY

- NEEDS_ATTENTION

- UNHEALTHY

- UNKNOWN

Preprocessing

• JavaScript: The text is too long. Please see the template.

• Discard unchanged with heartbeat: 12h

The percentage of CPU use being consumed by the tablet or master server Yugabyte processes, as well as other processes, if any.

Preprocessing

• JSON Path: $.metrics.CPU_USAGE

Shows the amount of disk space used by the cluster.

Preprocessing

• JSON Path: $.metrics.DISK_USAGE_GB

• Custom multiplier: 1073741824

Shows the amount of disk space provisioned for the cluster.

Preprocessing

• JSON Path: $.metrics.PROVISIONED_DISK_SPACE_GB

• Custom multiplier: 1073741824

• Discard unchanged with heartbeat: 1h

Shows the percentage of disk space used by the cluster.

The number of bytes being read from disk per second, averaged over each node.

Preprocessing

• JSON Path: $.metrics.DISK_BYTES_READ_MB_PER_SEC

• Custom multiplier: 1048576

The number of bytes being written to disk per second, averaged over each node.

Preprocessing

• JSON Path: $.metrics.DISK_BYTES_WRITTEN_MB_PER_SEC

• Custom multiplier: 1048576

The number of read operations per second.

Preprocessing

• JSON Path: $.metrics.READ_OPS_PER_SEC

The number of write operations per second.

Preprocessing

• JSON Path: $.metrics.WRITE_OPS_PER_SEC

The average latency of read operations at the tablet level.

Preprocessing

• JSON Path: $.metrics.AVERAGE_READ_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

The average latency of write operations at the tablet level.

Preprocessing

• JSON Path: $.metrics.AVERAGE_WRITE_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

The limit of the number of connections to the YSQL backend for all nodes.

Preprocessing

• JSON Path: $.metrics.YSQL_CONNECTION_LIMIT

• Discard unchanged with heartbeat: 12h

Cumulative number of connections to the YSQL backend for all nodes.

Preprocessing

• JSON Path: $.metrics.AVERAGE_YSQL_CONNECTION_COUNT

Cumulative number of connections to the YSQL backend for all nodes, expressed in percent.

Maximum of used connections to the YSQL backend for all nodes.

Preprocessing

• JSON Path: $.metrics.YSQL_MAX_CONNECTION_COUNT

The clock drift and skew across different nodes.

Preprocessing

• JSON Path: $.metrics.NODE_CLOCK_SKEW

• Custom multiplier: 0.001

  ⛔️Custom on fail: Discard value

Shows the amount of RAM provisioned to the cluster.

Preprocessing

• JSON Path: $.metrics.MEMORY_TOTAL_GB

• Custom multiplier: 1073741824

• Discard unchanged with heartbeat: 12h

Shows the amount of RAM used on the cluster.

Preprocessing

• JSON Path: $.metrics.MEMORY_USAGE_GB

• Custom multiplier: 1073741824

Shows the amount of RAM used on the cluster, expressed in percent.

The size of network packets received per second, averaged over nodes.

Preprocessing

• JSON Path: $.metrics.NETWORK_RECEIVE_BYTES_MB_PER_SEC

• Custom multiplier: 1048576

The size of network packets transmitted per second, averaged over nodes.

Preprocessing

• JSON Path: $.metrics.NETWORK_TRANSMIT_BYTES_MB_PER_SEC

• Custom multiplier: 1048576

The number of errors related to network packets received per second, averaged over nodes.

Preprocessing

• JSON Path: $.metrics.NETWORK_RECEIVE_ERRORS_PER_SEC

The number of errors related to network packets transmitted per second, averaged over nodes.

Preprocessing

• JSON Path: $.metrics.NETWORK_TRANSMIT_ERRORS_PER_SEC

The count of SELECT statements executed through the YSQL API per second. This does not include index writes.

Preprocessing

• JSON Path: $.metrics.YSQL_SELECT_OPS_PER_SEC

The count of DELETE statements executed through the YSQL API per second. This does not include index writes.

Preprocessing

• JSON Path: $.metrics.YSQL_DELETE_OPS_PER_SEC

The count of UPDATE statements executed through the YSQL API per second. This does not include index writes.

Preprocessing

• JSON Path: $.metrics.YSQL_UPDATE_OPS_PER_SEC

The count of INSERT statements executed through the YSQL API per second. This does not include index writes.

Preprocessing

• JSON Path: $.metrics.YSQL_INSERT_OPS_PER_SEC

The count of OTHER statements executed through the YSQL API per second.

Preprocessing

• JSON Path: $.metrics.YSQL_OTHER_OPS_PER_SEC

The count of transactions executed through the YSQL API per second.

Preprocessing

• JSON Path: $.metrics.YSQL_TRANSACTION_OPS_PER_SEC

Average time of executing SELECT statements through the YSQL API.

Preprocessing

• JSON Path: $.metrics.YSQL_SELECT_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

Average time of executing DELETE statements through the YSQL API.

Preprocessing

• JSON Path: $.metrics.YSQL_DELETE_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

Average time of executing UPDATE statements through the YSQL API.

Preprocessing

• JSON Path: $.metrics.YSQL_UPDATE_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

Average time of executing INSERT statements through the YSQL API.

Preprocessing

• JSON Path: $.metrics.YSQL_INSERT_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

Average time of executing OTHER statements through the YSQL API.

Preprocessing

• JSON Path: $.metrics.YSQL_OTHER_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

Average time of executing transactions through the YSQL API.

Preprocessing

• JSON Path: $.metrics.YSQL_TRANSACTION_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

The count of SELECT statements executed through the YCQL API per second. This does not include index writes.

Preprocessing

• JSON Path: $.metrics.YCQL_SELECT_OPS_PER_SEC

The count of DELETE statements executed through the YCQL API per second. This does not include index writes.

Preprocessing

• JSON Path: $.metrics.YCQL_DELETE_OPS_PER_SEC

The count of INSERT statements executed through the YCQL API per second. This does not include index writes.

Preprocessing

• JSON Path: $.metrics.YCQL_INSERT_OPS_PER_SEC

The count of OTHER statements executed through the YCQL API per second.

Preprocessing

• JSON Path: $.metrics.YCQL_OTHER_OPS_PER_SEC

The count of UPDATE statements executed through the YCQL API per second. This does not include index writes.

Preprocessing

• JSON Path: $.metrics.YCQL_UPDATE_OPS_PER_SEC

The count of transactions executed through the YCQL API per second.

Preprocessing

• JSON Path: $.metrics.YCQL_TRANSACTION_OPS_PER_SEC

Average time of executing SELECT statements through the YCQL API.

Preprocessing

• JSON Path: $.metrics.YCQL_SELECT_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

Average time of executing DELETE statements through the YCQL API.

Preprocessing

• JSON Path: $.metrics.YCQL_DELETE_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

Average time of executing INSERT statements through the YCQL API.

Preprocessing

• JSON Path: $.metrics.YCQL_INSERT_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

Average time of executing OTHER statements through the YCQL API.

Preprocessing

• JSON Path: $.metrics.YCQL_OTHER_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

Average time of executing UPDATE statements through the YCQL API.

Preprocessing

• JSON Path: $.metrics.YCQL_UPDATE_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

Average time of executing transactions through the YCQL API.

Preprocessing

• JSON Path: $.metrics.YCQL_TRANSACTION_LATENCY_MS

• Custom multiplier: 0.001

  ⛔️Custom on fail: Set value to: 0

Failed to fetch data from the YugabyteDB API.

Failed to fetch cluster metrics or cluster statistics.

YugabyteDB Cluster software version has changed. Acknowledge to close the problem manually.

YugabyteDB Cluster YB controller version has changed. Acknowledge to close the problem manually.

YugabyteDB Cluster is not healthy.

YugabyteDB Cluster CPU utilization is more than {$YUGABYTEDB.CPU.UTILIZATION.CRIT}%. The system might be slow to respond.

YugabyteDB Cluster CPU utilization is more than {$YUGABYTEDB.CPU.UTILIZATION.WARN}%. The system might be slow to respond.

• YugabyteDB Cluster: CPU utilization is too high

YugabyteDB Cluster uses more than {$YUGABYTEDB.DISK.UTILIZATION.WARN}% of disk space.

• YugabyteDB Cluster: Storage space is critically low

YugabyteDB Cluster uses more than {$YUGABYTEDB.DISK.UTILIZATION.CRIT}% of disk space.

YugabyteDB Cluster uses more than {$YUGABYTEDB.CONNECTION.UTILIZATION.WARN}% of the connection limit.

• YugabyteDB Cluster: Average utilization of connections is too high

YugabyteDB Cluster uses more than {$YUGABYTEDB.CONNECTION.UTILIZATION.CRIT}% of the connection limit.

YugabyteDB Cluster uses more than {$YUGABYTEDB.MEMORY.CLUSTER.UTILIZATION.WARN}% of memory.

• YugabyteDB Cluster: Memory utilization is too high

YugabyteDB Cluster uses more than {$YUGABYTEDB.MEMORY.CLUSTER.UTILIZATION.CRIT}% of memory.

Discovery of the available keyspaces.

Preprocessing

• JavaScript: The text is too long. Please see the template.

• Discard unchanged with heartbeat: 1d

Get raw data about the keyspace [{#KEYSPACE.NAME}].

Preprocessing

• JSON Path: $.keyspaces.[?(@.keyspace_name=='{#KEYSPACE.NAME}')].first()

  ⛔️Custom on fail: Discard value

The size of the table's SST.

Preprocessing

• JSON Path: $.size_bytes

The size of the table's WAL.

Preprocessing

• JSON Path: $.wal_size_bytes

The type of keyspace: YSQL or YCQL.

Preprocessing

• JSON Path: $.type

• Replace: YSQL -> 0

• Replace: YCQL -> 1

• Discard unchanged with heartbeat: 1d

Discovery of the nodes for all clusters.

Preprocessing

• JavaScript: The text is too long. Please see the template.

• Discard unchanged with heartbeat: 1d

Get raw data about the node [{#NODE.NAME}].

Preprocessing

• JSON Path: $.nodes.[?(@.name=='{#NODE.NAME}')].first()

  ⛔️Custom on fail: Discard value

The IOPS to provision for the node [{#NODE.NAME}] for each disk.

Preprocessing

• JSON Path: $.data.spec.cluster_info.node_info.disk_iops

• Discard unchanged with heartbeat: 12h

The disk size (GB) for the node [{#NODE.NAME}].

Preprocessing

• JSON Path: $.data.spec.cluster_info.node_info.disk_size_gb

• Discard unchanged with heartbeat: 12h

The amount of RAM for the node [{#NODE.NAME}].

Preprocessing

• JSON Path: $.data.spec.cluster_info.node_info.memory_mb

• Custom multiplier: 1048576

• Discard unchanged with heartbeat: 12h

The number of cores for the node [{#NODE.NAME}].

Preprocessing

• JSON Path: $.data.spec.cluster_info.node_info.num_cores

• Discard unchanged with heartbeat: 12h

The cloud information for the node [{#NODE.NAME}] about the region.

Preprocessing

• JSON Path: $.cloud_info.region

• Discard unchanged with heartbeat: 1d

The cloud information for the node [{#NODE.NAME}] about the zone.

Preprocessing

• JSON Path: $.cloud_info.zone

• Discard unchanged with heartbeat: 1d

The size of all SST files.

Preprocessing

• JSON Path: $.metrics.total_sst_file_size_bytes

The size of uncompressed SST files.

Preprocessing

• JSON Path: $.metrics.uncompressed_sst_file_size_bytes

The amount of read operations per second for the node [{#NODE.NAME}].

Preprocessing

• JSON Path: $.metrics.read_ops_per_sec

The amount of write operations per second for the node [{#NODE.NAME}].

Preprocessing

• JSON Path: $.metrics.write_ops_per_sec

Shows the utilization of provisioned IOPS.

The current status of the node [{#NODE.NAME}]:

0 = Down

1 = Up

Preprocessing

• JSON Path: $.is_node_up

• Replace: true -> 1

• Replace: false -> 0

• Discard unchanged with heartbeat: 1h

The current role of the node [{#NODE.NAME}]:

0 = False

1 = True

Preprocessing

• JSON Path: $.is_master

• Replace: true -> 1

• Replace: false -> 0

• Discard unchanged with heartbeat: 1h

This item indicates if the node [{#NODE.NAME}] is a TServer node:

0 = False

1 = True

Preprocessing

• JSON Path: $.is_tserver

• Replace: true -> 1

• Replace: false -> 0

• Discard unchanged with heartbeat: 1h

This item indicates if the node [{#NODE.NAME}] is a read replica:

0 = False

1 = True

Preprocessing

• JSON Path: $.is_read_replica

• Replace: true -> 1

• Replace: false -> 0

• Discard unchanged with heartbeat: 1h

IOPS utilization on the node [{#NODE.NAME}] is more than {$YUGABYTEDB.IOPS.UTILIZATION.WARN}% of the provisioned IOPS.

• YugabyteDB Node [{#NODE.NAME}]: Node disk IOPS utilization is too high

IOPS utilization on the node [{#NODE.NAME}] is more than {$YUGABYTEDB.IOPS.UTILIZATION.CRIT}% of the provisioned IOPS.

The node [{#NODE.NAME}] is down.