You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

1 Zabbix agent 2

Zabbix agent 2 supports all item keys supported for Zabbix agent on Unix and Windows. This page provides details on the additional item keys, which you can use with Zabbix agent 2 only, grouped by the plugin they belong to.

The item keys are listed without parameters and additional information. Click on the item key to see the full details.

Item key Description Plugin
ceph.df.details The cluster’s data usage and distribution among pools. Ceph
ceph.osd.stats Aggregated and per OSD statistics.
ceph.osd.discovery The list of discovered OSDs.
ceph.osd.dump The usage thresholds and statuses of OSDs.
ceph.ping Tests whether a connection to Ceph can be established.
ceph.pool.discovery The list of discovered pools.
ceph.status The overall cluster's status.
docker.container_info Low-level information about a container. Docker
docker.container_stats The container resource usage statistics.
docker.containers Returns the list of containers.
docker.containers.discovery Returns the list of containers. Used for low-level discovery.
docker.data.usage Information about the current data usage.
docker.images Returns the list of images.
docker.images.discovery Returns the list of images. Used for low-level discovery.
docker.info The system information.
docker.ping Test if the Docker daemon is alive or not.
memcached.ping Test if a connection is alive or not. Memcached
memcached.stats Gets the output of the STATS command.
mongodb.collection.stats Returns a variety of storage statistics for a given collection. MongoDB
mongodb.collections.discovery Returns a list of discovered collections.
mongodb.collections.usage Returns the usage statistics for collections.
mongodb.connpool.stats Returns information regarding the open outgoing connections from the current database instance to other members of the sharded cluster or replica set.
mongodb.db.stats Returns the statistics reflecting a given database system state.
mongodb.db.discovery Returns a list of discovered databases.
mongodb.jumbo_chunks.count Returns the count of jumbo chunks.
mongodb.oplog.stats Returns the status of the replica set, using data polled from the oplog.
mongodb.ping Test if a connection is alive or not.
mongodb.rs.config Returns the current configuration of the replica set.
mongodb.rs.status Returns the replica set status from the point of view of the member where the method is run.
mongodb.server.status Returns the database state.
mongodb.sh.discovery Returns the list of discovered shards present in the cluster.
mongodb.version Returns the database server version.
mqtt.get Subscribes to a specific topic or topics (with wildcards) of the provided broker and waits for publications. MQTT
mssql.availability.group.get Returns availability groups. MSSQL
mssql.custom.query Returns the result of a custom query.
mssql.db.get Returns all available MSSQL databases.
mssql.job.status.get Returns the status of jobs.
mssql.last.backup.get Returns the last backup time for all databases.
mssql.local.db.get Returns databases that are participating in an Always On availability group and replica (primary or secondary) and are located on the server that the connection was established to.
mssql.mirroring.get Returns mirroring info.
mssql.nonlocal.db.get Returns databases that are participating in an Always On availability group and replica (primary or secondary) located on other servers (the database is not local to the SQL Server instance that the connection was established to).
mssql.perfcounter.get Returns the performance counters.
mssql.ping Test if a connection is alive or not.
mssql.quorum.get Returns the quorum info.
mssql.quorum.member.get Returns the quorum members.
mssql.replica.get Returns the replicas.
mssql.version Returns the MSSQL version.
mysql.custom.query Returns the result of a custom query. MySQL
mysql.db.discovery Returns the list of MySQL databases.
mysql.db.size The database size in bytes.
mysql.get_status_variables Values of the global status variables.
mysql.ping Test if a connection is alive or not.
mysql.replication.discovery Returns the list of MySQL replications.
mysql.replication.get_slave_status The replication status.
mysql.version The MySQL version.
net.dns.get Performs a DNS query and returns detailed DNS record information. Network
oracle.diskgroups.stats Returns the Automatic Storage Management (ASM) disk groups statistics. Oracle
oracle.diskgroups.discovery Returns the list of ASM disk groups.
oracle.archive.info The archive logs statistics.
oracle.cdb.info The Container Databases (CDBs) information.
oracle.custom.query The result of a custom query.
oracle.datafiles.stats Returns the data files statistics.
oracle.db.discovery Returns the list of databases.
oracle.fra.stats Returns the Fast Recovery Area (FRA) statistics.
oracle.instance.info The instance statistics.
oracle.pdb.info The Pluggable Databases (PDBs) information.
oracle.pdb.discovery Returns the list of PDBs.
oracle.pga.stats Returns the Program Global Area (PGA) statistics.
oracle.ping Test whether a connection to Oracle can be established.
oracle.proc.stats Returns the processes statistics.
oracle.redolog.info The log file information from the control file.
oracle.sga.stats Returns the System Global Area (SGA) statistics.
oracle.sessions.stats Returns the sessions statistics.
oracle.sys.metrics Returns a set of system metric values.
oracle.sys.params Returns a set of system parameter values.
oracle.ts.stats Returns the tablespaces statistics.
oracle.ts.discovery Returns a list of tablespaces.
oracle.user.info Returns Oracle user information.
oracle.version Returns the database server version.
pgsql.autovacuum.count The number of autovacuum workers. PostgreSQL
pgsql.archive The information about archived files.
pgsql.bgwriter The combined number of checkpoints for the database cluster, broken down by checkpoint type.
pgsql.cache.hit The PostgreSQL buffer cache hit rate.
pgsql.connections Returns connections by type.
pgsql.custom.query Returns the result of a custom query.
pgsql.db.age The age of the oldest FrozenXID of the database.
pgsql.db.bloating_tables The number of bloating tables per database.
pgsql.db.discovery The list of PostgreSQL databases.
pgsql.db.size The database size in bytes.
pgsql.dbstat Collects the statistics per database.
pgsql.dbstat.sum The summarized data for all databases in a cluster.
pgsql.locks The information about granted locks per database.
pgsql.oldest.xid The age of the oldest XID.
pgsql.ping Test if a connection is alive or not.
pgsql.queries Query metrics by execution time.
pgsql.replication.count The number of standby servers.
pgsql.replication.process The flush lag, write lag and replay lag per each sender process.
pgsql.replication.process.discovery The replication process name discovery.
pgsql.replication.recovery_role The recovery status.
pgsql.replication.status The status of replication.
pgsql.replication_lag.b The replication lag in bytes.
pgsql.replication_lag.sec The replication lag in seconds.
pgsql.uptime The PostgreSQL uptime in milliseconds.
pgsql.version Returns PostgreSQL version.
pgsql.wal.stat The WAL statistics.
redis.config Gets the configuration parameters of a Redis instance that match the pattern. Redis
redis.info Gets the output of the INFO command.
redis.ping Test if a connection is alive or not.
redis.slowlog.count The number of slow log entries since Redis was started.
smart.attribute.discovery Returns a list of S.M.A.R.T. device attributes. S.M.A.R.T.
smart.disk.discovery Returns a list of S.M.A.R.T. devices.
smart.disk.get Returns all available properties of S.M.A.R.T. devices.
systemd.unit.get Returns all properties of a systemd unit. Systemd
systemd.unit.info Systemd unit information.
systemd.unit.discovery The list of systemd units and their details.
web.certificate.get Validates the certificates and returns certificate details. Web certificates

See also: Built-in plugins

Item key details

Parameters without angle brackets are mandatory. Parameters marked with angle brackets < > are optional.

ceph.df.details[connString,<user>,<apikey>]


The cluster’s data usage and distribution among pools.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the Ceph login credentials.
ceph.osd.stats[connString,<user>,<apikey>]


Aggregated and per OSD statistics.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the Ceph login credentials.
ceph.osd.discovery[connString,<user>,<apikey>]


The list of discovered OSDs. Used for low-level discovery.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the Ceph login credentials.
ceph.osd.dump[connString,<user>,<apikey>]


The usage thresholds and statuses of OSDs.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the Ceph login credentials.
ceph.ping[connString,<user>,<apikey>]


Tests whether a connection to Ceph can be established.
Return value: 0 - connection is broken (if there is any error presented including AUTH and configuration issues); 1 - connection is successful.

Parameters:

  • connString - the URI or session name;
  • user, password - the Ceph login credentials.
ceph.pool.discovery[connString,<user>,<apikey>]


The list of discovered pools. Used for low-level discovery.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the Ceph login credentials.
ceph.status[connString,<user>,<apikey>]


The overall cluster's status.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the Ceph login credentials.
docker.container_info[<ID>,<info>]


Low-level information about a container.
Return value: The output of the ContainerInspect API call serialized as JSON.

Parameters:

  • ID - the ID or name of the container;
  • info - the amount of information returned. Supported values: short (default) or full.

The Agent 2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.

docker.container_stats[<ID>]


The container resource usage statistics.
Return value: The output of the ContainerStats API call and CPU usage percentage serialized as JSON.

Parameter:

  • ID - the ID or name of the container.

The Agent 2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.

docker.containers


The list of containers.
Return value: The output of the ContainerList API call serialized as JSON.

The Agent 2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.

docker.containers.discovery[<options>]


Returns the list of containers. Used for low-level discovery.
Return value: JSON object.

Parameter:

  • options - specify whether all or only running containers should be discovered. Supported values: true - return all containers; false - return only running containers (default).

The Agent 2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.

docker.data.usage


Information about the current data usage.
Return value: The output of the SystemDataUsage API call serialized as JSON.

The Agent 2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.

docker.images


Returns the list of images.
Return value: The output of the ImageList API call serialized as JSON.

The Agent 2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.

docker.images.discovery


Returns the list of images. Used for low-level discovery.
Return value: JSON object.

The Agent 2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.

docker.info


The system information.
Return value: The output of the SystemInfo API call serialized as JSON.

The Agent 2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.

docker.ping


Test if the Docker daemon is alive or not.
Return value: 1 - the connection is alive; 0 - the connection is broken.

The Agent 2 user ('zabbix') must be added to the 'docker' group for sufficient privileges. Otherwise the check will fail.

memcached.ping[connString,<user>,<password>]


Test if a connection is alive or not.
Return value: 1 - the connection is alive; 0 - the connection is broken (if there is any error presented including AUTH and configuration issues).

Parameters:

  • connString - the URI or session name;
  • user, password - the Memcached login credentials.
memcached.stats[connString,<user>,<password>,<type>]


Gets the output of the STATS command.
Return value: JSON - the output is serialized as JSON.

Parameters:

  • connString - the URI or session name;
  • user, password - the Memcached login credentials;
  • type - stat type to be returned: items, sizes, slabs or settings (empty by default, returns general statistics).
mongodb.collection.stats[connString,<user>,<password>,<database>,collection]


Returns a variety of storage statistics for a given collection.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials;
  • database - the database name (default: admin);
  • collection - the collection name.
mongodb.collections.discovery[connString,<user>,<password>]


Returns a list of discovered collections. Used for low-level discovery.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials.
mongodb.collections.usage[connString,<user>,<password>]


Returns the usage statistics for collections.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials.
mongodb.connpool.stats[connString,<user>,<password>]


Returns information regarding the open outgoing connections from the current database instance to other members of the sharded cluster or replica set.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials;
  • database - the database name (default: admin);
  • collection - the collection name.
mongodb.db.stats[connString,<user>,<password>,<database>]


Returns the statistics reflecting a given database system state.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials;
  • database - the database name (default: admin).
mongodb.db.discovery[connString,<user>,<password>]


Returns a list of discovered databases. Used for low-level discovery.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials.
mongodb.jumbo_chunks.count[connString,<user>,<password>]


Returns the count of jumbo chunks.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials.
mongodb.oplog.stats[connString,<user>,<password>]


Returns the status of the replica set, using data polled from the oplog.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials.
mongodb.ping[connString,<user>,<password>]


Test if a connection is alive or not.
Return value: 1 - the connection is alive; 0 - the connection is broken (if there is any error presented including AUTH and configuration issues).

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials.
mongodb.rs.config[connString,<user>,<password>]


Returns the current configuration of the replica set.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials.
mongodb.rs.status[connString,<user>,<password>]


Returns the replica set status from the point of view of the member where the method is run.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials.
mongodb.server.status[connString,<user>,<password>]


Returns the database state.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials.
mongodb.sh.discovery[connString,<user>,<password>]


Returns the list of discovered shards present in the cluster.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials.
mongodb.version[connString,<user>,<password>]


Returns the database server version.
Return value: String.

Parameters:

  • connString - the URI or session name;
  • user, password - the MongoDB login credentials.
mqtt.get[<broker url>,topic,<user>,<password>]


Subscribes to a specific topic or topics (with wildcards) of the provided broker and waits for publications.
Return value: Depending on topic content. If wildcards are used, returns topic content as JSON.

Parameters:

  • broker url - the MQTT broker URL in the format protocol://host:port without query parameters (supported protocols: tcp, ssl, ws). If no value is specified, the agent will use tcp://localhost:1883. If a protocol or port are omitted, default protocol (tcp) or port (1883) will be used;
  • topic - the MQTT topic (mandatory). Wildcards (+,#) are supported;
  • user, password - the authentication credentials (if required).

Comments:

  • The item must be configured as an active check ('Zabbix agent (active)' item type);
  • TLS encryption certificates can be used by saving them into a default location (e.g. /etc/ssl/certs/ directory for Ubuntu). For TLS, use the tls:// scheme.
mssql.availability.group.get[URI,<user>,<password>]


Returns availability groups.
Return value: JSON object.

Parameters:

  • URI - MSSQL server URI (the only supported schema is sqlserver://). Embedded credentials will be ignored;
  • user, password - username, password to send to protected MSSQL server.

For more information see the MSSQL plugin readme.

mssql.custom.query[URI,<user>,<password>,queryName,<args...>]


Returns the result of a custom query.
Return value: JSON object.

Parameters:

  • URI - MSSQL server URI (the only supported schema is sqlserver://). Embedded credentials will be ignored;
  • user, password - username, password to send to protected MSSQL server;
  • queryName - name of a custom query configured in Plugins.MSSQL.CustomQueriesDir without the .sql extension;
  • args - one or several comma-separated arguments to pass to a query.

For more information see the MSSQL plugin readme.

mssql.db.get


Returns all available MSSQL databases.
Return value: JSON object.

For more information see the MSSQL plugin readme.

mssql.job.status.get


Returns the status of jobs.
Return value: JSON object.

For more information see the MSSQL plugin readme.

mssql.last.backup.get


Returns the last backup time for all databases.
Return value: JSON object.

For more information see the MSSQL plugin readme.

mssql.local.db.get


Returns databases that are participating in an Always On availability group and replica (primary or secondary) and are located on the server that the connection was established to.
Return value: JSON object.

For more information see the MSSQL plugin readme.

mssql.mirroring.get


Returns mirroring info.
Return value: JSON object.

For more information see the MSSQL plugin readme.

mssql.nonlocal.db.get


Returns databases that are participating in an Always On availability group and replica (primary or secondary) located on other servers (the database is not local to the SQL Server instance that the connection was established to).
Return value: JSON object.

For more information see the MSSQL plugin readme.

mssql.perfcounter.get


Returns the performance counters.
Return value: JSON object.

For more information see the MSSQL plugin readme.

mssql.ping


Ping the database. Test if connection is correctly configured.
Return value: 1 - alive, 0 - not alive.

For more information see the MSSQL plugin readme.

mssql.quorum.get


Returns the quorum info.
Return value: JSON object.

For more information see the MSSQL plugin readme.

mssql.quorum.member.get


Returns the quorum members.
Return value: JSON object.

For more information see the MSSQL plugin readme.

mssql.replica.get


Returns the replicas.
Return value: JSON object.

For more information see the MSSQL plugin readme.

mssql.version


Returns the MSSQL version.
Return value: String.

For more information see the MSSQL plugin readme.

mysql.custom.query[connString,<user>,<password>,queryName,<args...>]


Returns the result of a custom query.
Return value: JSON object.

Parameters:

  • connString - URI or session name;
  • user, password - MySQL login credentials;
  • queryName - name of a custom query, must match SQL file name without an extension;
  • args - one or several comma-separated arguments to pass to a query.
mysql.db.discovery[connString,<user>,<password>]


Returns the list of MySQL databases. Used for low-level discovery.
Return value: The result of the "show databases" SQL query in LLD JSON format.

Parameters:

  • connString - the URI or session name;
  • user, password - the MySQL login credentials.
mysql.db.size[connString,<user>,<password>,<database name>]


The database size in bytes.
Return value: 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.

Parameters:

  • connString - the URI or session name;
  • user, password - the MySQL login credentials;
  • database name - the database name.
mysql.get_status_variables[connString,<user>,<password>]


Values of the global status variables.
Return value: Result of the "show global status" SQL query in JSON format.

Parameters:

  • connString - the URI or session name;
  • user, password - the MySQL login credentials.
mysql.ping[connString,<user>,<password>]


Test if a connection is alive or not.
Return value: 1 - the connection is alive; 0 - the connection is broken (if there is any error presented including AUTH and configuration issues).

Parameters:

  • connString - the URI or session name;
  • user, password - the MySQL login credentials.
mysql.replication.discovery[connString,<user>,<password>]


Returns the list of MySQL replications. Used for low-level discovery.
Return value: The result of the "show slave status" SQL query in LLD JSON format.

Parameters:

  • connString - the URI or session name;
  • user, password - the MySQL login credentials.
mysql.replication.get_slave_status[connString,<user>,<password>,<master host>]


The replication status.
Return value: Result of the "show slave status" SQL query in JSON format.

Parameters:

  • connString - the URI or session name;
  • user, password - the MySQL login credentials;
  • master host - the replication master host name. If none found, an error is returned. If this parameter is not specified, all hosts are returned.
mysql.version[connString,<user>,<password>]


The MySQL version.
Return value: String (with the MySQL instance version).

Parameters:

  • connString - the URI or session name;
  • user, password - the MySQL login credentials.
net.dns.get[<ip>,name,<type>,<timeout>,<count>,<protocol>,"<flags>"]

Performs a DNS query and returns detailed DNS record information.
This item is an extended version of the net.dns.record Zabbix agent item with more record types and customizable flags supported.
Return values: JSON object

Parameters:

  • ip - the IP address of DNS server (leave empty for the default DNS server);
  • name - the DNS name to query;
  • type - the record type to be queried (default is SOA);
  • timeout - the timeout for the request in seconds (default is 1 second);
  • count - the number of tries for the request (default is 2);
  • protocol - the protocol used to perform DNS queries: udp (default) or tcp;
  • flags - one or more comma-separated arguments to pass to a query.

Comments:

  • The possible values for type are: A, NS, MD, MF, CNAME, SOA, MB, MG, MR, NULL, PTR, HINFO, MINFO, MX, TXT, RP, AFSDB, X25, ISDN, RT, NSAPPTR, SIG, KEY, PX, GPOS, AAAA, LOC, NXT, EID, NIMLOC, SRV, ATMA, NAPTR, KX, CERT, DNAME, OPT, APL, DS, SSHFP, IPSECKEY, RRSIG, NSEC, DNSKEY, DHCID, NSEC3, NSEC3PARAM, TLSA, SMIMEA, HIP, NINFO, RKEY, TALINK, CDS, CDNSKEY, OPENPGPKEY, CSYNC, ZONEMD, SVCB, HTTPS, SPF, UINFO, UID, GID, UNSPEC, NID, L32, L64, LP, EUI48, EUI64, URI, CAA, AVC, AMTRELAY. Note that values must be in uppercase only; lowercase or mixed case values are not supported.
  • For reverse DNS lookups (when type is set to PTR), you can provide the DNS name in both reversed and non-reversed format (see examples below). Note that when PTR record is requested, the DNS name is actually an IP address.
  • The possible values for flags are: cdflag or nocdflag (default), rdflag (default) or nordflag, dnssec or nodnssec (default), nsid or nonsid (default), edns0 (default) or noedns0, aaflag or noaaflag (default), adflag or noadflag (default). The flags dnssec and nsid cannot be used together with noedns0, as both require edns0. Note that values must be in lowercase only; uppercase case or mixed case values are not supported.
  • Internationalized domain names are not supported, please use IDNA encoded names instead.
  • The output is an object containing DNS record information based on the parameters provided (see more details).

Examples:

net.dns.get[192.0.2.0,zabbix.com,DNSKEY,3,3,tcp,"cdflag,rdflag,nsid"]
       
       net.dns[,198.51.100.1,PTR,,,,"cdflag,rdflag,nsid"]
       net.dns[,1.100.51.198.in-addr.arpa,PTR,,,,"cdflag,rdflag,nsid"]
       
       net.dns[,2a00:1450:400f:800::200e,PTR,,,,"cdflag,rdflag,nsid"]
       net.dns[,e.0.0.2.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.0.f.0.0.4.0.5.4.1.0.0.a.2.ip6.arpa,PTR,,,,"cdflag,rdflag,nsid"]
oracle.diskgroups.stats[connString,<user>,<password>,<service>,<diskgroup>]


Returns the Automatic Storage Management (ASM) disk groups statistics.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name;
  • diskgroup - the name of the ASM disk group to query.
oracle.diskgroups.discovery[connString,<user>,<password>,<service>]


Returns the list of ASM disk groups. Used for low-level discovery.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.archive.info[connString,<user>,<password>,<service>,<destination>]


The archive logs statistics.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name;
  • destination - the name of the destination to query.
oracle.cdb.info[connString,<user>,<password>,<service>,<database>]


The Container Databases (CDBs) information.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name;
  • destination - the name of the database to query.
oracle.custom.query[connString,<user>,<password>,<service>,queryName,<args...>]


The result of a custom query.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name;
  • queryName - the name of a custom query, must match SQL file name without an extension;
  • args - one or several comma-separated arguments to pass to the query.
oracle.datafiles.stats[connString,<user>,<password>,<service>]


Returns the data files statistics.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name;
  • diskgroup - the name of the ASM disk group to query.
oracle.db.discovery[connString,<user>,<password>,<service>]


Returns the list of databases. Used for low-level discovery.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.fra.stats[connString,<user>,<password>,<service>]


Returns the Fast Recovery Area (FRA) statistics.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.instance.info[connString,<user>,<password>,<service>]


The instance statistics.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.pdb.info[connString,<user>,<password>,<service>,<database>]


The Pluggable Databases (PDBs) information.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name;
  • destination - the name of the database to query.
oracle.pdb.discovery[connString,<user>,<password>,<service>]


Returns the list of PDBs. Used for low-level discovery.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.pga.stats[connString,<user>,<password>,<service>]


Returns the Program Global Area (PGA) statistics.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.ping[connString,<user>,<password>,<service>]


Test whether a connection to Oracle can be established.
Return value: 1 - the connection is successful; 0 - the connection is broken (if there is any error presented including AUTH and configuration issues).

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.proc.stats[connString,<user>,<password>,<service>]


Returns the processes statistics.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.redolog.info[connString,<user>,<password>,<service>]


The log file information from the control file.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.sga.stats[connString,<user>,<password>,<service>]


Returns the System Global Area (SGA) statistics.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.sessions.stats[connString,<user>,<password>,<service>,<lockMaxTime>]


Returns the sessions statistics.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name;
  • lockMaxTime - the maximum session lock duration in seconds to count the session as a prolongedly locked. Default: 600 seconds.
oracle.sys.metrics[connString,<user>,<password>,<service>,<duration>]


Returns a set of system metric values.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name;
  • duration - the capturing interval (in seconds) of system metric values. Possible values: 60 — long duration (default), 15 — short duration.
oracle.sys.params[connString,<user>,<password>,<service>]


Returns a set of system parameter values.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.ts.stats[connString,<user>,<password>,<service>,<tablespace>,<type>,<conname>]


Returns the tablespaces statistics.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name;
  • tablespace - name of the tablespace to query. Default (if left empty and type is set):
    - "TEMP" (if type is set to "TEMPORARY");
    - "USERS" (if type is set to "PERMANENT").
  • type - the type of the tablespace to query. Default (if tablespace is set): "PERMANENT".
  • conname - name of the container for which the information is required.

If tablespace, type, or conname is omitted, the item will return tablespace statistics for all matching containers (including PDBs and CDB).

oracle.ts.discovery[connString,<user>,<password>,<service>]


Returns a list of tablespaces. Used for low-level discovery.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
oracle.user.info[connString,<user>,<password>,<service>,<username>]


Returns Oracle user information.
Return value: JSON object.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name;
  • username - the username for which the information is needed. Lowercase usernames are not supported. Default: current user.
oracle.version[connString,<user>,<password>,<service>]


Returns the database server version.
Return value: String.

Parameters:

  • connString - the URI or session name;
  • user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  • password - the Oracle password;
  • service - the Oracle service name.
pgsql.autovacuum.count[uri,<username>,<password>,<database name>]


The number of autovacuum workers.
Return value: Integer.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.archive[uri,<username>,<password>,<database name>]


The information about archived files.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.bgwriter[uri,<username>,<password>,<database name>]


The combined number of checkpoints for the database cluster, broken down by checkpoint type.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.cache.hit[uri,<username>,<password>,<database name>]


The PostgreSQL buffer cache hit rate.
Return value: Float.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.connections[uri,<username>,<password>,<database name>]


Returns connections by type.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.custom.query[uri,<username>,<password>,queryName,<args...>]


Returns the result of a custom query.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • queryName - the name of a custom query, must match the SQL file name without an extension;
  • args - one or several comma-separated arguments to pass to a query.
pgsql.db.age[uri,<username>,<password>,<database name>]


The age of the oldest FrozenXID of the database.
Return value: Integer.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.db.bloating_tables[uri,<username>,<password>,<database name>]


The number of bloating tables per database.
Return value: Integer.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.db.discovery[uri,<username>,<password>,<database name>]


The list of PostgreSQL databases. Used for low-level discovery.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.db.size[uri,<username>,<password>,<database name>]


The database size in bytes.
Return value: Integer.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.dbstat[uri,<username>,<password>,<database name>]


Collects the statistics per database. Used for low-level discovery.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.dbstat.sum[uri,<username>,<password>,<database name>]


The summarized data for all databases in a cluster.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.locks[uri,<username>,<password>,<database name>]


The information about granted locks per database. Used for low-level discovery.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.oldest.xid[uri,<username>,<password>,<database name>]


The age of the oldest XID.
Return value: Integer.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.ping[uri,<username>,<password>,<database name>]


Tests whether a connection is alive or not.
Return value: 1 - the connection is alive; 0 - the connection is broken (if there is any error presented including AUTH and configuration issues).

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.queries[uri,<username>,<password>,<database name>,<time period>]


Queries metrics by execution time.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name;
  • timePeriod - the execution time limit for the count of slow queries (must be a positive integer).
pgsql.replication.count[uri,<username>,<password>]


The number of standby servers.
Return value: Integer.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials.
pgsql.replication.process[uri,<username>,<password>]


The flush lag, write lag and replay lag per each sender process.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials.
pgsql.replication.process.discovery[uri,<username>,<password>]


The replication process name discovery.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials.
pgsql.replication.recovery_role[uri,<username>,<password>]


The recovery status.
Return value: 0 - master mode; 1 - recovery is still in progress (standby mode).

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials.
pgsql.replication.status[uri,<username>,<password>]


The status of replication.
Return value: 0 - streaming is down; 1 - streaming is up; 2 - master mode.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials.
pgsql.replication_lag.b[uri,<username>,<password>]


The replication lag in bytes.
Return value: Integer.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials.
pgsql.replication_lag.sec[uri,<username>,<password>]


The replication lag in seconds.
Return value: Integer.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials.
pgsql.uptime[uri,<username>,<password>,<database name>]


The PostgreSQL uptime in milliseconds.
Return value: Float.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.version[uri,<username>,<password>,<database name>]


Returns PostgreSQL version.
Return value: String.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
pgsql.wal.stat[uri,<username>,<password>,<database name>]


The WAL statistics.
Return value: JSON object.

Parameters:

  • uri - the URI or session name;
  • username, password - the PostgreSQL credentials;
  • database name - the database name.
redis.config[connString,<password>,<pattern>]


Gets the configuration parameters of a Redis instance that match the pattern.
Return value: JSON - if a glob-style pattern was used; single value - if a pattern did not contain any wildcard character.

Parameters:

  • connString - the URI or session name;
  • password - the Redis password;
  • pattern - a glob-style pattern (* by default).
redis.info[connString,<password>,<section>]


Gets the output of the INFO command.
Return value: JSON - the output is serialized as JSON.

Parameters:

  • connString - the URI or session name;
  • password - the Redis password;
  • section - the section of information (default by default).
redis.ping[connString,<password>]


Test if a connection is alive or not.
Return value: 1 - the connection is alive; 0 - the connection is broken (if there is any error presented including AUTH and configuration issues).

Parameters:

  • connString - the URI or session name;
  • password - the Redis password.
redis.slowlog.count[connString,<password>]


The number of slow log entries since Redis was started.
Return value: Integer.

Parameters:

  • connString - the URI or session name;
  • password - the Redis password.
smart.attribute.discovery


Returns a list of S.M.A.R.T. device attributes.
Return value: JSON object.

Comments:

  • The following macros and their values are returned: {#NAME}, {#DISKTYPE}, {#ID}, {#ATTRNAME}, {#THRESH};
  • HDD, SSD and NVME drive types are supported. Drives can be alone or combined in a RAID. {#NAME} will have an add-on in case of RAID, e.g: {"{#NAME}": "/dev/sda cciss,2"}.
smart.disk.discovery


Returns a list of S.M.A.R.T. devices.
Return value: JSON object.

Comments:

  • The following macros and their values are returned: {#NAME}, {#DISKTYPE}, {#MODEL}, {#SN}, {#PATH}, {#ATTRIBUTES}, {#RAIDTYPE};
  • HDD, SSD and NVME drive types are supported. If a drive does not belong to a RAID, the {#RAIDTYPE} will be empty. {#NAME} will have an add-on in case of RAID, e.g: {"{#NAME}": "/dev/sda cciss,2"}.
smart.disk.get[<path>,<raid type>]


Returns all available properties of S.M.A.R.T. devices.
Return value: JSON object.

Parameters:

  • path - the disk path, the {#PATH} macro may be used as a value;
  • raid_type - the RAID type, the {#RAID} macro may be used as a value

Comments:

  • HDD, SSD and NVME drive types are supported. Drives can be alone or combined in a RAID;
  • The data includes smartctl version and call arguments, and additional fields:
    disk_name - holds the name with the required add-ons for RAID discovery, e.g: {"disk_name": "/dev/sda cciss,2"}
    disk_type - holds the disk type HDD, SSD, or NVME, e.g: {"disk_type": "ssd"};
  • If no parameters are specified, the item will return information about all disks.
systemd.unit.get[unit name,<interface>]


Returns all properties of a systemd unit.
Return value: JSON object.

Parameters:

  • unit name - the unit name (you may want to use the {#UNIT.NAME} macro in item prototype to discover the name);
  • interface - the unit interface type, possible values: Unit (default), Service, Socket, Device, Mount, Automount, Swap, Target, Path.

Comments:

  • This item is supported on Linux platform only;
  • LoadState, ActiveState and UnitFileState for Unit interface are returned as text and integer: "ActiveState":{"state":1,"text":"active"}.
systemd.unit.info[unit name,<property>,<interface>]


A systemd unit information.
Return value: String.

Parameters:

  • unit name - the 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 - the unit interface type (e.g. Unit (default), Socket, Service).

Comments:

  • This item is supported on Linux platform only;
  • This item allows to retrieve a specific property from specific type of interface as described in dbus API.

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 the service technical name (mysqld.service)
       systemd.unit.info[mysqld.service,Description] #retrieve the service description (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.
Return value: JSON object.

Parameter:

  • type - possible values: all, automount, device, mount, path, service (default), socket, swap, target.

This item is supported on Linux platform only.

web.certificate.get[hostname,<port>,<address>]


Validates the certificates and returns certificate details.
Return value: JSON object.

Parameter:

  • hostname - can be either IP or DNS.
    May contain the URL scheme (https only), path (it will be ignored), and port.
    If a port is provided in both the first and the second parameters, their values must match.
    If address (the 3rd parameter) is specified, the hostname is only used for SNI and hostname verification;
  • port - the port number (default is 443 for HTTPS);
  • address - can be either IP or DNS. If specified, it will be used for connection, and hostname (the 1st parameter) will be used for SNI, and host verification. In case, the 1st parameter is an IP and the 3rd parameter is DNS, the 1st parameter will be used for connection, and the 3rd parameter will be used for SNI and host verification.

Comments:

  • This item turns unsupported if the resource specified in host does not exist or is unavailable or if TLS handshake fails with any error except an invalid certificate;
  • Currently, AIA (Authority Information Access) X.509 extension, CRLs and OCSP (including OCSP stapling), Certificate Transparency, and custom CA trust store are not supported.