Pandora azure SQL
Plugin para monitorizar una base de datos AzureSQL
- Introducción
- Matriz de compatibilidad
- Pre requisitos
- Configuración previa
- Parámetros
- Ejecución manual
- Configuración en PandoraFMS
- Módulos generados por el plugin
Introducción
Ver. 11-05-2022
Con este plugin se puede monitorizar una base de datos de azureSQL y sacar datos de esta.
Matriz de compatibilidad
Sistemas donde se ha probado |
CentOS 7, Fedora, rocky linux |
Sistemas donde debería funcionar |
Cualquier sistema linux |
Pre requisitos
- Tener el Data Server de Pandora FMS habilitado
- Tener el Plugin Server de Pandora FMS habilitado
- Conocer algunas credenciales de tu cuenta, como tu tenant id, secret, client id y el resource_Id de la base de datos.
Configuración previa
El plugin hace uso de un fichero en el que se pueden meter dos tipos de datos.
#credentials
tenant_id:<tenant-id>
client_id:<client-id>
secret:<secret>
#id resources
database_id:<database_resource_id>
Obtención de credenciales necesarias para el uso del plugin.
1. Credenciales para autenticar:
-Tenant id
-Client id
-Secret
2. ID de recurso
Es necesaria la id de cada recurso que monitoriza el plugin estas son :
- ID de recurso de la base de datos
Obtención de tenant id y client id.
1. Para obtener el tenant id y el client id, iremos al menú registro de aplicaciones dentro de active directory:
2. Entraremos dentro de la aplicación.
3. En el menú de la aplicación aparecerá el tenant id y el client id.
4. Para encontrar el secreto iremos a certificados y secretos dentro del menu de active directory.
5. Dentro de este menú podremos ver las claves de secreto o generarlas (tiene que ser el valor de la clave, no la id)
Obtención de la id de recurso de la base de datos.
En la base de datos, en información general, podremos ver la id de recurso de la base de datos pinchando en Vista json.
Parámetros
Parámetro | Descripción |
--tentacle_port | Puerto de tentacle.Por defecto 41121(opcional) |
--tentacle_address | Ip del servidor tentacle al que mandar los datos(opcional) |
--agent_name | Para ponerle un nombre al agente que contendrá los módulos , por defecto : "Azure SQL". (opcional) |
--prefix_module | Para ponerle un prefijo a los módulos por si se quieren diferencias de otras ejecuciones.(opcional) |
--conf | Path del archivo conf con las querys (obligatorio) |
-g,--group | Grupo de destino de Pandora FMS (opcional) |
--data_dir | Directorio de datos de Pandora FMS. Por defecto es /var/spool/pandora/data_in/ (opcional) |
--as_agent_plugin | Es opcional, si quieres que el plugin sea de agente y te meta los módulos en el agente de pandora, ejecuta esto con un 1 (opcional) |
Ejecución manual
Ejemplo de ejecución manual:
./pandora_azuresql -c <path_conf>
./pandora_azure -c <path_conf> --as_agent_plugin 1 [--data_dir <path> --agent_name <nombre del agente>]
Configuración en PandoraFMS
Como plugin de servidor
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
Nos saldrá un mensaje que indicará si se ha registrado correctamente
Una vez registrado el plugin, lo veremos en el apartado plugins.
Pinchando en el título accederemos al menu del plugin.
En parámetros, veremos todos los del plugin, recordar que no todos son obligatorios, solo en los que así se especifíca
Abajo, en las macros de los parámetros podremos añadirles el valor requerido.
Instalación manual
Iremos a servidores > plugins:
Pinchamos en añadir:
Le ponemos en nombre y la descripción que se prefiera:
Metemos como comando la ejecución con la ruta del plugin:
/path_pandora_azuresql
Y en parámetros del plugin introduciremos estos seguidos de la macro "_field_", los obligatorios para que el plugin funcione son -c y --as_agent_plugin (en caso de que queramos ejecutarlo como plugin de servidor, si no este último no es imprescindible.
Definiremos estos con las macros abajo.
Una vez hecho esto, daremos a "crear".
Puedes comprobar que has introducido bien los valores ejecutando el comando de vista previa por terminal
Si no da errores es que se ha introducido bien.
Una vez hecho esto, solo queda llamarlo por lo que iremos a la vista de algún agente y crearemos un módulo de complementos:
Le daremos un nombre y en el apartado "plugin" pondremos el que acabamos de configurar.
Una vez hecho esto, damos a crear.
Si el modulo se muestra con 1, quiere decir que se esta ejecutando correctamente
Módulos generados por el plugin
El plugin creará un agente con el nombre que hayamos puesto con el parametro --agent_name.
Y creará los siguientes módulos:
allocated_data_storage |
app_cpu_billed |
app_cpu_percent |
app_memory_percent |
blocked_by_firewall |
connection_failed |
connection_successful |
cpu_limit |
cpu_percent |
cpu_used |
deadlock |
log_write_percent |
physical_data_read_percent |
sessions_percent |
sql_server_process_core_percent |
sql_server_process_memory_percent |
storage |
storage_percent |
tempdb_size |
tempdb_log_size |
tempdb_log_used_Percent |
workers percent |
xtp_storage_percent |
.
.