Table of Contents
6 Plugin de MongoDB
Descripción general
El archivo de configuración de Zabbix agent 2 se utiliza para configurar plugins. Estos parámetros de configuración de Zabbix agent 2 son compatibles para operar el plugin de MongoDB.
Se recomienda especificarlos en su propio archivo de configuración (por ejemplo, mongo.conf) y luego utilizar la directiva Include para agregar este archivo a la configuración de Zabbix agent 2.
El plugin de MongoDB es un plugin cargable y está disponible y completamente descrito en el repositorio del plugin de MongoDB.
Tenga en cuenta que:
- Los valores predeterminados reflejan los valores por defecto del proceso, no los valores en los archivos de configuración distribuidos.
- Los valores admiten variables de entorno;
- Zabbix solo admite archivos de configuración en codificación UTF-8 sin BOM.
- Los comentarios que comienzan con "#" solo se admiten al principio de la línea.
Opciones
| Parámetro | Descripción |
|---|---|
| -V --version | Imprime la versión del complemento e información de la licencia. |
| -h --help | Imprime información de ayuda (abreviado). |
| -t, --test <clave del elemento> | Lanza el complemento para pruebas (se ignora la configuración del complemento). |
Parámetros
Al conectarse a MongoDB, el plugin verifica su configuración en un orden específico, que determina qué valor utilizar. El orden, de mayor a menor prioridad, es el siguiente:
- Parámetros especificados en el URI de conexión (por ejemplo, los parámetros de consulta definidos después de
?enPlugins.MongoDB.Sessions.<session_name>.Uritienen la máxima prioridad). - Parámetros en la clave del item del agent 2 de Zabbix (por ejemplo, mongodb.collection.stats).
- Parámetros definidos en una sesión con nombre (por ejemplo,
Plugins.MongoDB.Sessions.<SessionName>.User,Plugins.MongoDB.Sessions.<SessionName>.Password). - Valores por defecto (por ejemplo,
Plugins.MongoDB.Default.User,Plugins.MongoDB.Default.Password).
Por ejemplo:
- Si especifica la base de datos para autenticar una conexión al servidor MongoDB en el parámetro
*.<SessionName>.Uri(por ejemplo,Plugins.MongoDB.Sessions.<session_name>.Uri=mongodb://user:[email protected]:27017/?authSource=admin), entonces el plugin considerará que el parámetro*.<SessionName>.AuthSourceestá configurado comoadmin, incluso si el parámetro*.<SessionName>.AuthSourceestá configurado con un valor diferente. - Si especifica el URI en el parámetro
*.<SessionName>.Uri(por ejemplo,Plugins.MongoDB.Sessions.<session_name>.Uri=mongodb://127.0.0.1:27017), pero proporciona el nombre de usuario y la contraseña en la clave del item del agent 2 de Zabbix, el plugin utilizará el nombre de usuario y la contraseña de la clave del item, incluso siPlugins.MongoDB.Sessions.<SessionName>.UseryPlugins.MongoDB.Sessions.<SessionName>.Passwordestán configurados.
Si se utiliza el esquema mongodb+srv://, el URI puede recuperar parámetros de un registro DNS TXT. Los parámetros obtenidos de este registro TXT anulan todas las demás configuraciones, incluidos los parámetros del URI, los parámetros de la clave del item del agent 2 de Zabbix y los parámetros de la sesión.
Solo puede existir un registro TXT para el nombre de host utilizado en la cadena de conexión.
| Parámetro | Obligatorio | Rango | Por defecto | Descripción |
|---|---|---|---|---|
| Plugins.MongoDB.System.Path | no | Ruta al ejecutable del plugin de MongoDB. Ejemplo de uso: Plugins.MongoDB.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mongodb |
||
| Plugins.MongoDB.Timeout | no | 1-30 | timeout global | Tiempo de espera de ejecución de la petición (la duración, en segundos, que se espera a que se complete una petición antes de cerrarla). |
| Plugins.MongoDB.KeepAlive | no | 60-900 | 300 | El tiempo máximo de espera (en segundos) antes de que se cierren las conexiones de plugin no utilizadas. |
| Plugins.MongoDB.Sessions.<SessionName>.Uri | no | tcp://127.0.0.1:27017 |
Cadena de conexión de una sesión con nombre. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. Debe coincidir con el formato URI. Esquemas soportados: mongodb:// y mongodb+srv://; el esquema tcp:// está obsoleto y se mantiene por compatibilidad con configuraciones existentes.Se puede omitir el puerto (por defecto=27017). Ejemplos: mongodb://127.0.0.1:27017, mongodb+srv://example.com, localhost. |
|
| Plugins.MongoDB.Sessions.<SessionName>.User | no | Nombre de usuario de la sesión con nombre. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. |
||
| Plugins.MongoDB.Sessions.<SessionName>.Password | no | Contraseña de la sesión con nombre. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. |
||
| Plugins.MongoDB.Sessions.<SessionName>.Direct | no | false |
Método de conexión utilizado para determinar si el descubrimiento automático de nodos del conjunto de réplicas de MongoDB debe estar habilitado o deshabilitado. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. Valores soportados: true - el plugin se conectará solo al servidor especificado, ignorando otros miembros del conjunto de réplicas;false - el plugin descubrirá automáticamente todos los nodos del conjunto de réplicas.Si se utiliza el esquema tcp:// (obsoleto), el parámetro se establece en true por defecto. |
|
| Plugins.MongoDB.Sessions.<SessionName>.AuthMechanism | no | Mecanismo de autenticación para conectar con el servidor MongoDB. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. Valores soportados: SCRAM-SHA-1, SCRAM-SHA-256 y MONGODB-X509. |
||
| Plugins.MongoDB.Sessions.<SessionName>.AuthSource | no | admin |
Base de datos para autenticar la conexión al servidor MongoDB. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. Si se utiliza el mecanismo de autenticación MONGODB-X509, este parámetro se establece automáticamente en $external; modificarlo a cualquier otro valor provocará un error al iniciar. |
|
| Plugins.MongoDB.Sessions.<SessionName>.ReplicaSet | no | Nombre del conjunto de réplicas, utilizado para el descubrimiento automático de nodos del conjunto de réplicas de MongoDB. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. Si este parámetro se utiliza con el esquema mongodb+srv://, se comportará como si se hubieran proporcionado varias URLs; un servidor DNS puede tener un registro TXT que puede anular este (o cualquier otro) parámetro.No disponible si el parámetro Plugins.MongoDB.Sessions.<SessionName>.Direct está configurado como true, el agent no podrá iniciarse. |
||
| Plugins.MongoDB.Sessions.<SessionName>.ReadPreference | no | Orden para conectarse a los nodos del conjunto de réplicas de MongoDB o fallback. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. Valores soportados: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode y NearestMode.No disponible si el parámetro Plugins.MongoDB.Sessions.<SessionName>.Direct está configurado como true, el agent no podrá iniciarse. |
||
| Plugins.MongoDB.Sessions.<SessionName>.TLSConnect | no | Tipo de cifrado para las comunicaciones entre el agent 2 de Zabbix y las bases de datos monitorizadas. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. Valores soportados: required - requiere conexión TLS;verify\_ca - verifica certificados;verify\_full - verifica certificados y dirección IP.Soportado desde la versión 1.2.1 del plugin. |
||
| Plugins.MongoDB.Sessions.<SessionName>.TLSCAFile | sí, si Plugins.MongoDB.Sessions.<SessionName>.TLSConnect está configurado como uno de: verify_ca, verify_full | Ruta completa de un archivo que contiene los certificados de la(s) CA(s) de nivel superior para la verificación del certificado del par, utilizado para comunicaciones cifradas entre el agent 2 de Zabbix y las bases de datos monitorizadas. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. |
||
| Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile | sí, si Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile está especificado | Ruta completa de un archivo que contiene el certificado del agent o la cadena de certificados, utilizado para comunicaciones cifradas entre el agent 2 de Zabbix y las bases de datos monitorizadas. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. |
||
| Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile | sí, si Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile está especificado | Ruta completa de un archivo que contiene la clave privada de la base de datos utilizada para comunicaciones cifradas entre el agent 2 de Zabbix y las bases de datos monitorizadas. <SessionName> - defina el nombre de una sesión para usar en las claves de los items. |
||
| Plugins.MongoDB.Default.Uri | no | tcp://127.0.0.1:27017 |
URI por defecto para conectar con MongoDB. Debe coincidir con el formato URI. Esquemas soportados: mongodb:// y mongodb+srv://.Esquema obsoleto: tcp:// (utilizado como valor por defecto por compatibilidad con configuraciones existentes).Se puede omitir el puerto (por defecto=27017). Ejemplos: mongodb://127.0.0.1:27017, mongodb+srv://example.com, localhost. |
|
| Plugins.MongoDB.Default.User | no | Nombre de usuario por defecto para conectar con MongoDB. | ||
| Plugins.MongoDB.Default.Password | no | Contraseña por defecto para conectar con MongoDB. | ||
| Plugins.MongoDB.Default.Direct | no | false |
Método de conexión por defecto utilizado para determinar si el descubrimiento automático de nodos del conjunto de réplicas de MongoDB debe estar habilitado o deshabilitado. Valores soportados: true - el plugin se conectará solo al servidor especificado, ignorando otros miembros del conjunto de réplicas;false - el plugin descubrirá automáticamente todos los nodos del conjunto de réplicas.Si se utiliza el esquema tcp:// (obsoleto), el parámetro se establece en true por defecto. |
|
| Plugins.MongoDB.Default.AuthMechanism | no | Mecanismo de autenticación por defecto para conectar con el servidor MongoDB. Valores soportados: SCRAM-SHA-1, SCRAM-SHA-256 y MONGODB-X509.Si no se especifica ningún valor aquí, en una clave de item, en una sesión con nombre o en el URI, se utiliza un mecanismo basado en SCRAM (si se proporciona un nombre de usuario; de lo contrario, no se utilizará autenticación). |
||
| Plugins.MongoDB.Default.AuthSource | no | admin |
Base de datos por defecto para autenticar la conexión al servidor MongoDB. Si se utiliza el mecanismo de autenticación MONGODB-X509, este parámetro se establece automáticamente en $external; modificarlo a cualquier otro valor provocará un error al iniciar. |
|
| Plugins.MongoDB.Default.ReplicaSet | no | Nombre del conjunto de réplicas por defecto; utilizado para el descubrimiento automático de nodos del conjunto de réplicas de MongoDB. Si este parámetro se utiliza con el esquema mongodb+srv://, se comportará como si se hubieran proporcionado varias URLs; un servidor DNS puede tener un registro TXT que puede anular este (o cualquier otro) parámetro.No disponible si el parámetro Plugins.MongoDB.Default.Direct está configurado como true, el agent no podrá iniciarse. |
||
| Plugins.MongoDB.Default.ReadPreference | no | Orden por defecto para conectarse a los nodos del conjunto de réplicas de MongoDB o fallback. Valores soportados: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode y NearestMode.No disponible si el parámetro Plugins.MongoDB.Default.Direct está configurado como true, el agent no podrá iniciarse. |
||
| Plugins.MongoDB.Default.TLSConnect | no | Tipo de cifrado por defecto para las comunicaciones entre el agent 2 de Zabbix y las bases de datos monitorizadas. Valores soportados: required - requiere conexión TLS.verify\_ca - verifica certificados.verify\_full - verifica certificados y dirección IP.Si no se especifica ningún valor aquí, en una clave de item, en una sesión con nombre o en el URI, no se establecerá una conexión TLS. |
||
| Plugins.MongoDB.Default.TLSCAFile | no | Ruta por defecto de un archivo que contiene los certificados de la(s) CA(s) de nivel superior para la verificación del certificado del par. Utilizado para comunicaciones cifradas entre el agent 2 de Zabbix y las bases de datos monitorizadas. | ||
| Plugins.MongoDB.Default.TLSCertFile | no | Ruta por defecto de un archivo que contiene el certificado del cliente MongoDB o la cadena de certificados. Utilizado para comunicaciones cifradas entre el agent 2 de Zabbix y las bases de datos monitorizadas. | ||
| Plugins.MongoDB.Default.TLSKeyFile | no | Ruta por defecto de un archivo que contiene la clave privada del cliente MongoDB utilizada para comunicaciones cifradas entre el agent 2 de Zabbix y las bases de datos monitorizadas. |
Ver también:
- Descripción de los parámetros generales de configuración del agent 2 de Zabbix: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
- Instrucciones para configurar plugins