1 Zabbix agent 2

Zabbix agent 2 支持所有在 Unix 和 Windows 上用于 Zabbix agent 的 监控项 键。
本页面详细介绍了仅能与 Zabbix agent 2 一起使用的附加 监控项 键，并按所属插件进行分类。

列出的 监控项 键不包含参数和附加信息。
点击具体的 监控项 键以查看完整详情。

另请参阅：

• 内置
• 可加载

监控项 键详情

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

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

集群在存储池中的数据使用情况和分布。
返回值：JSON object。

参数：

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

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

聚合和每个OSD的统计信息。
返回值：JSON object。

参数：

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

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

发现的OSD列表。 用于 low-level discovery。
返回值：JSON object。

参数：

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

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

OSD的使用阈值和状态。
返回值：JSON object。

参数：

• connString - URI 或会话名称；
  
• user, password - Ceph login 的凭证。
  

ceph.ping[connString,<user>,<apikey>] {#ceph.ping}

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

参数：

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

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

发现的存储池列表。 用于 low-level discovery。
返回值：JSON object。

参数：

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

ceph.status[connString,<user>,<apikey>] {#ceph.status}

整个集群的状态。
返回值：JSON object。

参数：

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

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

容器的低级别信息。
返回值：以 JSON 格式序列化的 ContainerInspect API 调用输出。

参数：

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

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

docker.container_stats[<ID>]

容器资源使用统计信息。
返回值：ContainerStats API 调用的输出以及序列化为 JSON 的 CPU 使用百分比。

参数：

• ID - 容器的 ID 或名称。

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

docker.containers

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

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

docker.containers.discovery[<选项>]

返回容器列表。 用于 low-level discovery。
返回值：JSON object。

参数：

• options - 指定是返回所有容器还是仅返回正在运行的容器。 支持的值：true - 返回所有容器；false - 仅返回正在运行的容器（默认值）。

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

Docker数据使用情况

关于当前数据使用情况的信息。
返回值：SystemDataUsage API 调用输出的JSON序列化结果。

Agent 2 用户('zabbix')必须被添加到'docker' group组以获得足够权限。 否则检查将失败。

docker.images

返回镜像列表。
返回值：输出 ImageList API 调用的结果，序列化为 JSON 格式。

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

docker.images.discovery

返回图像列表。 用于 low-level discovery。
返回值：JSON object。

运行检查的 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 object。

参数：

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

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

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

参数：

• connString - URI 或会话名称；
  
• user, password - Memcached login 认证凭据。
  

memcached.stats[连接字符串,<用户名>,<密码>,<类型>]

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

参数：

• connString - URI或会话名称；
  
• user, password - Memcached login 凭据；
  
• type - 要返回的统计类型：监控项、sizes、slabs 或 settings（默认为空，返回通用统计信息）。

MongoDB集合统计信息监控项用于获取指定MongoDB集合的统计信息。语法如下：

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

• connString：MongoDB的连接字符串。
• <user>：连接MongoDB所需的用户名（可选）。
• <password>：连接MongoDB所需的密码（可选）。
• <database>：要查询的数据库名称（可选）。
• collection：要获取统计信息的集合名称。

该监控项返回的值包含集合的统计信息，例如文档数量、存储大小等。

此监控项通常用于自动发现MongoDB集合，并为每个集合创建监控项和触发器，以实现对MongoDB集合性能的全面监控。

返回给定集合的多种存储统计信息。
返回值：JSON object。

参数：

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

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

返回发现集合的列表。 用于 low-level discovery。
返回值：JSON object。

参数：

• connString - URI 或会话名称；
  
• user, password - MongoDB login 的凭证。
  

MongoDB集合使用情况监控[connString,<user>,<password>]

返回集合的使用统计信息。
返回值：JSON object。

参数：

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

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

返回有关当前数据库实例到分片集群或副本集其他成员的开放传出连接的信息。
返回值：JSON object。

参数：

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

MongoDB数据库统计信息[mongodb.db.stats]

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

参数：

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

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

返回发现的数据库列表。 用于 low-level discovery。
返回值：JSON object。

参数：

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

mongodb.jumbo_chunks.count[connString,<user>,<password>] {#mongodb.jumbo.chunks.count}

返回巨型块的数量。
返回值: JSON object。

参数:

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

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

使用从oplog轮询的数据返回副本集的状态。
返回值：JSON object。

参数：

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

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

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

参数：

• connString - URI 或会话名称；
  
• user, password - MongoDB login 认证凭据。
  

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

返回副本集的当前配置。
返回值：JSON object。

参数：

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

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

返回运行该方法的成员视角下的副本集状态。
返回值：JSON object。

参数：

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

MongoDB服务器状态检查 mongodb.server.status[connString,<user>,<password>]

返回数据库状态。
返回值：JSON object。

参数：

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

mongodb.sh.discovery[connString,<用户>,<密码>] {#mongodb.sh.discovery}

返回集群中存在的已发现分片列表。
返回值：JSON object。

参数：

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

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

返回数据库服务器版本。
返回值：string。

参数：

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

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

订阅提供的代理中的特定主题或多个主题（支持通配符），并等待发布。
返回值：根据主题内容而定。 如果使用了通配符，则返回主题内容为 JSON 格式。

参数：

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

注释：

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

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

返回可用性组.
返回值: JSON object.

参数:

• URI - MSSQL服务器URI(唯一支持的协议是sqlserver://). 嵌入式凭据将被忽略. 从Zabbix 7.0.6开始,可以在URI中指定实例名称,例如:sqlserver://localhost/InstanceName(无端口). 如果指定了端口,则忽略实例名称;
  
• user, password - 发送到受保护MSSQL服务器的用户名和密码.
  

更多信息请参阅MSSQL plugin自述文件.

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

返回自定义query的执行结果。
返回值：JSON object。

参数：

• URI - MSSQL服务器URI（唯一支持的协议是sqlserver://）。 嵌入式凭据将被忽略。 从Zabbix 7.0.6开始，可以在URI中指定实例名称，例如：sqlserver://localhost/InstanceName（无端口号）。 如果指定了端口号，则实例名称将被忽略；
  
• user, password - 发送给受保护MSSQL服务器的用户名和密码；
  
• queryName - 在Plugins.MSSQL.CustomQueriesDir中配置的自定义query名称（不带.sql扩展名）；
  
• args - 传递给query的一个或多个逗号分隔参数。

更多信息请参阅MSSQL plugin自述文件。

mssql.db.get

返回所有可用的MSSQL数据库.
返回值: JSON object.

更多信息请参阅MSSQL plugin自述文件.

mssql.job.status.get

返回作业状态.
返回值: JSON object.

更多信息请参阅MSSQL plugin自述文件.

mssql.last.backup.get

返回所有数据库的最后备份时间.
返回值: JSON object.

更多信息请参阅 MSSQL plugin 自述文件.

mssql.local.db.get

返回参与Always On可用性组且位于已建立连接的服务器上的数据库副本（主副本或辅助副本）
返回值：JSON object

更多信息请参阅MSSQL plugin自述文件

mssql.mirroring.get

返回镜像信息.
返回值: JSON object.

更多信息请参阅MSSQL plugin自述文件.

mssql.nonlocal.db.get

返回参与Always On可用性组且位于其他服务器上的数据库副本（主副本或辅助副本）（该数据库并非连接到的SQL Server实例的本地数据库）。
返回值：JSON object。

更多信息请参阅MSSQL plugin自述文件。

mssql.perfcounter.get

返回性能计数器.
返回值: JSON object.

更多信息请参阅MSSQL plugin自述文件.

mssql.ping

对数据库执行Ping测试. 验证连接配置是否正确.
返回值: 1 - 存活, 0 - 无响应.

更多信息请参阅MSSQL plugin自述文件.

mssql.quorum.get

返回仲裁信息.
返回值: JSON object.

更多信息请参阅MSSQL plugin自述文件.

mssql.quorum.member.get

返回仲裁成员.
返回值: JSON object.

更多信息请参阅 MSSQL plugin 自述文件.

mssql.replica.get

返回副本.
返回值: JSON object.

更多信息请参阅 MSSQL plugin 自述文件.

mssql.version

返回MSSQL version.
返回值: string.

更多信息请参阅MSSQL plugin自述文件.

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

返回自定义query的执行结果.
返回值: JSON object.

参数:

• connString - 连接URI或会话名称;
  
• user, password - MySQL login认证凭据;
  
• queryName - 自定义query名称,必须与不带扩展名的SQL file名称匹配;
  
• args - 传递给query的一个或多个逗号分隔参数.

更多信息请参阅MySQL plugin自述文件.

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

返回 MySQL 数据库的列表。 用于 low-level discovery。
返回值：以 LLD JSON 格式返回 "show databases" SQL query 的执行结果。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL login 的认证凭据。
  

MySQL数据库大小监控项，用于获取指定数据库的大小。

语法：

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

以字节为单位的数据库大小。
返回值：以特定数据库为对象，执行 "select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?" SQL query 所得到的结果。

参数：

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

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

全局状态变量的值。
返回值：以JSON格式返回“show global status” SQL query 的结果。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL login 的凭证。
  

mysql.ping[connString,<user>,<password>] {#mysql.ping}

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

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL login凭证。
  

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

返回 MySQL 复制列表。 用于 low-level discovery。
返回值：以 LLD JSON 格式返回 "show slave status" SQL query 的结果。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL login 的凭证。
  

mysql.replication.get_slave_status[connString,<user>,<password>,<主服务器 主机>]

复制状态。
返回值：以 JSON 格式返回 "show slave status" SQL query 的结果。

参数：

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

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

MySQL 的版本。
返回值：string（包含 MySQL 实例版本）。

参数：

• connString - URI 或会话名称；
  
• user, password - MySQL login 的凭证。
  

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

执行DNS query 并返回详细的DNS记录信息。
此 监控项 是 net.dns.record Zabbix agent 监控项 的扩展 version，支持更多记录类型和可自定义的标志。
返回值：JSON object

参数：

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

备注：

• 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编码的名称。
• 输出是一个 object，包含基于所提供参数的DNS记录信息（参见 more details）。

示例：

net.dns.get[192.0.2.0,example.com,DNSKEY,3,3,tcp,"cdflag,rdflag,nsid"]

net.dns.get[,198.51.100.1,PTR,,,,"cdflag,rdflag,nsid"]
net.dns.get[,1.100.51.198.in-addr.arpa,PTR,,,,"cdflag,rdflag,nsid"]

net.dns.get[,2a00:1450:400f:800::200e,PTR,,,,"cdflag,rdflag,nsid"]
net.dns.get[,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 object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到具有给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false. 如果包含模式(例如"tcp://")、端口(例如1521)或两者，则ResolveTNS选项将不被考虑，无论如何都将被视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 如果ResolveTNS选项设置为true，且上述条件均不适用;
    
  • TNS值(自Zabbix 7.0.19起支持) - 如果以开括号"("开头(忽略前导空格). 在这种情况下，不考虑ResolveTNS选项.
    
• user - Oracle用户名，支持附加login选项之一as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm, 或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba, as sysoper, 或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称;
  
• diskgroup - 要query的ASM磁盘组名称.

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

返回ASM磁盘组列表。 用于low-level discovery。
返回值：JSON object。

参数：

• connString - 可以是：
  
  • URI - 如果未找到具有给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false。如果包含模式（如"tcp://"）、端口（如1521）或两者，则ResolveTNS选项将不被考虑，始终视为URI；
    
  • 会话名称 - 如果在插件配置file中找到该名称；
    
  • TNS键（自Zabbix 7.0.19起支持） - 如果ResolveTNS选项设置为true，且上述条件均不适用；
    
  • TNS值（自Zabbix 7.0.19起支持） - 如果以开括号“（”开头（忽略前导空格）。此时ResolveTNS选项不被考虑。
    
• user - Oracle用户名，支持附加login选项as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba（login选项不区分大小写，不得包含尾随空格）。 注意在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项；
  
• password - Oracle密码；
  
• service - Oracle服务名称。
  

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

归档日志统计信息.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到具有给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false。如果包含模式(例如"tcp://")、端口(例如1521)或两者，则ResolveTNS选项将被忽略，并始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 如果ResolveTNS选项设置为true，且上述条件均不适用;
    
  • TNS值(自Zabbix 7.0.19起支持) - 如果以开括号"("开头(忽略前导空格)。这种情况下ResolveTNS选项将被忽略.
    
• user - Oracle用户名，支持附加login选项之一as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称;
  
• destination - 要query的目标名称.

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

容器数据库(CDBs)信息.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到指定名称的会话，且Plugins.Oracle.ResolveTNS设为false。若包含模式(如"tcp://")、端口(如1521)或两者，则ResolveTNS选项将被忽略，始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 当ResolveTNS选项设为true且以上条件均不满足时;
    
  • TNS值(自Zabbix 7.0.19起支持) - 若以开括号"("开头(忽略前导空格)。此时ResolveTNS选项将被忽略.
    
• user - Oracle用户名，支持附加login选项as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称;
  
• destination - 要query的数据库名称.

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

自定义query的执行结果.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到指定名称的会话且Plugins.Oracle.ResolveTNS设为false. 若包含模式(如"tcp://")、端口(如1521)或两者, 则ResolveTNS选项将被忽略, 始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 若ResolveTNS选项设为true且不满足上述条件;
    
  • TNS值(自Zabbix 7.0.19起支持) - 若以开括号"("开头(忽略前导空格). 此时ResolveTNS选项将被忽略.
    
• user - Oracle用户名, 支持附加login选项as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm或as sysrac, 格式为user as sysdba(login选项不区分大小写且不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba, as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称;
  
• queryName - 自定义query的名称, 必须与SQL file名称(不含扩展名)匹配;
  
• args - 传递给query的一个或多个逗号分隔参数.

注释:

• 返回数据会自动转换为JSON格式.
• 避免直接从queries返回JSON, 因为当插件尝试再次将其转换为JSON时会导致数据损坏.

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

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

参数：

• connString - 可以是：
  
  • URI - 如果未找到具有给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false。如果包含模式（例如"tcp://"）、端口（例如1521）或两者，则ResolveTNS选项将不被考虑，并且无论如何都将被视为URI；
    
  • 会话名称 - 如果在插件配置file中找到此类名称；
    
  • TNS键（自Zabbix 7.0.19起支持） - 如果ResolveTNS选项设置为true，且上述条件均不适用；
    
  • TNS值（自Zabbix 7.0.19起支持） - 如果以开括号“（”开头（忽略前导空格）。在这种情况下，ResolveTNS选项不被考虑。
    
• user - Oracle用户名，支持附加login选项之一as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba（login选项不区分大小写，不得包含尾随空格）。 注意，在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项；
  
• password - Oracle密码；
  
• service - Oracle服务名称；
  
• diskgroup - 要query的ASM磁盘组名称。

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

返回数据库列表。 用于low-level discovery。
返回值：JSON object。

参数：

• connString - 可以是：
  
  • URI - 如果未找到给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false。若包含模式（如"tcp://"）、端口（如1521）或两者，则ResolveTNS选项将被忽略，始终视为URI；
    
  • 会话名称 - 如果在插件配置file中找到该名称；
    
  • TNS键（Zabbix 7.0.19起支持） - 若ResolveTNS选项设为true且不满足上述条件；
    
  • TNS值（Zabbix 7.0.19起支持） - 若以开括号"("开头（忽略前导空格）。此时ResolveTNS选项将被忽略。
    
• user - Oracle用户名，支持附加login选项as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba（login选项不区分大小写，不得包含尾随空格）。 注意Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项；
  
• password - Oracle密码；
  
• service - Oracle服务名称。
  

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

返回快速恢复区(FRA)统计信息.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到给定名称的会话且Plugins.Oracle.ResolveTNS设为false. 若包含模式(如"tcp://")、端口(如1521)或两者, 则ResolveTNS选项将被忽略, 始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 当ResolveTNS选项设为true且不满足上述条件时;
    
  • TNS值(自Zabbix 7.0.19起支持) - 若以开括号"("开头(忽略前导空格). 此时ResolveTNS选项将被忽略.
    
• user - Oracle用户名, 支持附加login选项as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm或as sysrac, 格式为user as sysdba(login选项不区分大小写, 不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba, as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称.
  

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

实例统计信息.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false。若包含模式(如"tcp://")、端口(如1521)或两者，则ResolveTNS选项将被忽略，始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 当ResolveTNS选项设为true且不满足上述条件时;
    
  • TNS值(自Zabbix 7.0.19起支持) - 若以开括号"("开头(忽略前导空格)。此时ResolveTNS选项将被忽略.
    
• user - Oracle用户名，支持附加login选项as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称.
  

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

可插拔数据库(PDBs)信息.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到指定名称的会话，且Plugins.Oracle.ResolveTNS设为false。若包含模式(如"tcp://")、端口(如1521)或两者，则ResolveTNS选项将被忽略，始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 当ResolveTNS选项设为true且不满足上述条件时;
    
  • TNS值(自Zabbix 7.0.19起支持) - 若以开括号"("开头(忽略前导空格)。此时ResolveTNS选项将被忽略.
    
• user - Oracle用户名，支持附加login选项as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称;
  
• destination - 要query的数据库名称.

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

返回PDB列表。 用于low-level discovery。
返回值：JSON object。

参数：

• connString - 可以是：
  
  • URI - 如果未找到具有给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false。如果包含模式（如"tcp://"）、端口（如1521）或两者，则ResolveTNS选项将不被考虑，无论如何都将被视为URI；
    
  • 会话名称 - 如果在插件配置file中找到该名称；
    
  • TNS键（自Zabbix 7.0.19起支持） - 如果ResolveTNS选项设置为true，且上述条件均不适用；
    
  • TNS值（自Zabbix 7.0.19起支持） - 如果以开括号“（”开头（忽略前导空格）。在这种情况下，ResolveTNS选项不被考虑。
    
• user - Oracle用户名，支持附加login选项之一as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba（login选项不区分大小写，不得包含尾随空格）。 注意，在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项；
  
• password - Oracle密码；
  
• service - Oracle服务名称。
  

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

返回程序全局区(PGA)统计信息.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false。如果包含模式(如"tcp://")、端口(如1521)或两者，则ResolveTNS选项将被忽略，始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 如果ResolveTNS选项设为true，且以上条件均不适用;
    
  • TNS值(自Zabbix 7.0.19起支持) - 如果以开括号"("开头(忽略前导空格)。此时ResolveTNS选项将被忽略.
    
• user - Oracle用户名，支持附加login选项as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称.
  

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

测试是否能够建立到Oracle的连接。
返回值：1 - 连接成功；0 - 连接失败（包括认证和配置问题在内的任何错误出现时）。

参数：

• connString - 可以是：
  
  • URI - 如果未找到给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false。如果包含模式（如"tcp://"）、端口（如1521）或两者，则ResolveTNS选项将被忽略，并被视为URI；
    
  • 会话名称 - 如果在插件配置file中找到该名称；
    
  • TNS键（自Zabbix 7.0.19起支持） - 如果ResolveTNS选项设置为true，且上述条件均不适用；
    
  • TNS值（自Zabbix 7.0.19起支持） - 如果以开括号"("开头（忽略前导空格）。此时ResolveTNS选项将被忽略。
    
• user - Oracle用户名，支持附加login选项之一as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba（login选项不区分大小写，不得包含尾随空格）。 注意，在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项；
  
• password - Oracle密码；
  
• service - Oracle服务名称。
  

示例：

oracle.ping[localhost,ZABBIX_MON,zabbix,xe]
oracle.ping[zbx_tns_example,ZABBIX_MON,zabbix,xe]
oracle.ping["(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe)))",ZABBIX_MON,zabbix]

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

返回进程统计信息.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到具有给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false. 如果包含模式(例如"tcp://")、端口(例如1521)或两者，则ResolveTNS选项将不被考虑，无论如何都将被视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 如果ResolveTNS选项设置为true，且上述条件均不适用;
    
  • TNS值(自Zabbix 7.0.19起支持) - 如果以开括号"("开头(忽略前导空格). 在这种情况下，ResolveTNS选项不被考虑.
    
• user - Oracle用户名，支持附加login选项之一as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称.
  

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

来自控制file的日志file信息.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false. 如果包含模式(如"tcp://")、端口(如1521)或两者，ResolveTNS选项将被忽略，并始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 如果ResolveTNS选项设为true，且以上条件均不适用;
    
  • TNS值(自Zabbix 7.0.19起支持) - 如果以开括号"("开头(忽略前导空格). 这种情况下ResolveTNS选项将被忽略.
    
• user - Oracle用户名，支持附加login选项之一as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba, as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称.
  

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

返回系统全局区(SGA)统计信息.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false. 如果包含模式(如"tcp://")、端口(如1521)或两者，则ResolveTNS选项将被忽略，始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 如果ResolveTNS选项设为true，且以上条件均不适用;
    
  • TNS值(自Zabbix 7.0.19起支持) - 如果以开括号"("开头(忽略前导空格). 此时ResolveTNS选项将被忽略.
    
• user - Oracle用户名，支持附加login选项as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称.
  

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

返回会话统计信息.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到指定名称的会话且Plugins.Oracle.ResolveTNS设为false. 若包含模式(如"tcp://")、端口(如1521)或两者, 则ResolveTNS选项将被忽略, 始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 当ResolveTNS选项设为true且不满足上述条件时;
    
  • TNS值(自Zabbix 7.0.19起支持) - 以开括号"("开头时(忽略前导空格). 此时ResolveTNS选项将被忽略.
    
• user - Oracle用户名, 支持附加login选项as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm或as sysrac, 格式为user as sysdba(login选项不区分大小写, 不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba, as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称;
  
• lockMaxTime - 将会话计为长时间锁定的最大锁定持续时间(秒). 默认值: 600秒.

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

返回一组系统指标值.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false. 如果包含模式(例如"tcp://")、端口(例如1521)或两者，则ResolveTNS选项将不被考虑，无论如何都将被视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 如果ResolveTNS选项设置为true，且上述条件均不适用;
    
  • TNS值(自Zabbix 7.0.19起支持) - 如果以开括号"("开头(忽略前导空格). 这种情况下不考虑ResolveTNS选项.
    
• user - Oracle用户名，支持附加login选项之一as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm, 或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba, as sysoper, 或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称;
  
• duration - 系统指标值的捕获间隔(秒). 可能值: 60 - 长间隔(默认), 15 - 短间隔.

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

返回一组系统参数值.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到指定名称的会话，且Plugins.Oracle.ResolveTNS设置为false. 若包含模式(如"tcp://")、端口(如1521)或两者，则ResolveTNS选项将被忽略，始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 当ResolveTNS选项设为true且不满足上述条件时;
    
  • TNS值(自Zabbix 7.0.19起支持) - 若以开括号"("开头(忽略前导空格). 此时ResolveTNS选项将被忽略.
    
• user - Oracle用户名，支持附加login选项as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称.
  

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

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

参数：

• connString - 可以是：
  
  • URI - 如果未找到具有给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false。如果包含模式（例如"tcp://"）、端口（例如1521）或两者，则ResolveTNS选项将不被考虑，无论如何都将被视为URI；
    
  • 会话名称 - 如果在插件配置file中找到该名称；
    
  • TNS键（自Zabbix 7.0.19起支持） - 如果ResolveTNS选项设置为true，且上述条件均不适用；
    
  • TNS值（自Zabbix 7.0.19起支持） - 如果以开括号“（”开头（忽略前导空格）。在这种情况下，ResolveTNS选项不被考虑。
    
• user - Oracle用户名，支持附加login选项之一as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba（login选项不区分大小写，不得包含尾随空格）。 注意，在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项；
  
• password - Oracle密码；
  
• service - Oracle服务名称；
  
• tablespace - 要query的表空间名称。 默认（如果留空且type已设置）：
  • "TEMP"（如果type设置为"TEMPORARY"）；
  • "USERS"（如果type设置为"PERMANENT"）。
• type - 要query的表空间类型。 默认（如果tablespace已设置）："PERMANENT"。
• conname - 需要信息的容器名称。

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

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

返回表空间列表。 用于low-level discovery.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false。如果包含模式(如"tcp://")、端口(如1521)或两者，则ResolveTNS选项将被忽略，始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 如果ResolveTNS选项设为true，且以上条件均不适用;
    
  • TNS值(自Zabbix 7.0.19起支持) - 如果以开括号"("开头(忽略前导空格)。此时ResolveTNS选项将被忽略.
    
• user - Oracle用户名，支持附加login选项as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格)。 注意在Zabbix 7.0.18之前仅支持as sysdba、as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称.

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

返回Oracle用户信息.
返回值: JSON object.

参数:

• connString - 可以是:
  
  • URI - 如果未找到给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false. 如果包含模式(例如"tcp://")、端口(例如1521)或两者，则ResolveTNS选项将被忽略，始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 如果ResolveTNS选项设置为true，且以上条件均不适用;
    
  • TNS值(自Zabbix 7.0.19起支持) - 如果以开括号"("开头(忽略前导空格). 这种情况下ResolveTNS选项将被忽略.
    
• user - Oracle用户名，支持附加login选项之一as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba, as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称;
  
• username - 需要获取信息的用户名. 不支持小写用户名. 默认值: 当前用户.

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

返回数据库服务器version.
返回值: string.

参数:

• connString - 可以是:
  
  • URI - 如果未找到给定名称的会话，且Plugins.Oracle.ResolveTNS设置为false. 如果包含模式(如"tcp://")、端口(如1521)或两者，则ResolveTNS选项将被忽略，始终视为URI;
    
  • 会话名称 - 如果在插件配置file中找到该名称;
    
  • TNS键(自Zabbix 7.0.19起支持) - 如果ResolveTNS选项设为true，且以上条件均不适用;
    
  • TNS值(自Zabbix 7.0.19起支持) - 如果以开括号"("开头(忽略前导空格). 此时ResolveTNS选项将被忽略.
    
• user - Oracle用户名，支持附加login选项之一as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm或as sysrac，格式为user as sysdba(login选项不区分大小写，不得包含尾随空格). 注意在Zabbix 7.0.18之前仅支持as sysdba, as sysoper或as sysasm login选项;
  
• password - Oracle密码;
  
• service - Oracle服务名称.

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

自动清理工作进程的数量。
返回值：integer。

参数：

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

pgsql.archive[uri,<用户名>,<密码>,<数据库名称>]

有关归档文件的信息。
返回值：JSON object。

参数：

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

pgsql.bgwriter[uri,<用户名>,<密码>,<数据库名称>]

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

参数：

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

PostgreSQL缓存命中率[uri,<用户名>,<密码>,<数据库名称>]

PostgreSQL缓冲区缓存命中率。
返回值：float。

参数：

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

pgsql.connections[uri,<用户名>,<密码>,<数据库名称>]

按类型返回连接。
返回值：JSON object。

参数：

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

pgsql.custom.query[uri,<用户名>,<密码>,查询名称,<参数...>] {#pgsql.custom.query}

返回自定义 query 的执行结果。
返回值：JSON object。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• queryName - 自定义 query 的名称，必须与 SQL file 名称（不带扩展名）一致；
  
• args - 一个或多个以逗号分隔的参数，用于传递给 query。

pgsql.db.age[uri,<用户名>,<密码>,<数据库名称>]

数据库中最早的FrozenXID的年龄。
返回值：integer。

参数：

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

pgsql.db.bloating_tables[uri,<用户名>,<密码>,<数据库名称>] {#pgsql.db.bloating.tables}

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

参数：

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

pgsql.db.discovery[uri,<用户名>,<密码>,<数据库名称>] {#pgsql.db.discovery}

PostgreSQL数据库列表。 用于low-level discovery。
返回值：JSON object。

参数：

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

pgsql.db.size[uri,<用户名>,<密码>,<数据库名称>]

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

参数：

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

pgsql.dbstat[uri,<用户名>,<密码>,<数据库名称>] {#pgsql.dbstat}

收集每个数据库的统计信息。 用于 low-level discovery。
返回值：JSON object。

参数：

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

pgsql.dbstat.sum[uri,<用户名>,<密码>,<数据库名称>]

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

参数：

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

pgsql.locks[uri,<用户名>,<密码>,<数据库名称>]

每个数据库授予的锁信息。 用于 low-level discovery。
返回值：JSON object。

参数：

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

pgsql.oldest.xid[uri,<用户名>,<密码>,<数据库名称>]

最大XID的年龄。
返回值: integer.

参数:

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

pgsql.ping[uri,<用户名>,<密码>,<数据库名称>] {#pgsql.ping}

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

参数：

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

pgsql.queries[uri,<用户名>,<密码>,<数据库名称>,<时间周期>]

queries 指标按执行时间划分。
返回值：JSON object。

参数：

• uri - URI 或会话名称；
  
• username, password - PostgreSQL 凭据；
  
• database name - 数据库名称；
  
• timePeriod - 慢速 queries 执行时间限制（必须为正的 integer）。

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

备用服务器的数量。
返回值: integer.

参数:

• uri - URI地址或会话名称;
  
• username, password - PostgreSQL的凭证信息。

pgsql.replication.process[uri,<用户名>,<密码>]

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

参数：

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

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

复制过程名称发现。
返回值：JSON object。

参数：

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

复制延迟的字节数。
返回值: integer.

参数:

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

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

以秒为单位的复制延迟。
返回值：integer。

参数：

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

pgsql.uptime[uri,<用户名>,<密码>,<数据库名称>]

以毫秒为单位的 PostgreSQL 运行时间。
返回值: float.

参数:

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

pgsql.version[uri,<用户名>,<密码>,<数据库名称>]

返回PostgreSQL version。
返回值：string。

参数：

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

pgsql.wal.stat[uri,<用户名>,<密码>,<数据库名称>]

WAL统计信息。
返回值: JSON object.

参数:

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

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

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

参数：

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

redis.info[connString,<password>,<section>] {#redis.info}

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

参数：

• connString - URI或会话名称；
  
• password - Redis密码；
  
• section - 信息的section（默认为default）。
  

redis.ping[connString,<password>]

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

参数：

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

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

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

参数：

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

smart.attribute.discovery

返回 S.M.A.R.T. 设备属性的列表。
返回值: JSON object。

说明：

• 返回以下宏及其值：{#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 object。

参数：

• type - 指定用于扫描磁盘的值。可能的值：id, name（默认）。Windows 不支持 id，如果选择该值将返回错误。

说明：

• 返回以下宏及其值：{#NAME}, {#DISKTYPE}, {#MODEL}, {#SN}, {#PATH}, {#ATTRIBUTES}, {#RAIDTYPE}；
• 支持 HDD、SSD 和 NVME 类型的硬盘。 如果硬盘不属于 RAID，{#RAIDTYPE} 将为空。 在 RAID 情况下，{#NAME} 将包含附加信息，例如：{"{#NAME}": "/dev/sda cciss,2"}。

smart.disk.get[<路径>,<RAID类型>]

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

参数：

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

备注：

• 支持 HDD、SSD 和 NVME 类型的磁盘； 磁盘可以单独存在，也可以组合成 RAID；
  
• 数据包括 smartctl version 及其调用参数，以及附加字段：
  disk_name - 包含 RAID 发现所需的附加信息的磁盘名称，例如：{"disk_name": "/dev/sda cciss,2"}
  disk_type - 表示磁盘类型 HDD、SSD 或 NVME，例如：{"disk_type": "ssd"}；
  
• 如果未指定参数，监控项 将返回所有磁盘的信息。

systemd.unit.get[单位名称,<接口>]

返回 systemd 单元的所有属性。
返回值: JSON object。

参数：

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

备注：

• 该 监控项 仅支持 Linux 平台；
• Unit 接口的 LoadState、ActiveState 和 UnitFileState 以文本和 integer 形式返回："ActiveState":{"state":1,"text":"active"}。

systemd.unit.info[单位名称,<属性>,<接口>]

一个systemd单元信息。
返回值：string。

参数：

• 单元名称 - 单元名称（您可能希望在监控项原型中使用{#UNIT.NAME}宏来发现名称）；
  
• 属性 - 单元属性（例如ActiveState（默认）、LoadState、Description）；
• 接口 - 单元接口类型（例如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] # 收集此socket单元的连接数

systemd.unit.discovery[<类型>]

systemd 单元列表及其详细信息。 用于 low-level discovery。
返回值：JSON object。

参数：

• type - 可选值：all, automount, device, mount, path, service（默认）, socket, swap, target。

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

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

验证证书并返回证书详细信息。
返回值: JSON object.

参数:

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

评论:

• 如果在主机配置中指定的目标不存在、不可用，或者TLS握手失败（除证书无效外的任何错误），此监控项将变为不支持；
  
• 当前不支持AIA（Authority Information Access）X.509扩展、CRL和OCSP（包括OCSP stapling）以及证书透明度；
• JSON响应字段：
  • x509: 包含X.509证书的详细信息。
    • version: X.509 version（例如，3）。
    • serial_number: 证书的序列号。
    • signature_algorithm: 用于签署证书的算法（例如，SHA256-RSA）。
    • issuer: 证书的颁发者。
    • not_before: 证书有效性的起始日期。
    • not_after: 证书的过期日期。
    • subject: 证书的主题。
    • public_key_algorithm: 公钥使用的算法（例如，RSA）。
    • alternative_names: 主题备用名称（如果存在），否则为null。
  • result: 包含验证结果。
    • value: 验证状态（见以下可能值）。
    • message: 详细的验证消息（例如，"certificate verified successfully"）。
  • sha1_fingerprint: 证书的SHA-1指纹。
  • sha256_fingerprint: 证书的SHA-256指纹。
• $.result.value字段表示证书验证结果。可能的值包括：
  • valid – 证书有效且受信任。
  • valid-but-self-signed – 证书有效但自签名，即其主题与其颁发者匹配。
  • invalid – 证书由于问题（如过期、主机名不正确或未知的签名机构）而无效。

示例：

web.certificate.get[example.com,443]

JSON响应：

{
  "x509": {
    "version": 3,
    "serial_number": "0ad893bafa68b0b7fb7a404f06ecaf9a",
    "signature_algorithm": "ECDSA-SHA384",
    "issuer": "CN=DigiCert Global G3 TLS ECC SHA384 2020 CA1,O=DigiCert Inc,C=US",
    "not_before": {
      "value": "Jan 15 00:00:00 2025 GMT",
      "timestamp": 1736899200
    },
    "not_after": {
      "value": "Jan 15 23:59:59 2026 GMT",
      "timestamp": 1768521599
    },
    "subject": "CN=*.example.com,O=Internet Corporation for Assigned Names and Numbers,L=Los Angeles,ST=California,C=US",
    "public_key_algorithm": "ECDSA",
    "alternative_names": [
      "*.example.com",
      "example.com"
    ]
  },
  "result": {
    "value": "valid",
    "message": "certificate verified successfully"
  },
  "sha1_fingerprint": "310db7af4b2bc9040c8344701aca08d0c69381e3",
  "sha256_fingerprint": "455943cf819425761d1f950263ebf54755d8d684c25535943976f488bc79d23b"
}