Parámetros y configuración

Parámetros

--conf	Ruta al archivo de configuración
--target_databases	Ruta al archivo de configuración que contiene los targets de las bases de datos
--target_agents	Ruta al archivo de configuración que contiene los targets de los agentes
--custom_queries	Ruta al archivo de configuración que contiene las consultas personalizadas

Archivo de configuración (--conf)

[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 >
entities_list = < Ruta del fichero de entidades >
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 >

[MODULE_NAMES]
database_size = < Nombre del modulo, por defecto : database_size >
database_usage = < Nombre del modulo, por defecto : database_usage >
restart_detection = < Nombre del modulo, por defecto : restart detection >
queries = < Nombre del modulo, por defecto : queries >
insert = < Nombre del modulo, por defecto : insert >
delete = < Nombre del modulo, por defecto : delete >
update = < Nombre del modulo, por defecto : update >
session_usage = < Nombre del modulo, por defecto : session usage >
database_count = < Nombre del modulo, por defecto : database_count >
server_startup = < Nombre del modulo, por defecto : server_startup >
lock_memory = < Nombre del modulo, por defecto : lock_memory >
connection_memory = < Nombre del modulo, por defecto : connection_memory >
optimizer_memory = < Nombre del modulo, por defecto : optimizer_memory >
sqlcache_memory = < Nombre del modulo, por defecto : sqlcache_memory >
total_memory = < Nombre del modulo, por defecto : total_memory >
deadlocks = < Nombre del modulo, por defecto : deadlocks >
lock_timeouts = < Nombre del modulo, por defecto : lock_timeouts >
lock_requests = < Nombre del modulo, por defecto : lock_requests >
lock_waits = < Nombre del modulo, por defecto : lock_waits >
buf_cachehit_ratio = < Nombre del modulo, por defecto : buf_cachehit_ratio >
free_connections = < Nombre del modulo, por defecto : free_connections >
page_reads = < Nombre del modulo, por defecto : page_reads >
page_writes = < Nombre del modulo, por defecto : page_writes >
latch_waits = < Nombre del modulo, por defecto : latch_waits >
full_scans = < Nombre del modulo, por defecto : full_scans >
locks_used = < Nombre del modulo, por defecto : locks_used >
workspace_memory = < Nombre del modulo, por defecto : workspace_memory >
average_waittime = < Nombre del modulo, por defecto : average_waittime >
server_cpu = < Nombre del modulo, por defecto : server_cpu >
server_io = < Nombre del modulo, por defecto : server_io >
active_connection_ratio = < Nombre del modulo, por defecto : active_connection_ratio >
locked_users = < Nombre del modulo, por defecto : locked_users >
blocked_users = < Nombre del modulo, por defecto : blocked_users >
active_users = < Nombre del modulo, por defecto : active_users >
long_queries = < Nombre del modulo, por defecto : long_queries >
long_queries_string = < Nombre del modulo, por defecto : long_queries_string >
aag_cluster_quorum_state = < Nombre del modulo, por defecto : aag_cluster_quorum_state >
aag_cluster_members_state = < Nombre del modulo, por defecto : aag_cluster_members_state >
aag_synchronization_health = < Nombre del modulo, por defecto : aag_synchronization_health >
aag_replica_synchronization_health = < Nombre del modulo, por defecto : aag_replica_synchronization_health >
aag_replica_connected_state = < Nombre del modulo, por defecto : aag_replica_connected_state >
aag_replica_recovery_health = < Nombre del modulo, por defecto : aag_replica_recovery_health >
aag_replica_operational_state = < Nombre del modulo, por defecto : aag_replica_operational_state >
aag_db_replica_synchronization_state = < Nombre del modulo, por defecto : aag_db_replica_synchronization_state >
aag_listener_state = < Nombre del modulo, por defecto : aag_listener_state >

availability = < Nombre del modulo, por defecto : availability >
state = < Nombre del modulo, por defecto : state >
db_active_users = < Nombre del modulo, por defecto : active users >
transactions = < Nombre del modulo, por defecto : transactions >
active_transactions = < Nombre del modulo, por defecto : active_transactions >
log_flush_waits = < Nombre del modulo, por defecto : log_flush_waits >
log_file_growths = < Nombre del modulo, por defecto : log_file_growths >
log_file_shrinks = < Nombre del modulo, por defecto : log_file_shrinks >
logfile_size = < Nombre del modulo, por defecto : logfile_size >
logfile_usage = < Nombre del modulo, por defecto : logfile_usage >
log_cachehit_ratio = < Nombre del modulo, por defecto : log_cachehit_ratio >
backup_status_minutes = < Nombre del modulo, por defecto : backup_status_minutes >
backup_status_last_backup = < Nombre del modulo, por defecto : backup_status_last_backup >
fg_free_space = < Nombre del modulo, por defecto : fg_free_space >

Ejemplo

[CONF]
agents_group_id = 10
interval = 300
user = sa 
password = HHgD85V@
threads = 1
modules_prefix = 
entities_list= /tmp/mssql_entities_list.txt
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

[MODULE_NAMES]
database_size = database_size
database_usage = database_usage
restart_detection = restart detection
queries = queries
insert = insert
delete = delete
update = update
session_usage = session usage
database_count = database_count
server_startup = server_startup
lock_memory = lock_memory
connection_memory = connection_memory
optimizer_memory = optimizer_memory
sqlcache_memory = sqlcache_memory
total_memory = total_memory
deadlocks = deadlocks
lock_timeouts = lock_timeouts
lock_requests = lock_requests
lock_waits = lock_waits
buf_cachehit_ratio = buf_cachehit_ratio
free_connections = free_connections
page_reads = page_reads
page_writes = page_writes
latch_waits = latch_waits
full_scans = full_scans
locks_used = locks_used
workspace_memory = workspace_memory
average_waittime = average_waittime
server_cpu = server_cpu
server_io = server_io
active_connection_ratio = active_connection_ratio
locked_users = locked_users
blocked_users = blocked_users
active_users = active_users
long_queries = long_queries
long_queries_string = long_queries_string
aag_cluster_quorum_state = aag_cluster_quorum_state
aag_cluster_members_state = aag_cluster_members_state
aag_synchronization_health = aag_synchronization_health
aag_replica_synchronization_health = aag_replica_synchronization_health
aag_replica_connected_state = aag_replica_connected_state
aag_replica_recovery_health = aag_replica_recovery_health
aag_replica_operational_state = aag_replica_operational_state
aag_db_replica_synchronization_state = aag_db_replica_synchronization_state
aag_listener_state = aag_listener_state

availability = availability
state = state
db_active_users = active users
transactions = transactions
active_transactions = active_transactions
log_flush_waits = log_flush_waits
log_file_growths = log_file_growths
log_file_shrinks = log_file_shrinks
logfile_size = logfile_size
logfile_usage = logfile_usage
log_cachehit_ratio = log_cachehit_ratio
backup_status_minutes = backup_status_minutes
backup_status_last_backup = backup_status_last_backup
fg_free_space = fg_free_space

Listado de bases de datos objetivo (--target_databases)

El contenido del fichero será un listado de instancias 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

Ejemplo

172.17.0.4:1433\DEVENV
172.17.0.2:1433\PRODENV

Si se especifícan de esta manera,  se monitorizarán todas las bases de datos de cada instancia.

Si que quiere monitorizar bases concretas de una instancia, se deben especificar con "|" y separando cada base de datos con ";".

Ejemplo :

172.17.0.4:1433\DEVENV|pandora;testing;model

Si se quiere monitorizar todas las bases de datos de una instancia, pero descartar algunas, se debe especificar "!" antes del "|".

Ejemplo:

172.17.0.4:1433\DEVENV!|pandora;testing;model

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.

Ejemplo

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:

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 instancias en los que se creará el módulo, o nombre de de base de datos en las que se creara el módulo. Si se quiere aplicar a todos los elementos, se puede especificar: All o no especificarse directamente.
target_scope     --> Elemento de destino al que se aplicará la consulta personalizada, puede ser: instances o databases. Si no se especifica se aplicara tanto a instancias como a bases de datos.
ignore_databases --> Agentes de instancias en los que no se creara el módulo o nombres de bases de datos en los que no se creará el módulo.
check_end        --> Etiqueta de cierre del módulo

Ejemplo

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 all
target_scope databases
ignore_databases master
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