MSSQL 插件

概述

配置参数可用于自定义 MSSQL 插件的行为。

建议将这些参数指定在它们自己的配置文件中（例如 mssql.conf），而不是放在 agent 2 配置文件中。然后使用 Include 指令将此文件包含到 Zabbix agent 2 配置中。

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

除非明确说明该参数为必填项，否则所有参数均为可选。

本页结构如下：

• 参数概览（要查看参数的完整详情，请点击其名称）
• 参数详情

请注意：

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

参数详情

Plugins.MSSQL.CustomQueriesDir

指定包含用户定义的 .sql 文件的目录路径，这些文件包含插件可以执行的自定义查询。
插件会在启动时加载配置目录中所有可用的 .sql 文件。 这意味着，对自定义查询文件所做的任何更改都不会生效，直到插件重新启动。 插件会与 Zabbix agent 2 一起启动和停止。

默认值：
/usr/local/share/zabbix/custom-queries/mssql - 适用于 Unix 系统，
*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL - 适用于 Windows 系统（其中 * 是来自 ProgramFiles 环境变量的驱动器名称）

Plugins.MSSQL.CustomQueriesEnabled

启用 mssql.custom.query 监控项键的执行。
如果禁用，则不会从自定义查询目录路径加载任何查询。

默认值：false
范围：true/false

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

指定用于连接 MSSQL 服务器的默认 URI。
嵌入的凭据将被忽略。
唯一支持的 schema 是 sqlserver://。
可以省略该 schema。

默认值：sqlserver://localhost:1433

Plugins.MSSQL.Default.User

指定受保护的 MSSQL 服务器的默认用户名。

Plugins.MSSQL.KeepAlive

指定在关闭未使用的插件连接之前的最长等待时间（以秒为单位）。

默认值：300
范围：60-900

Plugins.MSSQL.Sessions.<SessionName>.CACertPath

指定命名会话文件路径，指向签发 MSSQL 服务器证书的证书颁发机构（CA）的公钥证书。
<SessionName> - 定义用于监控项键中的会话名称。
证书必须采用 PEM 格式。

Plugins.MSSQL.Sessions.<SessionName>.Database

指定命名会话的数据库名称。
<SessionName> - 定义用于监控项键中的会话名称。

Plugins.MSSQL.Sessions.<SessionName>.Encrypt

指定命名会话加密级别。
<SessionName> - 定义用于监控项键值中的会话名称。

范围：
true - 插件与服务器之间发送的数据已加密；
false - 插件与服务器之间发送的数据除登录数据包外不加密；
strict - 插件与服务器之间发送的数据使用 TDS8 进行端到端加密；
disable - 插件与服务器之间发送的数据不加密。

Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate

指定命名会话所使用的 MSSQL 服务器证书的通用名称（CN）。
<SessionName> - 定义用于监控项键中的会话名称。

Plugins.MSSQL.Sessions.<SessionName>.Password

为受保护的 MSSQL 服务器指定命名会话密码。
<SessionName> - 定义用于监控项键中的会话名称。

Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion

指定命名会话的最低 TLS 版本。
<SessionName> - 定义用于监控项键中的会话名称。

范围：1.0、1.1、1.2、1.3

Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate

信任指定会话的服务器证书，而不进行验证。
<SessionName> - 定义用于监控项键中的会话名称。

范围：true、false

Plugins.MSSQL.Sessions.<SessionName>.Uri

指定用于连接 MSSQL 服务器的命名会话 URI。
<SessionName> - 定义一个会话名称，用于监控项键值中。
嵌入的凭据将被忽略。
唯一支持的 schema 是 sqlserver://。
可以省略该 schema。

默认值: sqlserver://localhost:1433

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

设置等待服务器响应的时长（以秒为单位），适用于首次连接以及会话中的后续操作。

默认值：global timeout
范围：1-30

选项

另请参阅

• 常规 Zabbix agent 2 配置参数说明：Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
• 配置 plugins 的说明