Mongo DB y Mongo
DB atlas
Plugin para coger los stats de una base de datos y de sus colecciones, soporta compatibilidad con
Mongo DB atlas.
Introducción
Matriz de compatibilidad
Pre requisitos
Configuración
Parámetros generales del plugin
Parámetros específicos del plugin
Ejecución manual
Configuración en pandora
Modulos generados
Introducción
Ver. 25-08-2021
Con este plug-in podremos ver los stats de una base de datos y de sus colecciones, soporta
compatibilidad con Mongo DB atlas
Tipo: Plug-in de servidor o agente
Matriz de compatibilidad
Sistemas donde se ha probado CentOS 7, Fedora
Sistemas donde debería funcionar Cualquier sistema linux
Pre requisitos
Se requiere:
Una base de datos Mongo DB o Mongo DB atlas
Tener el Data Server de Pandora FMS habilitado
Tener el Plugin Server de Pandora FMS habilitado
Configuración
Para el uso del plugin será necesario tener instalado una serie de dependencias.
Lo primero es tener instalado python 3
yum install python3
El plugin viene con un archivo llamado requirements.txt que instalará las otras dependencias
necesarias. Para ejecutarlo usaremos:
pip3 install -r requirements.txt
No obstante, si quieres instalar sus dependencias sin el archivo requirements, puedes usar los
siguientes comandos (recomendado si no usas una base de datos Mongo DB atlas)
PyMongo
python -m pip install pymongo
o con el siguiente comando si python 3 no es tu versión de python por defecto:
python3 -m pip install pymongo
dnspython
python -m pip install dnspython
o con el siguiente comando si python 3 no es tu versión de python por defecto:
python3 -m pip install pymongo
nota: dnspython solo es imprescindible si usas una base de datos MongoDB atlas.
Para conectarte, necesitas conocer tu ip o uri de conexión. Si te has montado la base de datos en
docker puedes verlo con :
docker inspect <id-contenedor>
El puerto por defecto suele ser 27017. Por ejemplo con esta ip la url de conexión sería :
mongodb://172.17.0.2:27017
Para MongoDB atlas, necesitaremos la cadena de conexión, esta se obtiene haciendo lo siguiente.
Vamos a connect:
Nos saldrán varias opciones para conectarnos:
Yo por ejemplo, he optado por MongoDB compass, al darle, nos mostrará la cadena de conexión, si
es que ya lo hemos instalado, o nos dará la opción de instalarlo.
Esa sería la cadena de conexión, obviamente habría que cambiar <password> por tu contraseña.
Parámetros generales del
plugin
./pandora_mongodb -u <uri> -d <databases -s <server> -a <alldatabases> -p <prefix> -c
<collectionstats> [ -g <group> ] [ --data_dir <data dir> ] [ --as_agent_plugin 1]
Si la ejecución es correcta veremos un número entero, que sera el numero de base de datos que
tengamos.
Si queremos ejecutarlo como plugin de agente lo haremos usando el parámetro opcional
"as_agent_plugin" con un "1" que nos devolverá un xml con los datos de nuestro servidor :
Esto solo funcionará si metes una única base de datos con el parámetro -d , no funcionara con -a
que es el parámetro para todas las bases de datos.
Parámetros específicos del
plugin
El plug-in contiene los siguientes parámetros:
Parameter Description
-u <uri> --u <uri> La uri de conexión (obligatorio)
-s <server> --server <server> Para activar los stats del server (cluster)
-d <name_database> --databases Para coger los stats de una base de datos, la
<name_database> del nombre que tu introduzcas
Para coger los stats de todas las bases de
-a <1> --alldatabases <1>
datos, se activa con 1
Para poner un nombre en los agentes
-p <prefix> --prefix <prefix>
(opcional)
Para activar los stats de las colecciones de la
-c <1> --collectionstats <1>
base de datos, se activa con 1 (opcional)
-g GROUP, --group GROUP Grupo de destino de Pandora FMS (opcional)
Directorio de datos de Pandora FMS. Por
--data_dir DATA_DIR defecto es /var/spool/pandora/data_in/
(opcional)
Es opcional, si quieres que el plugin sea de
--as_agent_plugin agente y te meta los módulos en el agente de
pandora, ejecuta esto con un 1 (opcional)
Ejemplo de ayuda:
./pandora_mongodb
Ejecución manual
Podemos comprobar el plugin desde el terminal para ver si funciona, para comprobarlo,
ejecutamos el plugin:
Con as_agent_plugin:
Ejemplo de ejecución con ayuda:
Configuración en pandora
Instalación desde consola
Para el registro del plugin, desde la consola, se debe ir al apartado "registrar plugin".
Daremos a seleccionar archivo.
Seleccionaremos el fichero pspz2 que contiene el plugin.
Una vez subido se podrá ver un mensaje indicando que esta registrado correctamente.
Una vez registrado el plugin, lo veremos en el apartado plugins.
En el apartado parámetros veremos todos los que usa el plugin, no todos son imprescindibles para
su funcionamiento, solo los que salen como obligatorios en parámetros.
En el apartado de abajo veremos todos los parámetros utilizados y se les podrá asignar el valor
requerido.
Instalación manual
La mejor forma de manejar plugins de servidor en Pandora es desde
"/usr/share/pandora_server/util/plugin" asi que lo enviaremos esa ruta.
Después nos moveremos a la carpeta en la que lo hemos metido (
"/usr/share/pandora_server/util/plugin" es la recomendada").
Recuerda: Tienes que instalar las dependencias que necesita el módulo PyMongo en tu
sistema, esta explicado en el apartado configuración.
Nos movemos desde home con :
cd /usr/share/pandora_server/util/plugin/
Ejecutamos el plugin para ver que funciona :
./pandora_mongodb -u <uri> -s <server> -d <databases -a <alldatabases> -p <prefix> -c
<collectionstats> [ -g <group> ] [ --data_dir <data dir> ] [ --as_agent_plugin 1]
Con as_agent_plugin 1 podremos ver un XML con los datos que nos saldrán en consola:
Si lo ejecutamos de la primera manera, sin "as_agent_plugin 1" se nos habrá creado un agente por
cada database de nuestro cluster. El parámetro --as_agent_plugin solo podremos ejecutarlo si
metemos las bases de datos una a una introduciendo su nombre con el parámetro -d.
De todas formas, por si se prefiere instalarlo manualmente desde la consola, el proceso sería el
siguiente:
Como plugin de servidor
Iremos a servidores > plugins:
Pinchamos en añadir:
Le ponemos en nombre y la descripción que se prefiera:
Metemos como comando la ruta al plugin, y como parámetros los que hemos metido ejecutando el
plugin, los campos "_field_" son macros definidas más abajo.
Ponemos por cada macro la descripción que se prefiera y como valor los datos de mongodb.
Hecho esto si ejecutamos el plugin desde el terminal se nos habrá creado el agente con los
módulos.
Modulos generados
Se nos creara un agente por cada database de nuestro cluster con datos de los stats de las
databases y de las colecciones y otro agente con módulos con los datos del server.
Módulos database
Nombre módulo
collections
views
objects
avgObjSize
datasize
storagesize
totalfreestoragesize
numextents
indexes
indexsize
filesize
nssizemb
status
Módulos colecciones
Nombre módulo
size
count
avgobjsize
storagesize
freestoragesize
capped
nindexes
totalindexsizes
totalsizes
scalefactor
status
Módulos server :
connections current
connections avalaible
connections total created
network bytes in
network bytes out
network num requests
operations insert
operations query
operations update
operations delete
operations get more
operations command
writes latency
writes ops
reads latency
reads ops
commands latency
commands ops
