# Parámetros y configuración

**Parámetros**

<table border="1" id="bkmrk---conf-ruta-al-archi" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 50%;">--conf</td><td style="width: 50%;">Ruta al archivo de configuración</td></tr><tr><td style="width: 50%;">--target\_databases</td><td style="width: 50%;">Ruta al archivo de configuración que contiene los targets de las bases de datos</td></tr><tr><td style="width: 50%;">--target\_agents</td><td style="width: 50%;">Ruta al archivo de configuración que contiene los targets de los agentes</td></tr><tr><td style="width: 50%;">--custom\_queries</td><td style="width: 50%;">Ruta al archivo de configuración que contiene las consultas personalizadas</td></tr></tbody></table>

**Archivo de configuración (--conf)**

```
agents_group_id = < ID del grupo en el que se crearán los agentes >
interval = < Intervalo de monitorización de los agentes en segundos >
user = < Usuario de conexión >
password = < Contraseña >
threads = < Número de hilos que se usaran para la creación de agentes >
modules_prefix = < Prefijo de módulos >
execute_custom_queries = < Activar con 1 para habilitar el uso de consultas personalizadas >
analyze_connections = < Activar con 1 para habilitar la monitorización de conexiones >
engine_uptime = < Activar con 1 para habilitar la monitorización del tiempo en ejecución >
query_stats = < Activar con 1 para habilitar la monitorización de estadísticas de consultas >
monitor_long_queries = < Activar con 1 para habilitar la monitorización de estadísticas de long queries >
monitor_latch_requests = < Activar con 1 para habilitar la monitorización de estadísticas de latch requests >
monitor_full_scans = < Activar con 1 para habilitar la monitorización de estadísticas de scans >
count_databases = < Activar con 1 para habilitar el conteo de bases de datos  >
retrieve_memory_statistics = < Activar con 1 para habilitar la monitorización de estadísticas de memoria >
retrieve_locks_statistics = < Activar con 1 para habilitar la monitorización de estadísticas de locks >
check_engine_performance = < Activar con 1 para habilitar la monitorización de estadísticas de rendimiento >
retrieve_buffer_statistics = < Activar con 1 para habilitar la monitorización de estadísticas de buffer >
retrieve_users_information = < Activar con 1 para habilitar la monitorización de estadísticas de users >
retrieve_cluster_state = < Activar con 1 para habilitar la monitorización de estadísticas de cluster >
retrieve_logs_statistics = < Activar con 1 para habilitar la monitorización de estadísticas de logs >
monitor_active_users = < Activar con 1 para habilitar la monitorización de estadísticas de usuarios activos >
retrieve_transactions_statistics = < Activar con 1 para habilitar la monitorización de estadísticas de transaccion >
monitor_filegroups_space = < Activar con 1 para habilitar la monitorización de estadísticas de espacio de grupos >
monitor_user_reserved_space = < Activar con 1 para habilitar la monitorización de estadísticas de espacio reservado >

monitor_backups = < Activar con 1 para habilitar la monitorización de estadísticas de backups >
agent_per_database     = < Activar con 1 para habilitar la creación de agentes para cada base de datos  >
db_agent_prefix        = < Prefijo para las bases de datos >
scan_databases         = < Activar con 1 para habilitar la monitorización de bases de datos >

```

<span style="text-decoration: underline;">Ejemplo</span>

```
agents_group_id = 10
interval = 300
user = sa 
password = HHgD85V@
threads = 1
modules_prefix = 
execute_custom_queries = 1
analyze_connections = 1
engine_uptime = 1
query_stats = 1
monitor_long_queries = 1
monitor_latch_requests = 1 
monitor_full_scans = 1
count_databases = 1
retrieve_memory_statistics = 1
retrieve_locks_statistics = 1
check_engine_performance = 1
retrieve_buffer_statistics = 1 
retrieve_users_information = 1
retrieve_cluster_state = 1
retrieve_logs_statistics = 1 
monitor_active_users = 1
retrieve_transactions_statistics = 1
monitor_filegroups_space = 1
monitor_user_reserved_space = 1

monitor_backups = 1
agent_per_database     = 1
db_agent_prefix        = PANDORA-
scan_databases         = 1
```

**Listado de bases de datos objetivo (--target\_databases)**

El contenido del fichero será un listado de bases de datos objetivo, separando cada base de datos por comas o por líneas. El formato para una base de datos podrá ser cualquiera de los siguientes:

```
ip
ip:puerto
ip\instancia
```

<span style="text-decoration: underline;">Ejemplo</span>

```
172.17.0.4:1433\DEVENV
172.17.0.2:1433\PRODENV
```

**Listado de agentes objetivo (--target\_agents)**

El contenido del fichero será un listado de bases de nombres de agentes, separando cada agente por comas o por líneas. Estos nombres de agentes se usarán para volcar la información de cada base de datos objetivo en el nombre de agente indicado correspondiente, en lugar de dejar que el plugin genere los nombres de agentes de forma automática.

La posición de cada nombre de agente en el listado debe coincidir con la posición de la base de datos objetivo en su propio listado, es decir, el nombre para la primera base de datos objetivo será el primer nombre de este listado, teniendo en cuenta que las líneas en blanco son ignoradas.

<span style="text-decoration: underline;">Ejemplo</span>

```
agente1,,agente3
agente4
agente5,agente6,agente7,,agente9
```

**Consultas personalizadas (--custom\_queries)**

Se debe introducir un módulo por cada consulta personalizada que se pretenda monitorizar. Los módulos deben seguir una estructura, que es la siguiente:

<div id="bkmrk-"></div>```
check_begin      --> Etiqueta de abertura del módulo
name             --> Nombre del módulo
description      --> Descripción del módulo.
operation        --> Tipo de operación 
datatype         --> Tipo de módulo
min_warning      --> Configuración del umbral mínimo de warning
max_warning      --> Configuración del umbral máximo de warning
str_warning      --> Configuración de string de warning
warning_inverse  --> Activar el intervalo inverso con 1 para umbral de warning
min_critical     --> Configuración del umbral mínimo de critical
max_critical     --> Configuración del umbral máximo de critical
str_critical     --> Configuración de string de critical
critical_inverse --> Activar el intervalo inverso con 1 para umbral de crítico
module_interval  --> Este intervalo se calcula como un multiplicador del intervalo del agente. 
target           --> Consulta personalizada
target_databases --> Agentes de bases de datos en los que se creará el módulo
check_end        --> Etiqueta de cierre del módulo
```

<span style="text-decoration: underline;">Ejemplo</span>

```
check_begin
name Select 1 
description Number of invalid objects
operation value
datatype generic_data
min_warning 5
target SELECT 1;
target_databases all
check_end

check_begin
name NumeroConexiones
description Number of connections
operation value
datatype generic_data
min_warning 10
target SELECT COUNT(*) AS NumeroConexiones FROM sys.dm_exec_sessions WHERE is_user_process = 1;
target_databases pandora
check_end

check_begin
name lista_table_size.MB
description table size in MB
operation full
datatype generic_data
target SELECT SUM(reserved_page_count) * 8 / 1024.0 AS TamañoMB FROM sys.dm_db_partition_stats WHERE object_id = OBJECT_ID('lista');
target_databases pandora
check_end
```