# Agents y modules generated by the plugin

The plugin will create one agent for each target database.

**Instance metrics**

<table border="1" id="bkmrk-server_startup-locks" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td><div><div>server_startup</div></div></td><td><div><div>Monitors the uptime (in days) of the database server</div></div></td></tr><tr><td><div><div><div><div>locks_used</div></div></div></div></td><td>Monitors percentage of used lock and lock owner blocks</td></tr><tr><td><div><div><div><div><div><div>workspace_memory</div></div></div></div></div></div></td><td>Monitors amount of memory that is used for executing processes such as hash, sort, bulk copy, and index creation operations</td></tr><tr><td><div><div><div><div><div><div>average_waittime</div></div></div></div></div></div></td><td>SQL Server Average Lock Wait Time</td></tr></tbody></table>

 Each agent will contain the following modules if "**engine\_uptime**" is activated:

<table border="1" id="bkmrk-restart_detection-pa" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 50%;">restart\_detection</td><td style="width: 50%;">It will be 0 if an unexpected restart is detected, and 1 if this is not the case. When a server restarts unexpectedly, there can

be a disruption in database access, and potentially, transactions or data may not be saved correctly, leading to data integrity issues.

</td></tr></tbody></table>

If "**query\_stats**" is activated, each agent will contain the following modules:

<table border="1" id="bkmrk-queries-monitorizar-" style="border-collapse: collapse; width: 100%; height: 948px;"><tbody><tr style="height: 130px;"><td style="width: 50%; height: 130px;">queries</td><td style="width: 50%; height: 130px;">**The total number of queries**. Monitoring queries is essential for understanding the workload running on the server and assessing the overall system performance. By monitoring the total number of queries, you can identify activity spikes, optimize performance, and detect potential issues such as inefficient or excessive queries.</td></tr><tr style="height: 164px;"><td style="width: 50%; height: 164px;">update</td><td style="width: 50%; height: 164px;">**The number of UPDATE queries**. UPDATE queries are used to modify existing data in the database. Monitoring UPDATE queries is important to assess the frequency and efficiency of data updates. You can identify UPDATE queries that affect a large number of rows or have a significant impact on server performance. This allows you to optimize queries, review table structures, or take measures to reduce the load generated by updates.</td></tr><tr style="height: 164px;"><td style="width: 50%; height: 164px;">delete</td><td style="width: 50%; height: 164px;">**The number of DELETE queries**. DELETE queries are used to remove data from the database. Monitoring DELETE queries is useful to assess the frequency and efficiency of data deletions. You can identify DELETE queries that affect a large number of rows or have a significant impact on server performance. This allows you to optimize queries, review table structures, or take measures to reduce the load generated by deletions.</td></tr><tr style="height: 180px;"><td style="width: 50%; height: 180px;">insert</td><td style="width: 50%; height: 180px;">**The number of INSERT queries.** INSERT queries are used to add new data to the database. Monitoring INSERT queries allows you to assess the frequency and efficiency of data insertions. You can identify INSERT queries that are generating a high load on the server or may be causing performance issues. This enables you to optimize queries, review table structures, or consider strategies like deferred insertion to enhance performance in high-concurrency environments.</td></tr></tbody></table>

If "**analyze\_connections**" is activated, each agent will contain the following modules:

<table border="1" id="bkmrk-current-connections-" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 50%;">session usage</td><td style="width: 50%;">**The number of current connections relative to the total maximum connections**. Monitoring session usage in SQL Server is important for optimizing performance, identifying locking issues, enhancing security and auditing, and efficiently planning server resources.</td></tr></tbody></table>

If "**retrieve\_memory\_statistics"** is activated, each agent will contain the following modules :

<table border="1" id="bkmrk-lock_memory-connecti" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td><div><div>lock_memory</div></div></td><td>Monitors amount of allocated lock memory in Bytes</td></tr><tr><td><div><div><div><div>connection_memory</div></div></div></div></td><td><div><div>Monitors amount of connection memory in Bytes</div></div></td></tr><tr><td><div><div><div><div>optimizer_memory</div></div></div></div></td><td>Monitors amount of optimizer memory in Bytes</td></tr><tr><td><div><div><div><div><div><div>sqlcache_memory</div></div></div></div></div></div></td><td><div><div>Monitors amount of SQL cache memory in Bytes</div></div></td></tr><tr><td><div><div><div><div><div><div>total_memory</div></div></div></div></div></div></td><td><div><div>Monitors total amount of dynamic server memory in Bytes</div></div></td></tr></tbody></table>

Si esta activado **retrieve\_locks\_statistics:**

<table border="1" id="bkmrk-retrieve_locks_stati" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td><div><div>retrieve_locks_statistics</div></div></td><td><div><div>Monitors the number of deadlocks per second</div></div></td></tr><tr><td><div><div><div><div>lock_timeouts</div></div></div></div></td><td><div><div>Monitor the number of lock-timeouts per second</div></div></td></tr><tr><td><div><div><div><div>lock_requests</div></div></div></div></td><td>Monitor the number of lock-requests per second</td></tr><tr><td><div><div><div><div><div><div>lock_waits</div></div></div></div></div></div></td><td><div><div>Monitor the number of lock-waits per second</div></div></td></tr></tbody></table>

Si esta activado **retrieve\_buffer\_statistics:**

<table border="1" id="bkmrk-buf_cachehit_ratio-f" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td><div><div>buf_cachehit_ratio</div></div></td><td><div><div>Percentage of pages found in the buffer cache without having to read from the disk</div></div></td></tr><tr><td><div><div>free_connections</div></div></td><td><div><div>Monitors % free connections to SQL Server instance</div></div></td></tr><tr><td><div><div>page_reads</div></div></td><td><div><div>Monitors the number of database page reads per second</div></div></td></tr><tr><td><div><div>page_writes</div></div></td><td><div><div>Monitors the number of database page writes per second</div></div></td></tr></tbody></table>

Si esta activado **monitor\_latch\_requests:**

<table border="1" id="bkmrk-latch_waits" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td><div><div>latch_waits</div></div></td><td><div><div>Monitors the number of latch requests per second</div></div></td></tr></tbody></table>

Si esta activado **monitor\_full\_scans:**

<table border="1" id="bkmrk-full_scans" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td><div><div>full_scans</div></div></td><td><div><div>Monitors the number of full scans (table or index) per second</div></div></td></tr></tbody></table>

Si esta activado **check\_engine\_performance:**

<table border="1" id="bkmrk-server_cpu-io_busy-s" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td><div><div>server_cpu</div></div></td><td><div><div>Monitors % of CPU usage by SQL Server instance</div></div></td></tr><tr><td><div><div><div><div>io_busy</div></div></div></div></td><td><div><div>Monitors % of I/O busy for SQL Server instance</div></div></td></tr><tr><td><div><div><div><div>server_io</div></div></div></div></td><td><div><div>Monitors % of I/O busy for SQL Server instance</div></div></td></tr></tbody></table>

Si esta activado **retrieve\_users\_information:**

<table border="1" id="bkmrk-active_connection_ra" style="border-collapse: collapse; width: 100%; height: 135.984px;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr style="height: 46.5938px;"><td style="height: 46.5938px;"><div><div>active_connection_ratio</div></div></td><td style="height: 46.5938px;"><div><div>Monitors ratio of active connections to total allowed connections</div></div></td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>locked_users</div></div></td><td style="height: 29.7969px;">Monitors the number of users suspended by locks</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>blocked_users</div></div></td><td style="height: 29.7969px;"><div><div>Monitors the number of users suspended by locks</div></div></td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>active_users</div></div></td><td style="height: 29.7969px;"><div><div>Monitors the number of users currently logged onto the server</div></div></td></tr></tbody></table>

Si esta activado **monitor\_long\_queries:**

<table border="1" id="bkmrk-long_queries-long_qu" style="border-collapse: collapse; width: 100%; height: 59.5938px;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>long_queries</div></div></td><td style="height: 29.7969px;"><div><div>Monitors long running queries (in seconds)</div></div></td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>long_queries_string</div></div></td><td style="height: 29.7969px;"><div><div>Complete output of long running queries</div></div></td></tr></tbody></table>

Si esta activado **retrieve\_cluster\_state:**

<table border="1" id="bkmrk-aag_cluster_quorum_s" style="border-collapse: collapse; width: 100%; height: 284.969px;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>aag_cluster_quorum_state</div></div></td><td style="height: 29.7969px;"><div><div>State: &lt; desc &gt;. Monitors AlwaysOn WSFC quorum State.</div></div></td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>aag_cluster_members_state</div></div></td><td style="height: 29.7969px;"><div><div>State: &lt; desc &gt;. Monitors AlwaysOn WSFC nodes state</div></div></td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;"><div><div>aag_synchronization_health</div></div></td><td style="height: 46.5938px;"><div><div>State: &lt;desc &gt;. Monitors the synchronization health of an availability group</div></div></td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>aag_replica_synchronization_health</div></div></td><td style="height: 29.7969px;"><div><div>State: &lt; desc &gt;. Role: &lt; role &gt; . Monitors the synchronization health of an availability replica</div></div></td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>aag_replica_connected_state</div></div></td><td style="height: 29.7969px;"><div><div>State: &lt; desc &gt;. Role: &lt; rol &gt; .Monitors connected state of an availability replica</div></div></td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>aag_replica_recovery_health</div></div></td><td style="height: 29.7969px;"><div><div>State: &lt; desc &gt;. Role: &lt; rol&gt; . Monitors the recovery health of an availability replica</div></div></td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>aag_replica_operational_state</div></div></td><td style="height: 29.7969px;"><div><div>State: &lt; state &gt;. Role: &lt; rol &gt;. Monitors the Current operational state of the availability replica</div></div></td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>aag_db_replica_synchronization_state</div></div></td><td style="height: 29.7969px;"><div><div>State: &lt; desc &gt;. Monitors the synchronization state of databases on availability replica</div></div></td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;"><div><div>aag_listener_state</div></div></td><td style="height: 29.7969px;"><div><div>State: &lt; desc &gt;. Role: &lt; rol &gt;. Monitor the AlwaysOn availability Group Listener state</div></div></td></tr></tbody></table>

**Database metrics**

If monitor\_active\_users is enabled :

<table border="1" id="bkmrk-active-users-monitor" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>active users</td><td><div><div>Monitors the number of active user transactions per database</div></div></td></tr></tbody></table>

If retrieve\_transactions\_statistics is enabled:

<table border="1" id="bkmrk-transactions-active-" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>transactions</td><td><div><div>Monitors the number of transactions per second</div></div></td></tr><tr><td>active transactions</td><td><div><div>Active Transactions</div></div></td></tr></tbody></table>

If retrieve\_logs\_statistics is enabled:

<table border="1" id="bkmrk-log_flush_waits-log_" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>log\_flush\_waits</td><td><div><div>Monitors the number of log flush waits per second</div></div></td></tr><tr><td>log\_file\_growths</td><td><div><div>Monitors the usage (growth) of the transaction logs</div></div></td></tr><tr><td>log\_file\_shrinks</td><td><div><div>Monitors the usage (shrinking) of the transaction logs</div></div></td></tr><tr><td>logfile\_size</td><td><div><div>Monitors logfile size</div></div></td></tr><tr><td>logfile\_usage</td><td><div><div>Monitors free space in log files</div></div></td></tr></tbody></table>

If monitor\_backups is enabled:

<table border="1" id="bkmrk-backup_status_minute" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>backup\_status\_minutes</td><td><div><div>Monitors number of minutes since last backup</div></div></td></tr><tr><td>backup\_status\_last\_backup</td><td><div><div>Monitors when last backup was done</div></div></td></tr></tbody></table>

If monitor\_filegroups\_space is enabled:

<table border="1" id="bkmrk-fg_free_space" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>fg\_free\_space</td><td><div><div>Monitors free space in filegroups</div></div></td></tr></tbody></table>

If monitor\_user\_reserved\_space is enabled:

<table border="1" id="bkmrk-monitors-reserved-sp" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>Monitors reserved space in user tables</td><td><div><div>Monitors reserved space in user tables</div></div></td></tr><tr><td>Monitors reserved space free data % in user tables</td><td><div><div>Monitors reserved space free data % in user tables</div></div></td></tr></tbody></table>

The plugin will also create one module for each custom query defined in the configuration file.