Плагин MSSQL

Обзор

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

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

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

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

Эта страница имеет следующую структуру:

  • Обзор параметров (чтобы увидеть полные сведения о параметре, нажмите на его имя)
  • Сведения о параметрах
Parameter Description
Plugins.MSSQL.CustomQueriesDir Укажите путь к каталогу, содержащему пользовательские файлы .sql с пользовательскими запросами, которые плагин может выполнять.
Plugins.MSSQL.CustomQueriesEnabled Включите выполнение ключа элемента данных mssql.custom.query.
Plugins.MSSQL.Default.CACertPath Укажите путь к файлу сертификата открытого ключа центра сертификации (CA), выдавшего сертификат сервера MSSQL, по умолчанию.
Plugins.MSSQL.Default.Database Укажите имя базы данных по умолчанию.
Plugins.MSSQL.Default.Encrypt Укажите уровень шифрования по умолчанию.
Plugins.MSSQL.Default.HostNameInCertificate Укажите общее имя (CN) сертификата сервера MSSQL по умолчанию.
Plugins.MSSQL.Default.Password Укажите пароль по умолчанию.
Plugins.MSSQL.Default.TLSMinVersion Укажите минимальную версию TLS по умолчанию.
Plugins.MSSQL.Default.TrustServerCertificate Доверять сертификату сервера без его проверки по умолчанию.
Plugins.MSSQL.Default.Uri Укажите URI по умолчанию.
Plugins.MSSQL.Default.User Укажите имя пользователя по умолчанию.
Plugins.MSSQL.KeepAlive Укажите максимальное время ожидания (в секундах) перед закрытием неиспользуемых подключений плагина.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath Укажите путь к файлу сертификата открытого ключа центра сертификации (CA), выдавшего сертификат сервера MSSQL, для именованной сессии.
Plugins.MSSQL.Sessions.<SessionName>.Database Укажите имя базы данных для именованной сессии.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt Укажите уровень шифрования для именованной сессии.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate Укажите общее имя (CN) сертификата сервера MSSQL для именованной сессии.
Plugins.MSSQL.Sessions.<SessionName>.Password Укажите пароль для именованной сессии.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion Укажите минимальную версию TLS для именованной сессии.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate Доверять сертификату сервера именованной сессии без его проверки.
Plugins.MSSQL.Sessions.<SessionName>.Uri Укажите URI именованной сессии.
Plugins.MSSQL.Sessions.<SessionName>.User Укажите имя пользователя именованной сессии.
Plugins.MSSQL.System.Path Укажите путь к исполняемому файлу плагина MSSQL.
Plugins.MSSQL.Timeout Установите длительность ожидания ответа сервера при первом подключении и при последующих операциях в сессии, в секундах.

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

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

Подробности параметра

Plugins.MSSQL.CustomQueriesDir

Укажите путь к каталогу, содержащему пользовательские файлы .sql с пользовательскими запросами, которые может выполнять плагин.
Плагин загружает все доступные файлы .sql в настроенном каталоге при запуске. Это означает, что любые изменения в файлах пользовательских запросов не будут применены, пока плагин не будет перезапущен. Плагин запускается и останавливается вместе с агентом Zabbix 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

Укажите путь к файлу по умолчанию для сертификата открытого ключа центра сертификации (CA), выдавшего сертификат MSSQL-сервера.
Сертификат должен быть в формате PEM.

Plugins.MSSQL.Default.Database

Укажите имя базы данных по умолчанию.

Plugins.MSSQL.Default.Encrypt

Укажите уровень шифрования по умолчанию.

Диапазон:
true - передача данных между плагином и сервером шифруется;
false - передача данных между плагином и сервером не шифруется, кроме пакета входа в систему;
strict - передача данных между плагином и сервером шифруется сквозным образом с использованием TDS8;
disable - передача данных между плагином и сервером не шифруется.

Plugins.MSSQL.Default.HostNameInCertificate

По умолчанию укажите общее имя (CN) сертификата сервера MSSQL.

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

Укажите URI по умолчанию для подключения к серверу MSSQL.
Встроенные учетные данные будут проигнорированы.
Единственная поддерживаемая схема — sqlserver://.
Схему можно опустить.

По умолчанию: sqlserver://localhost:1433

Plugins.MSSQL.Default.User

Укажите имя пользователя по умолчанию для защищенного сервера MSSQL.

Plugins.MSSQL.KeepAlive

Укажите максимальное время ожидания (в секундах) до закрытия неиспользуемых подключений плагина.

По умолчанию: 300
Диапазон: 60-900

Plugins.MSSQL.Sessions.<SessionName>.CACertPath

Укажите путь к файлу именованной сессии для публичного ключа сертификата центра сертификации (CA), который выдал сертификат сервера MSSQL.
<SessionName> - задайте имя сессии для использования в ключах элементов данных.
Сертификат должен быть в формате PEM.

Plugins.MSSQL.Sessions.<SessionName>.Database

Укажите имя базы данных для именованной сессии.
<SessionName> - задайте имя сессии для использования в ключах элементов данных.

Plugins.MSSQL.Sessions.<SessionName>.Encrypt

Укажите уровень шифрования именованной сессии.
<SessionName> - задайте имя сессии для использования в ключах элементов данных.

Диапазон:
true - передача данных между плагином и сервером зашифрована;
false - передача данных между плагином и сервером не шифруется, кроме пакета входа в систему;
strict - передача данных между плагином и сервером зашифрована end-to-end с использованием TDS8;
disable - передача данных между плагином и сервером не шифруется.

Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate

Укажите общее имя (CN) сертификата сервера MSSQL для именованной сессии.
<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

Укажите URI именованной сессии для подключения к серверу MSSQL.
<SessionName> - задайте имя сессии для использования в ключах элементов данных.
Встроенные учетные данные будут проигнорированы.
Единственная поддерживаемая схема — sqlserver://.
Схему можно опустить.

По умолчанию: 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

Параметры

Parameter Description
-V --version Вывести версию плагина и информацию о лицензии.
-h --help Вывести справочную информацию (сокращенный вариант).
-t, --test <item key> Запустить плагин для тестирования (конфигурация плагина игнорируется).

См. также