Sidebar
manual:config:items:itemtypes:zabbix_agent:zabbix_agent2
Zabbix agent 2
Item keys
The table provides details on the item keys that you can use with Zabbix agent 2 only.
Parameters without angle brackets are mandatory. Parameters marked with angle brackets < > are optional.
| Key | ||||
|---|---|---|---|---|
| Description | Return value | Parameters | Comments | |
| docker.container_info [<ID>] | ||||
| Low-level information about a container. | An output of the ContainerInspect API call serialized as JSON | ID — ID or name of the container | This item is supported since Zabbix 5.0.0 for the Docker plugin. | |
| docker.container_stats [<ID>] | ||||
| Container resource usage statistics. | An output of the ContainerStats API call serialized as JSON | ID — ID or name of the container | This item is supported for the Docker plugin. | |
| docker.containers | ||||
| A list of containers. | An output of the ContainerList API call serialized as JSON | - | This item is supported for the Docker plugin. | |
| docker.containers.discovery | ||||
| A list of containers. Used for low-level discovery. | JSON object. | - | This item is supported for the Docker plugin. | |
| docker.data_usage | ||||
| Information about current data usage. | An output of the SystemDataUsage API call serialized as JSON | - | This item is supported for the Docker plugin. | |
| docker.images | ||||
| A list of images. | An output of the ImageList API call serialized as JSON | - | This item is supported for the Docker plugin. | |
| docker.images.discovery | ||||
| A list of images. Used for low-level discovery. | JSON object. | - | This item is supported for the Docker plugin. | |
| docker.info | ||||
| System information. | An output of the SystemInfo API call serialized as JSON | - | This item is supported for the Docker plugin. | |
| docker.ping | ||||
| Test if a Docker daemon is alive or not. | 1 - connection is alive 0 - connection is broken | - | This item is supported for the Docker plugin. | |
| memcached.ping[<connString>,<user>,<password>] | ||||
| Test if a connection is alive or not. | 1 - connection is alive 0 - connection is broken (if there is any error presented including AUTH and configuration issues) | connString - URI or session name. | This item is supported for the Memchached plugin. | |
| memcached.stats[<connString>,<user>,<password>,<type>] | ||||
| Gets the output of the STATS command. | JSON - output is serialized as JSON | connString - URI or session name. user, password - Memchached login credentials. type - stat type to be returned: items, sizes, slabs or settings (empty by default, returns general statistics). | This item is supported for the Memchached plugin. | |
| mysql.db.discovery[<connString>, <username>, <password>] | ||||
| List of MySQL databases. Used for low-level discovery. | Result of the “show databases” SQL query in LLD JSON format. | connString - URI or session name. username, password - MySQL login credentials. | This item is supported for the MySQL plugin. | |
| mysql.db.size[<connString>, <username>, <password>,dbName] | ||||
| Database size in bytes. | Result of the “select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?” SQL query for specific database in bytes. | connString - URI or session name. username, password - MySQL login credentials. dbName - Database name. | This item is supported for the MySQL plugin. | |
| mysql.get_status_variables[<connString>, <username>, <password>] | ||||
| Database size in bytes. | Result of the “select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?” SQL query for specific database in bytes. | connString - URI or session name. username, password - MySQL login credentials. | This item is supported for the MySQL plugin. | |
| mysql.ping[<connString>, <username>, <password>] | ||||
| Test if a connection is alive or not. | 1 - connection is alive 0 - connection is broken (if there is any error presented including AUTH and configuration issues). | connString - URI or session name. username, password - MySQL login credentials. | This item is supported for the MySQL plugin. | |
| mysql.replication.discovery[<connString>, <username>, <password>] | ||||
| List of MySQL replications. Used for low-level discovery. | Result of the “show slave status” SQL query in LLD JSON format. | connString - URI or session name. username, password - MySQL login credentials. | This item is supported for the MySQL plugin. | |
| mysql.replication.get_slave_status[<connString>, <username>, <password>, <masterHost>] | ||||
| Replication status. | Result of the “show slave status” SQL query in JSON format. | connString - URI or session name. username, password - MySQL login credentials. masterHost - Replication master host name. | This item is supported for the MySQL plugin. | |
| mysql.version[<connString>, <username>, <password>] | ||||
| MySQL version. | String with MySQL instance version. | connString - URI or session name. username, password - MySQL login credentials. | This item is supported for the MySQL plugin. | |
| pgsql.autovacuum.count[<uri>,<username>,<password>, <dbName>] | ||||
| The number of autovacuum workers. | SQL query. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.archive[<uri>,<username>,<password>, <dbName>] | ||||
| Information about archived files. | SQL query in JSON format. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | Returned data are processed by dependent items: pgsql.archive.count_archived_files - the number of WAL files that have been successfully archived. pgsql.archive.failed_trying_to_archive - the number of failed attempts for archiving WAL files. pgsql.archive.count_files_to_archive - the number of files to archive. pgsql.archive.size_files_to_archive -the size of files to archive. This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. |
|
| pgsql.bgwriter[<uri>,<username>,<password>, <dbName>] | ||||
| Combined number of checkpoints for the database cluster, broken down by checkpoint type. | SQL query in JSON format. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | Returned data are processed by dependent items: pgsql.bgwriter.buffers_alloc - the number of buffers allocated. pgsql.bgwriter.buffers_backend -the number of buffers written directly by a backend. pgsql.bgwriter.maxwritten_clean - the number of times the background writer stopped a cleaning scan, because it had written too many buffers. pgsql.bgwriter.buffers_backend_fsync -the number of times a backend had to execute its own fsync call instead of the background writer. pgsql.bgwriter.buffers_clean - the number of buffers written by the background writer. pgsql.bgwriter.buffers_checkpoint - the number of buffers written during checkpoints. pgsql.bgwriter.checkpoints_timed - the number of scheduled checkpoints that have been performed. pgsql.bgwriter.checkpoints_req - the number of requested checkpoints that have been performed. pgsql.bgwriter.checkpoint_write_time - the total amount of time spent in the portion of checkpoint processing where files are written to disk, in milliseconds. pgsql.bgwriter.sync_time - the total amount of time spent in the portion of checkpoint processing where files are synchronized with disk. This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. |
|
| pgsql.cache.hit[<uri>,<username>,<password>, <dbName>] | ||||
| PostgreSQL buffer cache hit rate. | SQL query in percentage. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.connections[<uri>,<username>,<password>, <dbName>] | ||||
| Connections by type. | JSON object. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | Returned data are processed by dependent items: pgsql.connections.active - the backend is executing a query. pgsql.connections.fastpath_function_call -the backend is executing a fast-path function. pgsql.connections.idle - the backend is waiting for a new client command. pgsql.connections.idle_in_transaction - the backend is in a transaction, but is not currently executing a query. pgsql.connections.prepared - the number of prepared connections. pgsql.connections.total - the total numer of connections. pgsql.connections.total_pct - percantange of total connections in respect to ‘max_connections’ setting of the PostgreSQL server. pgsql.connections.waiting - number of connections in a query. pgsql.connections.idle_in_transaction_aborted - the backend is in a transaction, but is not currently executing a query and one of the statements in the transaction caused an error. This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. |
|
| pgsql.dbstat[<uri>,<username>,<password>, dbName] | ||||
| Collects statistics per database. Used for low-level discovery. | SQL query in JSON format. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | Returned data are processed by dependent items: pgsql.dbstat.numbackends[“{#DBNAME}”] - time spent reading data file blocks by backends in this database, in milliseconds. pgsql.dbstat.sum.blk_read_time[“{#DBNAME}”] - time spent reading data file blocks by backends in this database, in milliseconds. pgsql.dbstat.sum.blk_write_time[“{#DBNAME}”] - time spent writing data file blocks by backends in this database, in milliseconds. pgsql.dbstat.sum.checksum_failures[“{#DBNAME}”] - the number of data page checksum failures detected (or on a shared object), or NULL if data checksums are not enabled.(PostgreSQL version 12 only) pgsql.dbstat.blks_read.rate[“{#DBNAME}”] - the number of disk blocks read in this database. pgsql.dbstat.deadlocks.rate[“{#DBNAME}”] - the number of deadlocks detected in this database. pgsql.dbstat.blks_hit.rate[“{#DBNAME}”] - the number of times disk blocks were found already in the buffer cache, so that a read was not necessary (this only includes hits in the PostgreSQL Pro buffer cache, not the operating system's file system cache). pgsql.dbstat.xact_rollback.rate[“{#DBNAME}”] - the number of transactions in this database that have been rolled back. pgsql.dbstat.xact_commit.rate[“{#DBNAME}”] - the number of transactions in this database that have been committed. pgsql.dbstat.tup_updated.rate[“{#DBNAME}”] - the number of rows updated by queries in this database. pgsql.dbstat.tup_returned.rate[“{#DBNAME}”] - the number of rows returned by queries in this database. pgsql.dbstat.tup_inserted.rate[“{#DBNAME}”] - the number of rows inserted by queries in this database. pgsql.dbstat.tup_fetched.rate[“{#DBNAME}”] - the number of rows fetched by queries in this database. pgsql.dbstat.tup_deleted.rate[“{#DBNAME}”] - the number of rows deleted by queries in this database. pgsql.dbstat.conflicts.rate[“{#DBNAME}”] - the number of queries canceled due to conflicts with recovery in this database (the conflicts occur only on standby servers). pgsql.dbstat.temp_files.rate[“{#DBNAME}”] - the number of temporary files created by queries in this database. All temporary files are counted, regardless of the log_temp_files settings and reasons for which the temporary file was created (e.g., sorting or hashing). pgsql.dbstat.temp_bytes.rate[“{#DBNAME}”] - the total amount of data written to temporary files by queries in this database. Includes data from all temporary files, regardless of the log_temp_files settings and reasons for which the temporary file was created (e.g., sorting or hashing). This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. |
|
| pgsql.dbstat.sum[<uri>,<username>,<password>, <dbName>] | ||||
| Summarized data for all databases in a cluster. | SQL query in JSON format. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | Returned data are processed by the dependent items: pgsql.dbstat.numbackends - the number of backends currently connected to this database. pgsql.dbstat.sum.blk_read_time - time spent reading data file blocks by backends in this database, in milliseconds. pgsql.dbstat.sum.blk_write_time - time spent writing data file blocks by backends in this database, in milliseconds. pgsql.dbstat.sum.checksum_failures - the number of data page checksum failures detected (or on a shared object), or NULL if data checksums are not enabled (PostgreSQL version 12 only). pgsql.dbstat.sum.xact_commit - the number of transactions in this database that have been committed. pgsql.dbstat.sum.conflicts - database statistics about query cancels due to conflict with recovery on standby servers. pgsql.dbstat.sum.deadlocks - the number of deadlocks detected in this database. pgsql.dbstat.sum.blks_read - the number of disk blocks read in this database. pgsql.dbstat.sum.blks_hit - the number of times disk blocks were found already in the buffer cache, so a read was not necessary (only hits in the PostgreSQL Pro buffer cache are included). pgsql.dbstat.sum.temp_bytes - the total amount of data written to temporary files by queries in this database. Includes data from all temporary files, regardless of the log_temp_files settings and reasons for which the temporary file was created (e.g., sorting or hashing). pgsql.dbstat.sum.temp_files - the number of temporary files created by queries in this database. All temporary files are counted, regardless of the log_temp_files settings and reasons for which the temporary file was created (e.g., sorting or hashing). pgsql.dbstat.sum.xact_rollback - the number of rolled-back transactions in this database. pgsql.dbstat.sum.tup_deleted - the number of rows deleted by queries in this database. pgsql.dbstat.sum.tup_fetched - the number of rows fetched by queries in this database. pgsql.dbstat.sum.tup_inserted - the number of rows inserted by queries in this database. pgsql.dbstat.sum.tup_returned - the number of rows returned by queries in this database. pgsql.dbstat.sum.tup_updated - the number of rows updated by queries in this database. This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. |
|
| pgsql.db.age[<uri>,<username>,<password>, dbName] | ||||
| Age of the oldest FrozenXID of the database. Used for low-level discovery. | SQL query for specific database in transactions. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.db.bloating_tables[<uri>,<username>,<password>, <dbName>] | ||||
| The number of bloating tables per database. Used for low-level discovery. | SQL query. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.db.discovery[<uri>,<username>,<password>, <dbName>] | ||||
| List of the PostgreSQL databases. Used for low-level discovery. | SQL query in the LLD JSON format. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.db.size[<uri>,<username>,<password>, dbName] | ||||
| Database size in bytes. Used for low-level discovery. | SQL query for specific database in bytes. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.locks[<uri>,<username>,<password>, <dbName>] | ||||
| Information about granted locks per database. Used for low-level discovery. | SQl query in JSON format. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | Returned data are processed by dependent items: pgsql.locks.shareupdateexclusive[“{#DBNAME}”] - the number of share update exclusive locks. pgsql.locks.accessexclusive[“{#DBNAME}”] - the number of access exclusive locks. pgsql.locks.accessshare[“{#DBNAME}”] - the number of access share locks. pgsql.locks.exclusive[“{#DBNAME}”] - the number of exclusive locks. pgsql.locks.rowexclusive[“{#DBNAME}”] - the number of row exclusive locks. pgsql.locks.rowshare[“{#DBNAME}”] - the number of row share locks. pgsql.locks.share[“{#DBNAME}”] - the number of shared locks. pgsql.locks.sharerowexclusive[“{#DBNAME}”] - the number of share row exclusive locks. This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. |
|
| pgsql.oldest.xid[<uri>,<username>,<password>, <dbName>] | ||||
| Age of the oldest XID. | SQl query. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.ping[<uri>,<username>,<password>, <dbName>] | ||||
| Tests whether a connection is alive or not. | 1 - connection is alive 0 - connection is broken (if there is any error presented including AUTH and configuration issues). | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.replication.count[<uri>,<username>,<password>, <dbName>] | ||||
| The number of standby servers. | SQL query. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.replication.recovery_role[<uri>,<username>,<password>, <dbName>] | ||||
| Recovery status. | 0 - master mode 1 - recovery is still in progress (standby mode) | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.replication.status[<uri>,<username>,<password>, <dbName>] | ||||
| The status of replication. | 0 - streaming is down 1 - streaming is up 2 - master mode | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.replication_lag.b[<uri>,<username>,<password>, <dbName>] | ||||
| Replication lag in bytes. | SQL query in bytes. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.replication_lag.sec[<uri>,<username>,<password>, <dbName>] | ||||
| Replication lag in seconds. | SQL query in seconds. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.uptime[<uri>,<username>,<password>, <dbName>] | ||||
| PostgreSQL uptime in milliseconds. | SQL query in milliseconds. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. | |
| pgsql.wal.stat[<uri>,<username>,<password>, <dbName>] | ||||
| WAL statistics. | SQL query in JSON format. | uri - URI or session name. username, password - PostgreSQL credentials. dbName - Database name. | Returned data are processed by dependent items: pgsql.wal.count — the number of WAL files. pgsql.wal.write - the WAL lsn used (in bytes). This item is supported since Zabbix 5.0.1 for the PostgreSQL plugin. |
|
| redis.config[<connString>,<password>,<pattern>] | ||||
| Gets the configuration parameters of a Redis instance that match the pattern. | JSON - if a glob-style pattern was used single value - if a pattern did not contain any wildcard character | connString - URI or session name. password - Redis password. pattern - glob-style pattern (* by default). | This item is supported since Zabbix 4.4.5 for the Redis plugin. | |
| redis.info[<connString>,<password>,<section>] | ||||
| Gets the output of the INFO command. | JSON - output is serialized as JSON | connString - URI or session name. password - Redis password. section - section of information (default by default). | This item is supported since Zabbix 4.4.5 for the Redis plugin. | |
| redis.ping[<connString>,<password>] | ||||
| Test if a connection is alive or not. | 1 - connection is alive 0 - connection is broken (if there is any error presented including AUTH and configuration issues) | connString - URI or session name. password - Redis password. | This item is supported since Zabbix 4.4.5 for the Redis plugin. | |
| redis.slowlog.count[<connString>,<password>] | ||||
| The number of slow log entries since Redis was started. | Integer | connString - URI or session name. password - Redis password. | This item is supported since Zabbix 4.4.5 for the Redis plugin. | |
| systemd.unit.info[<unit name>,<property>,<interface>] | ||||
| Systemd unit information. | String | unit name - unit name (you may want to use the {#UNIT.NAME} macro in item prototype to discover the name) property - unit property (e.g. ActiveState (default), LoadState, Description) interface - unit interface type (e.g. Unit (default), Socket, Service) | This item allows to retrieve a specific property from specific type of interface as described in dbus API. This item is only supported in Zabbix agent 2. This item is supported on Linux platform only. Examples: ⇒ systemd.unit.info[“{#UNIT.NAME}”] - collect active state (active, reloading, inactive, failed, activating, deactivating) info on discovered systemd units ⇒ systemd.unit.info[“{#UNIT.NAME}”,LoadState] - collect load state info on discovered systemd units ⇒ systemd.unit.info[mysqld.service,Id] - retrieve service technical name (mysqld.service) ⇒ systemd.unit.info[mysqld.service,Description] - retrieve service desciption (MySQL Server) ⇒ systemd.unit.info[mysqld.service,ActiveEnterTimestamp] - retrieve the last time the service entered the active state (1562565036283903) ⇒ systemd.unit.info[dbus.socket,NConnections,Socket] - collect the number of connections from this socket unit |
|
| systemd.unit.discovery[<type>] | ||||
| List of systemd units and their details. Used for low-level discovery. | JSON object | type - possible values: all, automount, device, mount, path, service (default), socket, swap, target | This item is only supported in Zabbix agent 2. This item is supported on Linux platform only. |
|