Complemento de MongoDB

Resumen

Los parámetros de configuración permiten personalizar el comportamiento del plugin de MongoDB.

Se recomienda especificarlos en su propio archivo de configuración (por ejemplo, mongodb.conf), en lugar de hacerlo en el archivo de configuración de agent 2. Luego, use la directiva Include para incluir este archivo en la configuración de Zabbix agent 2.

El plugin de MongoDB es un plugin cargable y está disponible y descrito completamente en el repositorio del plugin de MongoDB.

Todos los parámetros son opcionales, salvo que se indique explícitamente que el parámetro es obligatorio.

Al conectarse a MongoDB, el plugin comprueba su configuración en un orden específico, que determina qué valor se utilizará. El orden, de mayor a menor prioridad, es el siguiente:

1. Parámetros especificados en la URI de conexión (por ejemplo, los parámetros de consulta definidos después de ? en Plugins.MongoDB.Sessions.<session_name>.Uri tienen la máxima prioridad).
2. Parámetros en la clave de item de Zabbix agent 2 (por ejemplo, mongodb.collection.stats).
3. Parámetros definidos en una sesión con nombre (por ejemplo, Plugins.MongoDB.Sessions.<SessionName>.User, Plugins.MongoDB.Sessions.<SessionName>.Password).
4. Valores predeterminados (por ejemplo, Plugins.MongoDB.Default.User, Plugins.MongoDB.Default.Password).

Por ejemplo:

• Si especifica la base de datos para autenticar una conexión al server de MongoDB en el parámetro *.<SessionName>.Uri (por ejemplo, Plugins.MongoDB.Sessions.<session_name>.Uri=mongodb://user:[email protected]:27017/?authSource=admin), el plugin considerará que el parámetro *.<SessionName>.AuthSource está establecido en admin, incluso si el parámetro *.<SessionName>.AuthSource tiene asignado otro valor.
• Si especifica la 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 de item de Zabbix agent 2, el plugin utilizará el nombre de usuario y la contraseña de la clave de item, incluso si Plugins.MongoDB.Sessions.<SessionName>.User y Plugins.MongoDB.Sessions.<SessionName>.Password están configurados.

Esta página está estructurada de la siguiente manera:

• Resumen de parámetros (para ver los detalles completos de un parámetro, haga clic en su nombre)
• Detalles de parámetros

Tenga en cuenta que:

• Los valores predeterminados reflejan los valores predeterminados del proceso, no los valores de los archivos de configuración suministrados.
• 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.

Detalles del parámetro

Plugins.MongoDB.Default.AuthMechanism

Especifique el mecanismo de autenticación predeterminado para conectarse al server de MongoDB.
<SessionName> - defina el nombre de una sesión para usar en las claves de item.

Rango: SCRAM-SHA-1, SCRAM-SHA-256 o MONGODB-X509

Plugins.MongoDB.Default.AuthSource

Especifique la base de datos predeterminada para autenticar la conexión al server de MongoDB.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.

Predeterminado: admin

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 iniciarse.

Plugins.MongoDB.Default.Direct

Deshabilita el descubrimiento automático de nodos del conjunto de réplicas de MongoDB.
<SessionName> - define el nombre de una sesión para usar en las claves de item.

Predeterminado: false
Rango: true - conectarse solo al server especificado, ignorando a los demás miembros del conjunto de réplicas, false - descubrir automáticamente todos los nodos del conjunto de réplicas.

Si se usa el esquema tcp:// (obsoleto), el parámetro se establece en true de forma predeterminada.

Plugins.MongoDB.Default.Password

Especifique la contraseña predeterminada.
<SessionName> - defina el nombre de una sesión para usar en las claves de item.

Plugins.MongoDB.Default.ReplicaSet

Especifique el nombre predeterminado 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 usarlo en las claves de item.
Si este parámetro se usa con el esquema mongodb+srv://, se comportará como si se hubieran proporcionado varias URL; un servidor DNS puede tener un registro TXT que puede anular este parámetro (o cualquier otro).
No está disponible si el parámetro Plugins.MongoDB.Sessions.<SessionName>.Direct está establecido en true; el agent no podrá iniciarse.

Plugins.MongoDB.Default.ReadPreference

Especifique el orden predeterminado para conectarse a los nodos del replica set de MongoDB o como alternativa.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
No está disponible si el parámetro Plugins.MongoDB.Sessions.<SessionName>.Direct está establecido en true; el agent no podrá iniciarse.

Rango: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode o NearestMode

Plugins.MongoDB.Default.TLSConnect

Especifique el nivel de cifrado requerido para las comunicaciones entre Zabbix agent 2 y las bases de datos monitorizadas.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Compatible desde la versión 1.2.1 del plugin.

Rango: required - requiere conexión TLS, verify_ca - verifica certificados, verify_full - verifica certificados y dirección IP

Plugins.MongoDB.Default.TLSCAFile

Especifique la ruta completa del archivo que contiene los certificados de CA de nivel superior para la verificación del certificado del par, utilizados para las comunicaciones cifradas entre Zabbix agent 2 y las bases de datos supervisadas.
<SessionName> - define el nombre de una sesión para usar en las claves de item.

Obligatorio: yes, si Plugins.MongoDB.Sessions.<SessionName>.TLSConnect está establecido en verify_ca o verify_full

Plugins.MongoDB.Default.TLSCertFile

Especifique la ruta completa del archivo que contiene el certificado del agent o la cadena de certificados, utilizado para las comunicaciones cifradas entre Zabbix agent 2 y las bases de datos monitorizadas.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.

Obligatorio: yes, si se especifica Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile

Plugins.MongoDB.Default.TLSKeyFile

Especifique la ruta completa del archivo que contiene la clave privada de la base de datos, utilizada para las comunicaciones cifradas entre Zabbix agent 2 y las bases de datos monitorizadas.
<SessionName> - define el nombre de una sesión para usar en las claves de item.

Obligatorio: yes, si se especifica Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile

Plugins.MongoDB.Default.Uri

Especifique el URI predeterminado.
<SessionName> - defina el nombre de una sesión para usarlo en las claves de item.
Debe coincidir con el formato del URI.
Esquemas compatibles: mongodb:// y mongodb+srv://; el esquema tcp:// está obsoleto y se mantiene por compatibilidad con configuraciones existentes.
Se puede omitir un puerto (default=27017).
Ejemplos: ``

Predeterminado: tcp://127.0.0.1:27017

Ejemplos:

mongodb://127.0.0.1:27017
mongodb+srv://example.com
localhost

Plugins.MongoDB.Default.User

Especifique el nombre de usuario predeterminado.
<SessionName> - defina el nombre de una sesión para usarlo en las claves de item.

Plugins.MongoDB.KeepAlive

Establece el tiempo máximo de espera (en segundos) antes de que se cierren las conexiones del plugin no utilizadas.

Predeterminado: 300
Rango: 60-900

Plugins.MongoDB.Sessions.<SessionName>.AuthMechanism

Especifica el mecanismo de autenticación de la sesión con nombre para conectarse al server de MongoDB.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.

Rango: SCRAM-SHA-1, SCRAM-SHA-256 o MONGODB-X509

Plugins.MongoDB.Sessions.<SessionName>.AuthSource

Especifique la base de datos de la sesión con nombre para autenticar la conexión al server de MongoDB.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.

Predeterminado: admin

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>.Direct

Deshabilita el descubrimiento automático de nodos del replica set de MongoDB para la sesión con nombre.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.

Predeterminado: false
Rango: true - conectarse solo al server especificado, ignorando a otros miembros del replica set, false - descubrir automáticamente todos los nodos del replica set.

Si se usa el esquema tcp:// (obsoleto), el parámetro se establece en true de forma predeterminada.

Plugins.MongoDB.Sessions.<SessionName>.Password

Especifique la contraseña de la sesión con nombre.
<SessionName> - defina el nombre de una sesión para usarlo en las claves de item.

Plugins.MongoDB.Sessions.<SessionName>.ReplicaSet

Especifica el nombre del replica set de la sesión con nombre, utilizado para el descubrimiento automático de nodos del replica set de MongoDB.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Si este parámetro se usa con el esquema mongodb+srv://, se comportará como si se hubieran proporcionado varias URL; un servidor DNS puede tener un registro TXT que puede anular este parámetro (o cualquier otro).
No está disponible si el parámetro Plugins.MongoDB.Sessions.<SessionName>.Direct está establecido en true; el agent no podrá iniciarse.

Plugins.MongoDB.Sessions.<SessionName>.ReadPreference

Especifique el orden de la sesión con nombre para conectarse a los nodos del conjunto de réplicas de MongoDB o como alternativa.
<SessionName> - defina el nombre de una sesión para usarlo en las claves de item.
No está disponible si el parámetro Plugins.MongoDB.Sessions.<SessionName>.Direct está establecido en true; el agent no podrá iniciarse.

Rango: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode o NearestMode

Plugins.MongoDB.Sessions.<SessionName>.TLSConnect

Especifique el nivel de cifrado requerido para las comunicaciones entre Zabbix agent 2 y las bases de datos monitorizadas para la sesión indicada.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Compatible desde la versión 1.2.1 del plugin.

Rango: required - requiere conexión TLS, verify_ca - verifica los certificados, verify_full - verifica los certificados y la dirección IP

Plugins.MongoDB.Sessions.<SessionName>.TLSCAFile

Especifique la ruta completa del archivo que contiene los certificados de la CA de nivel superior para la verificación del certificado del par, utilizados para las comunicaciones cifradas entre Zabbix agent 2 y las bases de datos monitorizadas para la sesión con nombre.
<SessionName> - defina el nombre de una sesión para usarlo en las claves de item.

Obligatorio: yes, si Plugins.MongoDB.Sessions.<SessionName>.TLSConnect está establecido en verify_ca o verify_full

Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile

Especifique la ruta completa del archivo que contiene el certificado del agent o la cadena de certificados, utilizado para las comunicaciones cifradas entre Zabbix agent 2 y las bases de datos monitorizadas para la sesión indicada.
<SessionName> - defina el nombre de una sesión para usarlo en las claves de item.

Obligatorio: yes, si se especifica Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile

Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile

Especifique la ruta completa del archivo que contiene la clave privada de la base de datos, utilizada para comunicaciones cifradas entre Zabbix agent 2 y las bases de datos monitorizadas para la sesión especificada.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.

Obligatorio: yes, si se especifica Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile

Plugins.MongoDB.Sessions.<SessionName>.Uri

Especifique el URI de la sesión con nombre.
<SessionName> - defina el nombre de una sesión para usarlo en las claves de item.
Debe coincidir con el formato URI.
Esquemas compatibles: mongodb:// y mongodb+srv://; el esquema tcp:// está obsoleto y se mantiene por compatibilidad con configuraciones existentes.
Se puede omitir un puerto (predeterminado=27017).
Ejemplos: ``

Predeterminado: tcp://127.0.0.1:27017

Ejemplos:

mongodb://127.0.0.1:27017
mongodb+srv://example.com
localhost

Plugins.MongoDB.Sessions.<SessionName>.User

Especifica el nombre de usuario de la sesión indicada.
<SessionName> - define el nombre de una sesión para usar en las claves de item.

Plugins.MongoDB.System.Path

Especifique la ruta al ejecutable del plugin de MongoDB.

Ejemplo de uso: Plugins.MongoDB.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mongodb

Plugins.MongoDB.Timeout

Establece el tiempo de espera de ejecución de la solicitud (la duración, en segundos, que se espera a que una solicitud se complete antes de interrumpirla).

Predeterminado: global timeout
Rango: 1-30

Opciones

Véase también

• Descripción de los parámetros de configuración generales de Zabbix agent 2: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
• Instrucciones para configurar plugins