1 Zabbix agent 2

Zabbix agent 2支持Zabbix agent在Unix和Windows上支持的所有监控项键。本页提供了专门用于Zabbix agent 2的附加监控项键的详细信息，这些键按其所属的插件分组。

监控项键列出不带参数和其他信息。单击监控项键以查看完整详情。

另请参阅：

• 内置插件
• 可加载插件

监控项键值详情

没有尖括号的参数是必填的。带有尖括号 < > 的参数是可选的。

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

集群的数据使用情况和在各个池之间的分布。

返回值：JSON 对象。

参数：

• connString：URI 或会话名称；
• user, password：Ceph 登录凭据。

ceph.osd.stats[connString,<user>,<apikey>]

汇总和每个 OSD 的统计信息。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - Ceph 登录凭据。

ceph.osd.discovery[connString,<user>,<apikey>]

已发现 OSD 的列表。用于低级别发现。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - Ceph 登录凭据。

ceph.osd.dump[connString,<user>,<apikey>]

OSD 的使用阈值和状态。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - Ceph 登录凭据。

ceph.ping[connString,<user>,<apikey>]

测试是否可以建立到 Ceph 的连接。

返回值：0 - 连接断开（如果出现任何错误，包括 AUTH 和配置问题）；1 - 连接成功。

参数：

• connString - URI 或会话名称；
• user, password - Ceph 登录凭据。

ceph.pool.discovery[connString,<user>,<apikey>]

已发现池的列表。用于低级别发现。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
  
• user, password - Ceph 登录凭据。
  

ceph.status[connString,<user>,<apikey>]

集群的总体状态。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - Ceph 登录凭据。

docker.container_info[<ID>,<info>]

容器的低级信息。

返回值：序列化为 JSON 的 ContainerInspect API 调用的输出。

参数：

• ID - 容器的 ID 或名称；
• info - 返回信息的量。支持的值：short（默认）或 full。

Agent 2 用户（'zabbix'）必须被添加到 'docker' 组中以获得足够的权限，否则检查将失败。

docker.container_stats[<ID>]

容器资源使用统计信息。

返回值：序列化为 JSON 的 ContainerStats API 调用的输出和 CPU 使用百分比。

参数：

• ID - 容器的 ID 或名称。

Agent 2 用户（'zabbix'）必须被添加到 'docker' group中以获得足够的权限，否则检查将失败。

docker.containers

容器列表。

返回值：序列化为 JSON 的 ContainerList API 调用的输出。

Agent 2 用户（'zabbix'）必须被添加到 'docker' group中以获得足够的权限，否则检查将失败。

docker.containers.discovery[<options>]

返回容器列表。用于低级别发现。

返回值：JSON 对象。

参数：

• options - 指定是否应发现所有容器或仅运行中的容器。支持的值：true - 返回所有容器；false - 仅返回运行中的容器（默认）。

Agent 2 用户（'zabbix'）必须被添加到 'docker' group中以获得足够的权限，否则检查将失败。

docker.data.usage

当前数据使用情况的信息。

返回值：序列化为 JSON 的 SystemDataUsage API 调用的输出。

Agent 2 用户（'zabbix'）必须被添加到 'docker' group中以获得足够的权限，否则检查将失败。

docker.images

返回镜像列表。

返回值：序列化为 JSON 的 ImageList API 调用的输出。

Agent 2 用户（'zabbix'）必须被添加到 'docker' group中以获得足够的权限，否则检查将失败。

docker.images.discovery

返回镜像列表。用于低级别发现。

返回值：JSON 对象。

Agent 2 用户（'zabbix'）必须被添加到 'docker' group中以获得足够的权限，否则检查将失败。

docker.info

系统信息。

返回值：序列化为 JSON 的 SystemInfo API 调用的输出。

Agent 2 用户（'zabbix'）必须被添加到 'docker' group中以获得足够的权限，否则检查将失败。

docker.ping

测试 Docker 守护进程是否存活。

返回值：1 - 连接存活；0 - 连接断开。

Agent 2 用户（'zabbix'）必须被添加到 'docker' group中以获得足够的权限，否则检查将失败。

ember.get[<uri>,<path>]

返回所需设备的结果。

返回值：JSON 对象。

参数：

• uri - Ember+ 设备 URI。默认为 127.0.0.1:9998；
• path - 设备的 OID 路径。默认为空，返回根集合数据。

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

测试连接是否存活。

返回值：1 - 连接存活；0 - 连接断开（如果出现任何错误，包括 AUTH 和配置问题）。

参数：

• connString - URI 或会话名称；
• user, password - Memcached 登录凭据。

memcached.stats[connString,<user>,<password>,<type>]

获取 STATS 命令的输出。

返回值：JSON - 输出被序列化为 JSON。

参数：

• connString - URI 或会话名称；
• user, password - Memcached 登录凭据；
• type - 要返回的统计类型：items、sizes、slabs 或 settings（默认为空，返回一般统计信息）。

mongodb.collection.stats[connString,<user>,<password>,<database>,collection]

返回给定集合的各种存储统计信息。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据；
• database - 数据库名称（默认为 admin）；
• collection - 集合名称。

mongodb.collections.discovery[connString,<user>,<password>]

返回已发现集合的列表。用于低级别发现。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据。

mongodb.collections.usage[connString,<user>,<password>]

返回集合的使用统计信息。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据。

mongodb.connpool.stats[connString,<user>,<password>]

返回有关当前数据库实例向分片集群或副本集中其他成员的打开传出连接的信息。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据；
• database - 数据库名称（默认为 admin）；
• collection - 集合名称。

mongodb.db.stats[connString,<user>,<password>,<database>]

返回反映给定数据库系统状态的统计信息。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据；
• database - 数据库名称（默认为 admin）。

mongodb.db.discovery[connString,<user>,<password>]

返回已发现数据库的列表。用于低级别发现。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据。

mongodb.jumbo_chunks.count[connString,<user>,<password>]

返回超大块的计数。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据。

mongodb.oplog.stats[connString,<user>,<password>]

使用从 oplog 中获取的数据返回副本集的状态。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据。

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

测试连接是否存活。

返回值：1 - 连接存活；0 - 连接断开（如果出现任何错误，包括 AUTH 和配置问题）。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据。

mongodb.rs.config[connString,<user>,<password>]

返回副本集的当前配置。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据。

mongodb.rs.status[connString,<user>,<password>]

从运行方法的成员的角度返回副本集的状态。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据。

mongodb.server.status[connString,<user>,<password>]

返回数据库状态。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据。

mongodb.sh.discovery[connString,<user>,<password>]

返回集群中存在的已发现 shard 的列表。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据。

mongodb.version[connString,<user>,<password>]

返回数据库服务器版本。

返回值：字符串。

参数：

• connString - URI 或会话名称；
• user, password - MongoDB 登录凭据。

mqtt.get[<broker url>,topic,<user>,<password>]

订阅提供的代理的特定主题或主题（带通配符）并等待发布。

返回值：取决于主题内容。如果使用通配符，则返回主题内容为 JSON。

参数：

• broker url - MQTT 代理 URL，格式为 protocol://host:port，不包括查询参数（支持的协议：tcp、ssl、ws）。如果未指定值，代理将使用 tcp://localhost:1883。如果省略了协议或端口，则使用默认协议（tcp）或端口（1883）；
  
• topic - MQTT 主题（必填）。支持通配符（+、#）；
  
• user, password - 认证凭据（如果需要）。
  

注释：

• 监控项必须配置为主动检查（'Zabbix agent (active)' 监控项类型）；
• 可以通过将它们保存到默认位置（例如 Ubuntu 的 /etc/ssl/certs/ 目录）来使用 TLS 加密证书。对于 TLS，请使用 tls:// 方案。

mssql.availability.group.get[URI,<user>,<password>]

返回可用性组。

返回值：JSON 对象。

参数：

• URI - MSSQL 服务器 URI（唯一支持的模式是 sqlserver://）。嵌入式凭据将被忽略；
• user, password - 发送到受保护的 MSSQL 服务器的用户名、密码。

有关更多信息，请参阅MSSQL 插件的自述文件。

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

返回自定义查询的结果。

返回值：JSON 对象。

参数：

• URI - MSSQL 服务器 URI（唯一支持的模式是 sqlserver://）。嵌入式凭据将被忽略；
• user, password - 发送到受保护的 MSSQL 服务器的用户名、密码；
• queryName - 配置在 Plugins.MSSQL.CustomQueriesDir 中的自定义查询的名称，不包括 .sql 扩展名；
• args - 一个或多个逗号分隔的参数，传递给查询。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.db.get

返回所有可用的 MSSQL 数据库。

返回值：JSON 对象。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.job.status.get

返回作业的状态。

返回值：JSON 对象。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.last.backup.get

返回所有数据库的最后备份时间。

返回值：JSON 对象。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.local.db.get

返回参与 Always On 可用性组和副本（主要或次要）并位于建立连接的服务器上的数据库。

返回值：JSON 对象。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.mirroring.get

返回镜像信息。

返回值：JSON 对象。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.nonlocal.db.get

返回参与 Always On 可用性组和副本（主要或次要）并位于其他服务器上（数据库不是连接建立到的 SQL Server 实例的本地数据库）的数据库。

返回值：JSON 对象。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.perfcounter.get

返回性能计数器。

返回值：JSON 对象。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.ping

对数据库进行 ping。测试连接是否正确配置。

返回值：1 - 存活，0 - 不存活。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.quorum.get

返回仲裁信息。

返回值：JSON 对象。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.quorum.member.get

返回仲裁成员。

返回值：JSON 对象。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.replica.get

返回副本。

返回值：JSON 对象。

有关更多信息，请参阅MSSQL 插件的自述文件。

mssql.version

返回 MSSQL 版本。

返回值：字符串。

有关更多信息，请参阅MSSQL 插件的自述文件。

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

返回自定义查询的结果。

返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL 登录凭据；
  
• queryName - 自定义查询的名称，必须与没有扩展名的 SQL 文件名匹配；
  
• args - 一个或多个逗号分隔的参数，传递给查询。

mysql.db.discovery[connString,<user>,<password>]

返回 MySQL 数据库的列表。用于低级发现。

返回值：以LLD JSON格式呈现的"show databases" SQL查询的结果。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL 登录凭据。
  

mysql.db.size[connString,<user>,<password>,<database name>]

数据库大小（字节）。

返回值：针对特定数据库的"select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?" SQL查询的结果，以字节为单位。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL 登录凭据；
  
• database name - 数据库名称。

mysql.get_status_variables[connString,<user>,<password>]

全局状态变量的值。

返回值：以 JSON 格式呈现的"show global status" SQL 查询的结果。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL 登录凭据。
  

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

测试连接是否存活。

返回值：1 - 连接存活；0 - 连接中断（如果出现任何错误，包括 AUTH 和配置问题）。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL 登录凭据。
  

mysql.replication.discovery[connString,<user>,<password>]

返回 MySQL 复制的列表。用于低级发现。

返回值：以LLD JSON格式呈现的"show slave status" SQL查询的结果。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL 登录凭据。
  

mysql.replication.get_slave_status[connString,<user>,<password>,<master host>]

复制状态。

返回值：以 JSON 格式呈现的"show slave status" SQL 查询的结果。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL 登录凭据；
  
• master host - 复制主机名称。如果找不到，则返回错误。如果未指定此参数，则返回所有主机。
  

mysql.version[connString,<user>,<password>]

MySQL 版本。

返回值：字符串（包含 MySQL 实例的版本号）。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL 登录凭据。
  

net.dns.get[<ip>,name,<type>,<timeout>,<count>,<protocol>,"<flags>"]

执行DNS查询并返回详细的DNS记录信息。
此项是 net.dns.record Zabbix agent项的扩展版本，支持更多的记录类型和可定制的标志。
返回值：JSON对象

参数：

• ip - DNS服务器的IP地址（留空使用默认DNS服务器）；
• name - 要查询的DNS名称；
• type - 要查询的记录类型（默认为SOA）；
• timeout - 请求的超时时间，单位为秒（默认为1秒）；
• count - 请求的尝试次数（默认为2次）；
• protocol - 用于执行DNS查询的协议：udp（默认）或 tcp；
• flags - 传递给查询的一个或多个逗号分隔的参数。

注解：

• type 的可能值包括：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。 请注意，值必须全部为大写；不支持小写或混合大小写的值。
• 对于反向DNS查找（当 type 设置为 PTR 时），可以提供反向和非反向格式的DNS名称（请参阅下面的示例）。 请注意，当请求PTR记录时，DNS名称实际上是一个IP地址。
• flags 的可能值包括：cdflag 或 nocdflag（默认），rdflag（默认）或 nordflag，dnssec 或 nodnssec（默认），nsid 或 nonsid（默认），edns0（默认）或 noedns0，aaflag 或 noaaflag（默认），adflag 或 noadflag（默认）。 flags dnssec 和 nsid 不能与 noedns0 一起使用，因为两者都需要 edns0。 请注意，值必须全部为小写；不支持大写或混合大小写的值。
• 不支持国际化域名，请使用IDNA编码的名称。
• 输出是一个包含基于提供的参数的DNS记录信息的对象（请参阅更多细节）。

示例：

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>]

返回自动存储管理（ASM）磁盘组统计信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称；
• diskgroup - 要查询的 ASM 磁盘组的名称。

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

返回 ASM 磁盘组的列表。用于低级发现。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称。

oracle.archive.info[connString,<user>,<password>,<service>,<destination>]

归档日志统计信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称；
• destination - 要查询的目的地的名称。

oracle.cdb.info[connString,<user>,<password>,<service>,<database>]

容器数据库（CDBs）信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称；
• destination - 要查询的数据库的名称。

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

自定义查询的结果。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称；
• queryName - 自定义查询的名称，必须与没有扩展名的 SQL 文件名匹配；
• args - 要传递给查询的一个或多个逗号分隔的参数。

oracle.datafiles.stats[connString,<user>,<password>,<service>]

返回数据文件统计信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称；
• diskgroup - 要查询的 ASM 磁盘组的名称。

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

返回数据库列表。用于低级发现。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称。

oracle.fra.stats[connString,<user>,<password>,<service>]

返回快速恢复区（FRA）统计信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称。

oracle.instance.info[connString,<user>,<password>,<service>]

实例统计信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称。

oracle.pdb.info[connString,<user>,<password>,<service>,<database>]

可插入数据库（PDBs）信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称；
• destination - 要查询的数据库的名称。

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

返回PDB（可插入数据库）列表。用于低级发现。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称。

oracle.pga.stats[connString,<user>,<password>,<service>]

返回程序全局区域（PGA）统计信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称。

oracle.ping[connString,<user>,<password>,<service>]

测试是否可以建立到 Oracle 的连接。
返回值：1 - 连接成功；0 - 连接中断（如果出现任何错误，包括 AUTH 和配置问题）。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称。

oracle.proc.stats[connString,<user>,<password>,<service>]

返回进程统计信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称。

oracle.redolog.info[connString,<user>,<password>,<service>]

来自控制文件的日志文件信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称。

oracle.sga.stats[connString,<user>,<password>,<service>]

返回系统全局区域（SGA）统计信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称。

oracle.sessions.stats[connString,<user>,<password>,<service>,<lockMaxTime>]

返回会话统计信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
• user - Oracle 用户名，支持以 user as sysdba 格式附加登录选项 as sysdba、as sysoper 或 as sysasm 中的一个（登录选项不区分大小写，不能包含尾随空格）；
• password - Oracle 密码；
• service - Oracle 服务名称；
• lockMaxTime - 最长会话锁定持续时间，以秒计算，将会话视为长时间锁定。默认值：600 秒。

oracle.sys.metrics[connString,<user>,<password>,<service>,<duration>]

返回一组系统指标值。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
  
• user - Oracle 用户名，支持附加以下一种登录选项 as sysdba、as sysoper 或 as sysasm，格式为 user as sysdba（登录选项不区分大小写，不应包含尾随空格）；
  
• password - Oracle 密码；
  
• service - Oracle 服务名称；
  
• duration - 捕获系统指标值的时间间隔（以秒为单位）。可能的值：60 — 长时间间隔（默认），15 — 短时间间隔。

oracle.sys.params[connString,<user>,<password>,<service>]

返回一组系统参数值。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
  
• user - Oracle 用户名，支持附加以下一种登录选项 as sysdba、as sysoper 或 as sysasm，格式为 user as sysdba（登录选项不区分大小写，不应包含尾随空格）；
  
• password - Oracle 密码；
  
• service - Oracle 服务名称。
  

oracle.ts.stats[connString,<user>,<password>,<service>,<tablespace>,<type>,<conname>]

返回表空间统计信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
  
• user - Oracle 用户名，支持附加以下一种登录选项 as sysdba、as sysoper 或 as sysasm，格式为 user as sysdba（登录选项不区分大小写，不应包含尾随空格）；
  
• password - Oracle 密码；
  
• service - Oracle 服务名称；
  
• tablespace - 要查询的表空间名称。默认值（如果留空且设置了 type）：
  - "TEMP"（如果 type 设置为 "TEMPORARY"）；
  - "USERS"（如果 type 设置为 "PERMANENT"）。
• type - 要查询的表空间类型。默认值（如果设置了 tablespace）："PERMANENT"。
• conname - 需要查询信息的容器名称。

如果省略 tablespace、type 或 conname，则此项将返回所有匹配容器（包括 PDB 和 CDB）的表空间统计信息。

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

返回表空间列表。用于低级发现。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
  
• user - Oracle 用户名，支持附加以下一种登录选项 as sysdba、as sysoper 或 as sysasm，格式为 user as sysdba（登录选项不区分大小写，不应包含尾随空格）；
  
• password - Oracle 密码；
  
• service - Oracle 服务名称。
  

oracle.user.info[connString,<user>,<password>,<service>,<username>]

返回 Oracle 用户信息。
返回值：JSON 对象。

参数：

• connString - URI 或会话名称；
  
• user - Oracle 用户名，支持附加以下一种登录选项 as sysdba、as sysoper 或 as sysasm，格式为 user as sysdba（登录选项不区分大小写，不应包含尾随空格）；
  
• password - Oracle 密码；
  
• service - Oracle 服务名称；
  
• username - 需要查询信息的用户名。不支持小写用户名。默认值：当前用户。

oracle.version[connString,<user>,<password>,<service>]

返回数据库服务器版本。
返回值：字符串。

参数：

• connString - URI 或会话名称；
  
• user - Oracle 用户名，支持附加以下一种登录选项 as sysdba、as sysoper 或 as sysasm，格式为 user as sysdba（登录选项不区分大小写，不应包含尾随空格）；
  
• password - Oracle 密码；
  
• service - Oracle 服务名称。
  

pgsql.autovacuum.count[uri,<username>,<password>,<database name>]

自动清理工作者的数量。
返回值：整数。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.archive[uri,<username>,<password>,<database name>]

归档文件的信息。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.bgwriter[uri,<username>,<password>,<database name>]

数据库集群按检查点类型分类的检查点总数。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.cache.hit[uri,<username>,<password>,<database name>]

PostgreSQL 缓冲区命中率。
返回值：浮点数。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.connections[uri,<username>,<password>,<database name>]

按类型返回连接数。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.custom.query[uri,<username>,<password>,queryName,<args...>]

返回自定义查询的结果。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• queryName - 自定义查询的名称，必须与 SQL 文件名（无扩展名）匹配；
  
• args - 一个或多个逗号分隔的参数，用于传递给查询。
  

pgsql.db.age[uri,<username>,<password>,<database name>]

数据库中最老的 FrozenXID 的年龄。
返回值：整数。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.db.bloating_tables[uri,<username>,<password>,<database name>]

每个数据库中膨胀表的数量。
返回值：整数。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.db.discovery[uri,<username>,<password>,<database name>]

PostgreSQL 数据库列表。用于低级发现。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.db.size[uri,<username>,<password>,<database name>]

数据库的大小，以字节为单位。
返回值：整数。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.dbstat[uri,<username>,<password>,<database name>]

收集每个数据库的统计信息。用于低级发现。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.dbstat.sum[uri,<username>,<password>,<database name>]

集群中所有数据库的汇总数据。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.locks[uri,<username>,<password>,<database name>]

每个数据库中已授予的锁信息。用于低级发现。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.oldest.xid[uri,<username>,<password>,<database name>]

最老 XID 的年龄。
返回值：整数。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.ping[uri,<username>,<password>,<database name>]

测试连接是否存活。
返回值：1 - 连接存活；0 - 连接中断（如果出现任何错误，包括认证和配置问题）。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.queries[uri,<username>,<password>,<database name>,<time period>]

按执行时间查询指标。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称；
  
• timePeriod - 慢查询计数的执行时间限制（必须是正整数）。

pgsql.replication.count[uri,<username>,<password>]

备库服务器的数量。
返回值：整数。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据。
  

pgsql.replication.process[uri,<username>,<password>]

每个发送进程的刷新延迟、写入延迟和重放延迟。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据。
  

pgsql.replication.process.discovery[uri,<username>,<password>]

复制进程名称发现。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据。
  

pgsql.replication.recovery_role[uri,<username>,<password>]

恢复状态。
返回值：0 - 主节点模式；1 - 正在进行恢复（备库模式）。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据。
  

pgsql.replication.status[uri,<username>,<password>]

复制状态。
返回值：0 - 流复制已停止；1 - 流复制正常工作；2 - 主节点模式。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据。
  

pgsql.replication_lag.b[uri,<username>,<password>]

复制延迟（以字节为单位）。
返回值：整数。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据。
  

pgsql.replication_lag.sec[uri,<username>,<password>]

复制延迟（以秒为单位）。
返回值：整数。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据。
  

pgsql.uptime[uri,<username>,<password>,<database name>]

PostgreSQL 运行时间，以毫秒为单位。
返回值：浮点数。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.version[uri,<username>,<password>,<database name>]

返回 PostgreSQL 版本。
返回值：字符串。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

pgsql.wal.stat[uri,<username>,<password>,<database name>]

WAL（Write-Ahead Logging）统计信息。
返回值：JSON 对象。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称。
  

redis.config[connString,<password>,<pattern>]

获取与指定模式匹配的 Redis 实例的配置参数。
返回值：JSON 对象（如果使用了通配符模式）；单个值（如果模式中没有包含任何通配符字符）。

参数：

• connString - URI 或会话名称；
  
• password - Redis 密码；
  
• pattern - glob 样式的模式（默认为 *）。
  

redis.info[connString,<password>,<section>]

获取 INFO 命令的输出。
返回值：JSON - 输出序列化为 JSON 格式。

参数：

• connString - URI 或会话名称；
  
• password - Redis 密码；
  
• section - 信息的部分（默认为 default）。详细参考 INFO 命令。
  

redis.ping[connString,<password>]

测试连接是否存活。
返回值：1 - 连接存活；0 - 连接中断（如果出现任何错误，包括认证和配置问题）。

参数：

• connString - URI 或会话名称；
  
• password - Redis 密码。
  

redis.slowlog.count[connString,<password>]

自 Redis 启动以来的慢日志条目数量。
返回值：整数。

参数：

• connString - URI 或会话名称；
  
• password - Redis 密码。
  

smart.attribute.discovery

返回一个S.M.A.R.T.设备属性列表。
返回值：JSON对象。

注释：

• 返回以下宏及其值：{#NAME}、{#DISKTYPE}、{#ID}、{#ATTRNAME}、{#THRESH}；
• 支持HDD、SSD和NVME驱动类型。驱动器可以是单独的，也可以是RAID组合的。在RAID情况下，{#NAME}会附加一个后缀，例如：{"{#NAME}": "/dev/sda cciss,2"}。

smart.disk.discovery

返回一个S.M.A.R.T.设备列表。
返回值：JSON对象。

注释：

• 返回以下宏及其值：{#NAME}、{#DISKTYPE}、{#MODEL}、{#SN}、{#PATH}、{#ATTRIBUTES}、{#RAIDTYPE}；
• 支持HDD、SSD和NVME驱动类型。如果驱动器不属于RAID，则{#RAIDTYPE}将为空。在RAID情况下，{#NAME}会附加一个后缀，例如：{"{#NAME}": "/dev/sda cciss,2"}。

smart.disk.get[<path>,<raid type>]

返回S.M.A.R.T.设备的所有可用属性。
返回值：JSON对象。

参数：

• path - 磁盘路径，可以使用{#PATH}宏作为值；
  
• raid_type - RAID类型，可以使用{#RAID}宏作为值。

注释：

• 支持HDD、SSD和NVME驱动类型。驱动器可以是单独的，也可以是RAID组合的；
  
• 数据包括smartctl版本和调用参数，以及额外的字段：
  disk_name - 包含RAID发现所需的名称及其附加信息，例如：{"disk_name": "/dev/sda cciss,2"}；
  disk_type - 包含磁盘类型 HDD、SSD或NVME，例如：{"disk_type": "ssd"}；
  
• 如果未指定参数，该项将返回关于所有磁盘的信息。

systemd.unit.get[unit name,<interface>]

返回一个systemd单元的所有属性。
返回值：JSON对象。

参数：

• unit name - 单元名称（您可以在监控项原型中使用{#UNIT.NAME}宏来发现名称）；
  
• interface - 单元接口类型，可能的取值：Unit（默认）、Service、Socket、Device、Mount、Automount、Swap、Target、Path。

注释：

• 此项仅在Linux平台上支持；
• 对于Unit接口，LoadState、ActiveState和UnitFileState以文本和整数形式返回："ActiveState":{"state":1,"text":"active"}。

systemd.unit.info[unit name,<property>,<interface>]

获取 systemd 单元的特定信息。
返回值：字符串。

参数：

• unit name - 单元名称（您可以在监控项原型中使用{#UNIT.NAME}宏来发现名称）；
  
• property - 单元属性（例如 ActiveState（默认）、LoadState、Description）；
  
• interface - 单元接口类型（例如 Unit（默认）、Socket、Service）。

注释：

• 此项仅在Linux平台上支持；
• 此项允许从特定类型的接口中检索特定属性，如dbus API中所述。

示例：

systemd.unit.info["{#UNIT.NAME}"] # 收集发现的 systemd 单元的活动状态（active, reloading, inactive, failed, activating, deactivating）信息
       systemd.unit.info["{#UNIT.NAME}", LoadState] # 收集发现的 systemd 单元的加载状态信息
       systemd.unit.info[mysqld.service, Id] # 检索服务的技术名称（mysqld.service）
       systemd.unit.info[mysqld.service, Description] # 检索服务的描述（MySQL Server）
       systemd.unit.info[mysqld.service, ActiveEnterTimestamp] # 检索服务最后进入活动状态的时间戳（1562565036283903）
       systemd.unit.info[dbus.socket, NConnections, Socket] # 收集此套接字单元的连接数

systemd.unit.discovery[<type>]

列出 systemd 单元及其详细信息。用于低级发现。
返回值：JSON对象。

参数：

• type - 可能的取值：all、automount、device、mount、path、service（默认）、socket、swap、target。

此监控项仅在Linux平台上支持。

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

验证证书并返回证书详情。
返回值：JSON对象。

参数：

• hostname - 可以是IP地址或域名。
  可以包含URL scheme（仅限https），路径（将被忽略）和端口。
  如果在第一个和第二个参数中都提供了端口，则它们的值必须匹配。
  如果指定了address（第三个参数），则主机名仅用于SNI和主机名验证；
  
• port - 端口号（默认为HTTPS的443端口）；
  
• address - 可以是IP地址或域名。如果指定了address，则将用于连接，并且主机名（第一个参数）将用于SNI和主机验证。如果第一个参数是IP而第三个参数是域名，则第一个参数将用于连接，第三个参数将用于SNI和主机验证。

注释：

• 如果指定的host中的资源不存在、不可用，或者TLS握手失败（除了无效证书之外的任何错误），则此监控项将不受支持；
  
• 目前不支持AIA（Authority Information Access）X.509扩展、CRLs和OCSP（包括OCSP stapling）、证书透明性以及自定义CA信任存储。