8 MSSQL 插件

概述

Zabbix agent 2 的配置文件用于配置插件。运行 MSSQL 插件支持以下 Zabbix agent 2 配置参数。

建议将它们单独写入各自的配置文件（例如 mssql.conf），然后使用 Include 指令将该文件添加到 Zabbix agent 2 配置中。

MSSQL 插件是一个可加载插件，可在 MSSQL plugin repository 中获取并查看完整说明。

请注意：

  • 默认值反映的是进程默认值，而不是随软件提供的配置文件中的值。
  • 值支持 environment variables；
  • Zabbix 仅支持 UTF-8 编码且不带 BOM 的配置文件。
  • 以 "#" 开头的注释仅在行首支持。

选项

Parameter Description
-V --version 打印插件版本和许可证信息。
-h --help 打印帮助信息（简写）。
-t, --test <item key> 启动插件进行测试（忽略插件配置）。

参数

Parameter Mandatory Range Default Description
Plugins.MSSQL.CustomQueriesDir no /usr/local/share/zabbix/custom-queries/mssql for Unix systems

*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL for Windows systems, where * is the drive name from the ProgramFiles environment variable		 指定包含用户自定义 .sql 文件的目录路径，这些文件中包含插件可执行的自定义查询。插件在启动时会加载配置目录中所有可用的 .sql 文件。这意味着，对自定义查询文件所做的任何更改都不会生效，直到插件重新启动。插件会与 Zabbix agent 2 一起启动和停止。
Plugins.MSSQL.CustomQueriesEnabled no false 如果设置，则启用 mssql.custom.query 监控项键的执行。如果禁用，则不会从自定义查询目录路径加载任何查询。
Plugins.MSSQL.Default.CACertPath no 默认的证书颁发机构（CA）公钥证书文件路径，该 CA 颁发了 MSSQL 服务器证书。证书必须为 PEM 格式。
Plugins.MSSQL.Default.Database no 要连接的默认数据库名称。
Plugins.MSSQL.Default.Encrypt no 指定默认连接加密类型。可用值：
true - 插件与服务器之间发送的数据会被加密；
false - 插件与服务器之间发送的数据除登录包外不加密；
strict - 插件与服务器之间发送的数据使用 TDS8 进行端到端加密；
disable - 插件与服务器之间发送的数据不加密。
Plugins.MSSQL.Default.HostNameInCertificate no 默认情况下，MSSQL 服务器证书的通用名称（CN）。
Plugins.MSSQL.Default.Password no 默认情况下发送到受保护 MSSQL 服务器的密码。
Plugins.MSSQL.Default.TLSMinVersion no 默认使用的最低 TLS 版本。可用值：1.0、1.1、1.2、1.3。
Plugins.MSSQL.Default.TrustServerCertificate no 默认情况下，插件是否应信任服务器证书而不进行验证。可用值：true、false。
Plugins.MSSQL.Default.Uri no sqlserver://localhost:1433 默认连接 URI。唯一支持的 schema 是 sqlserver://。可以省略 schema。嵌入的凭据将被忽略。
Plugins.MSSQL.Default.User no 默认情况下发送到受保护 MSSQL 服务器的用户名。
Plugins.MSSQL.KeepAlive no 60-900 300 在关闭未使用的插件连接之前等待的最长时间（秒）。
Plugins.MSSQL.Sessions.<SessionName>.CACertPath no 指定会话的 MSSQL 服务器证书所对应的证书颁发机构（CA）公钥证书文件路径。证书必须为 PEM 格式。
<SessionName> - 定义一个会话名称，用于监控项键。
Plugins.MSSQL.Sessions.<SessionName>.Database no 指定会话要连接的数据库名称。
<SessionName> - 定义一个会话名称，用于监控项键。
Plugins.MSSQL.Sessions.<SessionName>.Encrypt no 指定该会话的连接加密类型。可用值：
true - 插件与服务器之间发送的数据会被加密；
false - 插件与服务器之间发送的数据除登录包外不加密；
strict - 插件与服务器之间发送的数据使用 TDS8 进行端到端加密；
disable - 插件与服务器之间发送的数据不加密。
<SessionName> - 定义一个会话名称，用于监控项键。
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate no 指定会话的 MSSQL 服务器证书通用名称（CN）。
<SessionName> - 定义一个会话名称，用于监控项键。
Plugins.MSSQL.Sessions.<SessionName>.Password no 指定会话发送到受保护 MSSQL 服务器的密码。
<SessionName> - 定义一个会话名称，用于监控项键。
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion no 指定会话使用的最低 TLS 版本。可用值：1.0、1.1、1.2、1.3。
<SessionName> - 定义一个会话名称，用于监控项键。
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate no 指定插件是否应在不验证的情况下信任该会话的服务器证书。可用值：true、false。
<SessionName> - 定义一个会话名称，用于监控项键。
Plugins.MSSQL.Sessions.<SessionName>.Uri no sqlserver://localhost:1433 指定该会话要连接的 URI。唯一支持的 schema 是 sqlserver://。可以省略 schema。嵌入的凭据将被忽略。
<SessionName> - 定义一个会话名称，用于监控项键。
Plugins.MSSQL.Sessions.<SessionName>.User no 指定会话发送到受保护 MSSQL 服务器的用户名。
<SessionName> - 定义一个会话名称，用于监控项键。
Plugins.MSSQL.System.Path no MSSQL 插件可执行文件的路径。
MSSQL 插件的全局设置。适用于所有连接。
示例用法：Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql
Plugins.MSSQL.Timeout no 1-30 global timeout 等待服务器在首次连接以及会话中的后续操作时响应的时长，单位为秒。

另请参见：