8 MSSQL 插件

概述

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

建议在其专用配置文件中指定这些参数（例如 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 否 /usr/local/share/zabbix/custom-queries/mssql（Unix 系统）

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

另请参见：