Documentation
Table of Contents
6. Плагин MongoDB
Обзор
В этом разделе перечислены параметры, поддерживаемые в файле конфигурации плагина MongoDB для Zabbix агента 2 (mongo.conf).
Начиная с версии Zabbix 6.0.6, MongoDB является подгружаемым плагином, который доступен и полностью описан в репозитории плагина MongoDB [en]
Заранее скомпилированные бинарные файлы плагинов для Windows доступны, начиная с версии Zabbix 6.0.19, и совместимы с предыдущими версиями 6.0.
Обратите внимание, что:
- Значения по умолчанию отражают значения по умолчанию для процесса, а не значения в поставляемых файлах конфигурации;
- Zabbix поддерживает файлы конфигурации только в кодировке UTF-8 без BOM;
- Комментарии, начинающиеся с «#», поддерживаются только в начале строки.
Опции
| Параметр | Описание |
|---|---|
| -V --version | Вывести версию плагина и информацию о лицензии. |
| -h --help | Вывести справочную информацию (сокращённо). |
Параметры
В версиях versions до 6.0.6, имена параметров начинались с Plugins.Mongo.<Параметр> вместо Plugins.MongoDB.<Параметр>. Например, Plugins.Mongo.KeepAlive
| Параметр | Обязательный | Диапазон | По умолчанию | Описание |
|---|---|---|---|---|
| Plugins.MongoDB.Default.Password | нет | Пароль по умолчанию для подключения к MongoDB; используется, если значение не указано в ключе элемента данных или в именованной сессии. Поддерживается с версии 6.0.18 |
||
| Plugins.MongoDB.Default.Uri | нет | URI по умолчанию для подключения к MongoDB; используется, если значение не указано в ключе элемента данных или в именованной сессии. Не должно содержать встроенных креденшиалов (они будут проигнорированы). Должно соответствовать формату URI. Поддерживается только схема tcp; схема может быть опущена.Порт может быть опущен (по умолчанию 27017). Примеры: tcp://127.0.0.1:27017, tcp:localhost, localhostПоддерживается с версии 6.0.18 |
||
| Plugins.MongoDB.Default.User | нет | Имя пользователя по умолчанию для подключения к MongoDB; используется, если значение не указано в ключе элемента данных или в именованной сессии. Поддерживается с версии 6.0.18 |
||
| Plugins.MongoDB.KeepAlive | нет | 60-900 | 300 | Максимальное время ожидания (в секундах), прежде чем неиспользуемые плагином соединения закрываются. |
| Plugins.MongoDB.Sessions.<ИмяСессии>.Password | нет | Пароль именованной сессии. <ИмяСессии> - определяет имя сессии, используемое в ключах элементов данных. |
||
| Plugins.MongoDB.Sessions.<ИмяСессии>.TLSCAFile | нет (да, если Plugins.MongoDB.Sessions.<ИмяСессии>.TLSConnect имеет одно из значений: verify_ca, verify_full) |
Абсолютный путь к файлу, который содержит сертификаты удостоверяющих центров (certificate authority, CA) верхнего уровня для проверки сертификата узла, используется для зашифрованных соединений между Zabbix агентом 2 и наблюдаемыми базами данных. <ИмяСессии> - определяет имя сессии, используемое в ключах элементов данных. Поддерживается в версиях плагина 1.2.0, 6.0.13 и новее1. |
||
| Plugins.MongoDB.Sessions.<ИмяСессии>.TLSCertFile | да, если Plugins.MongoDB.Sessions.<ИмяСессии>.TLSKeyFile указано До версии 6.0.24 всегда обязательно, если Plugins.MongoDB.Sessions.<ИмяСессии>.TLSConnect имеет одно из значений: verify_ca, verify_full |
Абсолютный путь к файлу, который содержит сертификат агента или цепочку сертификатов, используется для зашифрованных соединений между Zabbix агентом 2 и наблюдаемыми базами данных. <ИмяСессии> - определяет имя сессии, используемое в ключах элементов данных. Поддерживается в версиях плагина 1.2.0, 6.0.13 и новее1. |
||
| Plugins.MongoDB.Sessions.<ИмяСессии>.TLSConnect | нет | Тип шифрования для коммуникаций между Zabbix агентом 2 и наблюдаемыми базами данных. <ИмяСессии> - определяет имя сессии, используемое в ключах элементов данных. Поддерживаются значения: required - требовать TLS подключений; verify_ca - проверять сертификаты; verify_full - проверять сертификаты и IP адрес. Поддерживается в версиях плагина 1.2.0, 6.0.13 и новее1. |
||
| Plugins.MongoDB.Sessions.<ИмяСессии>.TLSKeyFile | да, если Plugins.MongoDB.Sessions.<ИмяСессии>.TLSCertFile указано До версии 6.0.24 всегда обязательно, если Plugins.MongoDB.Sessions.<ИмяСессии>.TLSConnect имеет одно из значений: verify_ca, verify_full |
Абсолютный путь к файлу, содержащему закрытый ключ (private key) базы данных, используется для зашифрованных коммуникаций между Zabbix агентом 2 и наблюдаемыми базами данных. <ИмяСессии> - определяет имя сессии, используемое в ключах элементов данных. Поддерживается в версиях плагина 1.2.0, 6.0.13 и новее1. |
||
| Plugins.MongoDB.Sessions.<ИмяСессии>.Uri | нет | Строка подключения именованной сессии. <ИмяСессии> - определяет имя сессии, используемое в ключах элементов данных. Не должна содержать встроенных креденшиалов (они будут проигнорированы). Должна соответствовать формату URI. Поддерживается только схема tcp; схема может быть опущена.Порт может быть опущен (по умолчанию 27017). Примеры: tcp://127.0.0.1:27017, tcp:localhost, localhost |
||
| Plugins.MongoDB.Sessions.<ИмяСессии>.User | нет | Имя пользователя именованной сессии. <ИмяСессии> - определяет имя сессии, используемое в ключах элементов данных. |
||
| Plugins.MongoDB.System.Path | нет | Путь к внешнему исполняемому файлу плагина. Поддерживается с версии Zabbix 6.0.6 | ||
| Plugins.MongoDB.Timeout | нет | 1-30 | глобальный тайм-аут | Время ожидания выполнения запроса (как долго запрос будет ожидать выполнения, прежде чем будет принудительно завершён). |
Смотрите также:
- Описание общих параметров конфигурации Zabbix агента 2: Zabbix агент 2 (UNIX) / Zabbix агент 2 (Windows)
- Инструкции по настройке плагинов
Примечания
1 - Начиная с версии Zabbix 6.0.13, подгружаемые плагины стали использовать ту же систему нумерации версий, что и сам Zabbix. В результате версия плагина MongoDB изменилась с 1.2.0 на 6.0.13.