Zabbix Documentation 5.0

3.04.04.45.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


manual:config:items:itemtypes:zabbix_agent:zabbix_agent2

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Previous revision
manual:config:items:itemtypes:zabbix_agent:zabbix_agent2 [2020/01/16 13:34]
manual:config:items:itemtypes:zabbix_agent:zabbix_agent2 [2020/05/22 13:19] (current)
marinagen [ZBXCTR-2] More specific Postgres item descriptions
Line 1: Line 1:
 +==== Zabbix agent 2 ====
  
 +=== Item keys ===
 +
 +The table provides details on the item keys that you can use with Zabbix agent 2 only.
 +
 +<​note>​ Parameters without angle brackets are mandatory. Parameters marked with angle brackets **<** **>** are optional.</​note>​
 +
 +^  Key  ^^^^^
 +^ ^  **Description** ​ ^  **Return value** ​ ^  **Parameters** ​ ^  **Comments** ​ ^
 +| |||||
 +^docker.container_info [<​ID>​] ​ ^^^^^
 +^ |Low-level information about a container. ​ |An output of the [[https://​docs.docker.com/​engine/​api/​v1.28/#​operation/​ContainerInspect|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 [[https://​docs.docker.com/​engine/​api/​v1.28/#​operation/​ContainerStats|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 [[https://​docs.docker.com/​engine/​api/​v1.28/#​operation/​ContainerList|ContainerList]] API call serialized as JSON  |-  |This item is supported for the Docker plugin. ​ |
 +| |||||
 +^docker.containers.discovery ​ ^^^^^
 +^ |A list of containers. Used for [[:​manual/​discovery/​low_level_discovery/​systemd|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 [[https://​docs.docker.com/​engine/​api/​v1.28/#​operation/​SystemDataUsage|SystemDataUsage]] API call serialized as JSON  |-  |This item is supported for the Docker plugin. ​ |
 +| |||||
 +^docker.images ​ ^^^^^
 +^ |A list of images. ​ |An output of the [[https://​docs.docker.com/​engine/​api/​v1.28/#​operation/​ImageList|ImageList]] API call serialized as JSON  |-  |This item is supported for the Docker plugin. ​ |
 +| |||||
 +^docker.images.discovery ​ ^^^^^
 +^ |A list of images. Used for [[:​manual/​discovery/​low_level_discovery/​systemd|low-level discovery]]. ​ |JSON object. ​ |-  |This item is supported for the Docker plugin. ​ |
 +| |||||
 +^docker.info ​ ^^^^^
 +^ |System information. ​ |An output of the [[https://​docs.docker.com/​engine/​api/​v1.28/#​operation/​SystemInfo|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 [[:​manual/​discovery/​low_level_discovery/​systemd|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 [[:​manual/​discovery/​low_level_discovery/​systemd|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.  |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.  |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 results are processed by dependent items. \\ 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 [[:​manual/​discovery/​low_level_discovery/​systemd|low-level discovery]].|SQL query in 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.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.  |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 [[:​manual/​discovery/​low_level_discovery/​systemd|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 [[:​manual/​discovery/​low_level_discovery/​systemd|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 [[:​manual/​discovery/​low_level_discovery/​systemd|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 [[:​manual/​discovery/​low_level_discovery/​systemd|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 [[:​manual/​discovery/​low_level_discovery/​systemd|low-level discovery]]. ​ |SQl query in 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.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.  |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** - [[https://​redis.io/​commands/​info|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 [[https://​www.freedesktop.org/​wiki/​Software/​systemd/​dbus/​|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 [[:​manual/​discovery/​low_level_discovery/​systemd|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.  |