Плагин MSSQL

Обзор

Параметры конфигурации позволяют настраивать поведение плагина MSSQL.

Рекомендуется указывать их в отдельном файле конфигурации (например, mssql.conf), а не в файле конфигурации агента 2. Затем используйте директиву Include, чтобы включить этот файл в конфигурацию Zabbix agent 2.

Плагин MSSQL является загружаемым плагином и доступен, а также полностью описан в репозитории плагина MSSQL.

Все параметры являются необязательными, если явно не указано, что параметр обязателен.

Обратите внимание:

  • Значения по умолчанию отражают значения по умолчанию процесса, а не значения в поставляемых файлах конфигурации.
  • Значения поддерживают переменные среды;
  • Zabbix поддерживает файлы конфигурации только в кодировке UTF-8 без BOM.
  • Комментарии, начинающиеся с "#", поддерживаются только в начале строки.

Parameter details

Plugins.MSSQL.CustomQueriesDir

Specify path to the directory containing user-defined .sql files with custom queries that the plugin can execute.
The plugin loads all available .sql files in the configured directory at startup. This means that any changes to the custom query files will not be reflected until the plugin is restarted. The plugin is started and stopped together with Zabbix agent 2.

Defaults:
/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)

Plugins.MSSQL.CustomQueriesEnabled

Enable execution of the mssql.custom.query item key.
If disabled, no queries will be loaded from the custom query directory path.

Default: false Range: true/false

Plugins.MSSQL.Default.CACertPath

Specify the default file path to the public key certificate of the certificate authority (CA) that issued the certificate of the MSSQL server.
The certificate must be in PEM format.

Plugins.MSSQL.Default.Database

Specify the default database name.

Plugins.MSSQL.Default.Encrypt

Specify the level of default encryption.

Range:
true - data sending between plugin and server is encrypted;
false - data sending between plugin and server is not encrypted beyond the login packet;
strict - data sending between plugin and server is encrypted E2E using TDS8;
disable - data sending between plugin and server is not encrypted.

Plugins.MSSQL.Default.HostNameInCertificate

Specify the common name (CN) of the MSSQL server certificate by default.

Plugins.MSSQL.Default.Password

Specify the default password for a protected MSSQL server.

Plugins.MSSQL.Default.TLSMinVersion

Specify the minimum TLS version by default.

Range: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Default.TrustServerCertificate

Trust the server certificate without validating it by default.

Range: true, false

Plugins.MSSQL.Default.Uri

Specify the default URI for connecting to MSSQL server.
Embedded credentials will be ignored.
The only supported schema is sqlserver://.
The schema can be omitted.

Default: sqlserver://localhost:1433

Plugins.MSSQL.Default.User

Specify the default username for a protected MSSQL server.

Plugins.MSSQL.KeepAlive

Specify the maximum time of waiting (in seconds) before unused plugin connections are closed.

Default: 300 Range: 60-900

Plugins.MSSQL.Sessions.<SessionName>.CACertPath

Specify the named session file path to the public key certificate of the certificate authority (CA) that issued the certificate of the MSSQL server.
<SessionName> - define name of a session for using in item keys.
The certificate must be in PEM format.

Plugins.MSSQL.Sessions.<SessionName>.Database

Specify the named session database name.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.Encrypt

Specify the level of named session encryption.
<SessionName> - define name of a session for using in item keys.

Range:
true - data sending between plugin and server is encrypted;
false - data sending between plugin and server is not encrypted beyond the login packet;
strict - data sending between plugin and server is encrypted E2E using TDS8;
disable - data sending between plugin and server is not encrypted.

Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate

Specify the common name (CN) of the MSSQL server certificate for named session.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.Password

Specify the named session password for a protected MSSQL server.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion

Specify the named session minimum TLS version.
<SessionName> - define name of a session for using in item keys.

Range: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate

Trust the named session server certificate without validating it.
<SessionName> - define name of a session for using in item keys.

Range: true, false

Plugins.MSSQL.Sessions.<SessionName>.Uri

Specify the named session URI for connecting to MSSQL server.
<SessionName> - define name of a session for using in item keys.
Embedded credentials will be ignored.
The only supported schema is sqlserver://.
The schema can be omitted.

Default: sqlserver://localhost:1433

Plugins.MSSQL.Sessions.<SessionName>.User

Specify the named session username for a protected MSSQL server.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.System.Path

Specify path to the MSSQL plugin executable.
Global setting for the MSSQL plugin. Applied to all connections.

Example: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql

Plugins.MSSQL.Timeout

Set the duration, in seconds, to wait for a server to respond when first connecting and on follow-up operations in the session.

Default: default timeout Range: 1-30

Параметры

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 для систем Unix

*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL для систем Windows, где * - имя диска из переменной окружения ProgramFiles		 Указывает путь к каталогу, содержащему пользовательские .sql-файлы с пользовательскими запросами, которые может выполнять плагин. Плагин загружает все доступные .sql-файлы в настроенном каталоге при запуске. Это означает, что любые изменения в файлах пользовательских запросов не будут отражены до перезапуска плагина. Плагин запускается и останавливается вместе с Zabbix agent 2.
Plugins.MSSQL.CustomQueriesEnabled no false Если задано, включает выполнение ключа элемента данных mssql.custom.query. Если отключено, запросы не будут загружаться из пути каталога пользовательских запросов.
Plugins.MSSQL.Default.CACertPath no Путь к файлу открытого ключа сертификата центра сертификации (CA), выдавшего сертификат сервера MSSQL, по умолчанию. Сертификат должен быть в формате PEM.
Plugins.MSSQL.Default.Database no Имя базы данных для подключения по умолчанию.
Plugins.MSSQL.Default.Encrypt no Указывает тип шифрования соединения по умолчанию. Возможные значения:
true - передача данных между плагином и сервером зашифрована;
false - передача данных между плагином и сервером не шифруется, кроме пакета входа в систему;
strict - передача данных между плагином и сервером шифруется сквозным образом с использованием TDS8;
disable - передача данных между плагином и сервером не шифруется.
Plugins.MSSQL.Default.HostNameInCertificate no Общее имя (CN) сертификата сервера MSSQL по умолчанию.
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 для подключения по умолчанию. Единственная поддерживаемая схема - sqlserver://. Схему можно опустить. Встроенные учетные данные будут проигнорированы.
Plugins.MSSQL.Default.User no Имя пользователя, которое по умолчанию будет отправляться на защищенный сервер MSSQL.
Plugins.MSSQL.KeepAlive no 60-900 300 Максимальное время ожидания (в секундах) до закрытия неиспользуемых подключений плагина.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath no Путь к файлу открытого ключа сертификата центра сертификации (CA), выдавшего сертификат сервера MSSQL, для указанной сессии. Сертификат должен быть в формате 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 Общее имя (CN) сертификата сервера MSSQL для указанной сессии.
<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 для подключения для указанной сессии. Единственная поддерживаемая схема - sqlserver://. Схему можно опустить. Встроенные учетные данные будут проигнорированы.
<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 Продолжительность ожидания ответа сервера в секундах при первом подключении и при последующих операциях в сессии.

См. также: