--- title: SQL Server description: Collect important SQL Server performance and health metrics. breadcrumbs: Docs > Integrations > SQL Server --- # SQL Server Supported OS Integration version23.0.0 ## Overview{% #overview %} The SQL Server integration tracks the performance of your SQL Server instances. It collects metrics for number of user connections, rate of SQL compilations, and more. Enable [Database Monitoring](https://docs.datadoghq.com/database_monitoring/setup_sql_server.md) (DBM) for enhanced insight into query performance and database health. In addition to the standard integration, Datadog DBM provides query-level metrics, live and historical query snapshots, wait event analysis, database load, query explain plans, and blocking query insights. SQL Server 2012, 2014, 2016, 2017, 2019, and 2022 are supported. **Minimum Agent version:** 6.0.0 ## Setup{% #setup %} {% alert level="info" %} This page describes the SQL Server Agent standard integration. If you are looking for the Database Monitoring product for SQL Server, see Datadog Database Monitoring. {% /alert %} ### Installation{% #installation %} The SQL Server check is included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package. No additional installation is necessary on your SQL Server instances. Make sure that your SQL Server instance supports SQL Server authentication by enabling "SQL Server and Windows Authentication mode" in the server properties: *Server Properties* -> *Security* -> *SQL Server and Windows Authentication mode* ### Prerequisite{% #prerequisite %} **Note**: To install Database Monitoring for SQL Server, select your hosting solution on the [documentation site](https://docs.datadoghq.com/database_monitoring.md#sqlserver) for instructions. Supported versions of SQL Server for the SQL Server check are the same as for Database Monitoring. Visit the [Setting up SQL Server page](https://docs.datadoghq.com/database_monitoring/setup_sql_server.md) to see the currently supported versions under the **Self-hosted** heading. Proceed with the following steps in this guide only if you are installing the standard integration alone. 1. Create a read-only login to connect to your server: ```SQL CREATE LOGIN datadog WITH PASSWORD = ''; USE master; CREATE USER datadog FOR LOGIN datadog; GRANT SELECT on sys.dm_os_performance_counters to datadog; GRANT VIEW SERVER STATE to datadog; ``` To collect file size metrics per database, ensure the user you created (`datadog`) has [connect permission access](https://docs.microsoft.com/en-us/sql/t-sql/statements/grant-server-permissions-transact-sql?view=sql-server-ver15) to your databases by running: ```SQL GRANT CONNECT ANY DATABASE to datadog; ``` 1. (Required for AlwaysOn and `sys.master_files` metrics) To gather AlwaysOn and `sys.master_files` metrics, grant the following additional permission: ```SQL GRANT VIEW ANY DEFINITION to datadog; ``` ### Configuration{% #configuration %} {% tab title="Host" %} #### Host{% #host %} To configure this check for an Agent running on a host: 1. Edit the `sqlserver.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory](https://docs.datadoghq.com/agent/guide/agent-configuration-files.md#agent-configuration-directory). See the [sample sqlserver.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/sqlserver/datadog_checks/sqlserver/data/conf.yaml.example) for all available configuration options: ```yaml init_config: instances: - host: "," username: datadog password: "" connector: adodbapi adoprovider: MSOLEDBSQL19 # Replace with MSOLEDBSQL for versions 18 and previous ``` If you use port autodiscovery, use `0` for `SQL_PORT`. See the [example check configuration](https://github.com/DataDog/integrations-core/blob/master/sqlserver/datadog_checks/sqlserver/data/conf.yaml.example) for a comprehensive description of all options, including how to use custom queries to create your own metrics. Use [supported drivers](https://docs.datadoghq.com/database_monitoring/setup_sql_server/selfhosted.md#supported-drivers) based on your SQL Server setup. **Note**: It is also possible to use the Windows Authentication and not specify the username/password with: ```yaml connection_string: "Trusted_Connection=yes" ``` 1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-and-restart-the-agent). ##### Linux{% #linux %} Extra configuration steps are required to get the SQL Server integration running on a Linux host: 1. Install an ODBC SQL Server driver, for example the [Microsoft ODBC driver](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server?view=sql-server-2017) or the [FreeTDS driver](http://www.freetds.org/). 1. Copy the `odbc.ini` and `odbcinst.ini` files into the `/opt/datadog-agent/embedded/etc` folder. 1. Configure the `conf.yaml` file to use the `odbc` connector and specify the proper driver as indicated in the `odbcinst.ini` file. ##### Log collection{% #log-collection %} *Available for Agent versions >6.0* 1. Collecting logs is disabled by default in the Datadog Agent, enable it in your `datadog.yaml` file: ```yaml logs_enabled: true ``` 1. Add this configuration block to your `sqlserver.d/conf.yaml` file to start collecting your SQL Server logs: ```yaml logs: - type: file encoding: utf-16-le path: "" source: sqlserver service: "" ``` Change the `path` and `service` parameter values based on your environment. See the [sample sqlserver.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/sqlserver/datadog_checks/sqlserver/data/conf.yaml.example) for all available configuration options. 1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-and-restart-the-agent). {% /tab %} {% tab title="Containerized" %} #### Containerized{% #containerized %} For containerized environments, see the [Autodiscovery Integration Templates](https://docs.datadoghq.com/agent/kubernetes/integrations.md) for guidance on applying the parameters below. ##### Metric collection{% #metric-collection %} | Parameter | Value | | -------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `` | `sqlserver` | | `` | blank or `{}` | | `` | `{"host": "%%host%%,%%port%%", "username": "datadog", "password": "", "connector": "odbc", "driver": "FreeTDS"}` | See [Autodiscovery template variables](https://docs.datadoghq.com/agent/faq/template_variables.md) for details on passing `` as an environment variable instead of a label. ##### Log collection{% #log-collection %} *Available for Agent versions >6.0* Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes Log Collection](https://docs.datadoghq.com/agent/kubernetes/log.md). | Parameter | Value | | -------------- | ------------------------------------------------- | | `` | `{"source": "sqlserver", "service": "sqlserver"}` | {% /tab %} ### Validation{% #validation %} [Run the Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands.md#agent-status-and-information) and look for `sqlserver` under the Checks section. ## Data Collected{% #data-collected %} ### Metrics{% #metrics %} | | | | | **sqlserver.access.full\_scans**(gauge) | Number of unrestricted full scans per second. These can be either base-table or full-index scans. (Perf. Counter: `Access Methods - Full Scans/sec`)*Shown as operation* | | **sqlserver.access.index\_searches**(gauge) | Number of index searches per second. These are used to start a range scan, reposition a range scan, revalidate a scan point, fetch a single index record, and search down the index to locate where to insert a new row. (Perf. Counter: `Access Methods - Index Searches/sec`)*Shown as operation* | | **sqlserver.access.page\_splits**(gauge) | The number of page splits per second. (Perf. Counter: `Access Methods - Page Splits/sec`)*Shown as operation* | | **sqlserver.access.probe\_scans**(gauge) | Number of probe scans per second that are used to find at most one single qualified row in an index or base table directly. (Perf. Counter: `Access Methods - Probe Scans/sec`)*Shown as operation* | | **sqlserver.access.range\_scans**(gauge) | Number of qualified range scans through indexes per second. (Perf. Counter: `Access Methods - Range Scans/sec`)*Shown as operation* | | **sqlserver.agent.active\_jobs.duration**(gauge) | Duration of currently running jobs on sqlserver agent (DBM Only)*Shown as second* | | **sqlserver.agent.active\_jobs.step\_info**(gauge) | Presence of a most recent completed step for active jobs running on the sqlserver agent (DBM Only) | | **sqlserver.agent.completed\_jobs.duration**(gauge) | Duration of completed jobs on sqlserver agent (DBM Only)*Shown as second* | | **sqlserver.agent.completed\_jobs.executions**(gauge) | Number of executions of completed jobs on sqlserver agent (DBM Only)*Shown as execution* | | **sqlserver.ao.ag\_sync\_health**(gauge) | Availability group synchronization health: 0 = Not healthy, 1 = Partially healthy, 2 = Healthy. Tags: `availability_group`, `availability_group_name`, `synchronization_health_desc` | | **sqlserver.ao.filestream\_send\_rate**(gauge) | The rate at which the FILESTREAM files are shipped to the secondary replica. Tags: `availability_group`, `availability_group_name`, `replica_server_name`, `failover_mode`, `availability_mode`, `db`, `replica_id`, `database_id`, `database_state`, `synchronization_state`, `failover_cluster`, `replica_role`*Shown as byte* | | **sqlserver.ao.is\_primary\_replica**(gauge) | Denotes if a replica is a primary(1) or secondary(0). Tags: `availability_group`, `availability_group_name`, `replica_server_name`, `failover_mode`, `availability_mode`, `db`, `replica_id`, `database_id`, `database_state`, `synchronization_state`, `failover_cluster`, `replica_role` | | **sqlserver.ao.log\_send\_queue\_size**(gauge) | Amount of log records of the primary database that has not been sent to the secondary databases. Tags: `availability_group`, `availability_group_name`, `replica_server_name`, `failover_mode`, `availability_mode`, `db`, `replica_id`, `database_id`, `database_state`, `synchronization_state`, `failover_cluster`, `replica_role`*Shown as byte* | | **sqlserver.ao.log\_send\_rate**(gauge) | Average rate at which primary replica instance sent data during last active period. Tags: `availability_group`, `availability_group_name`, `replica_server_name`, `failover_mode`, `availability_mode`, `db`, `replica_id`, `database_id`, `database_state`, `synchronization_state`, `failover_cluster`, `replica_role`*Shown as byte* | | **sqlserver.ao.low\_water\_mark\_for\_ghosts**(gauge) | A monotonically increasing number for the database indicating a low water mark used by ghost cleanup on the primary database. Tags: `availability_group`, `availability_group_name`, `replica_server_name`, `failover_mode`, `availability_mode`, `db`, `replica_id`, `database_id`, `database_state`, `synchronization_state`, `failover_cluster`, `replica_role` | | **sqlserver.ao.member.number\_of\_quorum\_votes**(gauge) | Number of quorum votes possessed by this quorum member. Tags: `member_name`, `member_type`, `member_state`, `failover_cluster` | | **sqlserver.ao.member.state**(gauge) | The state of a member that's a part of the WSFC quorum. Tags: `member_name`, `member_type`, `member_state`, `failover_cluster` | | **sqlserver.ao.member.type**(gauge) | The type of member that's a part of the WSFC quorum. Tags: `member_name`, `member_type`, `member_state`, `failover_cluster` | | **sqlserver.ao.primary\_replica\_health**(gauge) | Recovery health of primary replica: 0 = In progress, 1 = Online. The metric is not emitted if on a secondary replica. Tags: `availability_group`, `availability_group_name`, `synchronization_health_desc` | | **sqlserver.ao.quorum\_state**(gauge) | State of the WSFC quorum. Tags: `quorum_type`, `quorum_state`, `failover_cluster` | | **sqlserver.ao.quorum\_type**(gauge) | Type of quorum used by the WSFC cluster. Tags: `quorum_type`, `quorum_state`, `failover_cluster` | | **sqlserver.ao.redo\_queue\_size**(gauge) | Amount of log records in the log files of the secondary replica that has not yet been redone. Tags: `availability_group`, `availability_group_name`, `replica_server_name`, `failover_mode`, `availability_mode`, `db`, `replica_id`, `database_id`, `database_state`, `synchronization_state`, `failover_cluster`, `replica_role`*Shown as byte* | | **sqlserver.ao.redo\_rate**(gauge) | Average rate at which the log records are being redone on a given secondary database. Tags: `availability_group`, `availability_group_name`, `replica_server_name`, `failover_mode`, `availability_mode`, `db`, `replica_id`, `database_id`, `database_state`, `synchronization_state`, `failover_cluster`, `replica_role`*Shown as byte* | | **sqlserver.ao.replica\_failover\_mode**(gauge) | Replica failover mode: 0 = Automatic failover, 1 = Manual failover. Tags: `replica_server_name`, `availability_group`, `availability_group_name`, `failover_mode_desc` | | **sqlserver.ao.replica\_failover\_readiness**(gauge) | Replica failover readiness: 0 = Not ready for failover, 1 = Ready for failover. Tags: `replica_server_name`, `availability_group`, `availability_group_name`, `failover_mode_desc` | | **sqlserver.ao.replica\_status**(gauge) | Denotes an Availability Group replica's status. Tags: `availability_group`, `availability_group_name`, `replica_server_name`, `failover_mode`, `availability_mode`, `db`, `replica_id`, `database_id`, `database_state`, `synchronization_state`, `failover_cluster`, `replica_role` | | **sqlserver.ao.replica\_sync\_state**(gauge) | Replica synchronization health: 0 = Not healthy, 1 = Partially healthy, 2 = Healthy. Tags: `availability_group`, `availability_group_name`, `replica_server_name`, `synchronization_state_desc` | | **sqlserver.ao.secondary\_lag\_seconds**(gauge) | The number of seconds that the secondary replica is behind the primary replica during synchronization. Tags: `availability_group`, `availability_group_name`, `replica_server_name`, `failover_mode`, `availability_mode`, `db`, `replica_id`, `database_id`, `database_state`, `synchronization_state`, `failover_cluster`, `replica_role`*Shown as second* | | **sqlserver.ao.secondary\_replica\_health**(gauge) | Recovery health of secondary replica: 0 = In progress, 1 = Online. The metric is not emitted if on a primary replica. Tags: `availability_group`, `availability_group_name`, `synchronization_health_desc` | | **sqlserver.buffer.cache\_hit\_ratio**(gauge) | The ratio of data pages found and read from the buffer cache over all data page requests. (Perf. Counter: `Buffer Manager - Buffer cache hit ratio`)*Shown as fraction* | | **sqlserver.buffer.checkpoint\_pages**(gauge) | The number of pages flushed to disk per second by a checkpoint or other operation that require all dirty pages to be flushed. (Perf. Counter: `Buffer Manager - Checkpoint pages/sec`)*Shown as page* | | **sqlserver.buffer.page\_life\_expectancy**(gauge) | Duration that a page resides in the buffer pool. (Perf. Counter: `Buffer Manager - Page life expectancy`)*Shown as second* | | **sqlserver.buffer.page\_reads**(gauge) | Indicates the number of physical database page reads that are issued per second. This statistic displays the total number of physical page reads across all databases. (Perf. Counter: `Buffer Manager - Page reads/sec`)*Shown as page* | | **sqlserver.buffer.page\_writes**(gauge) | Indicates the number of physical database page writes that are issued per second. (Perf. Counter: `Buffer Manager - Page writes/sec`)*Shown as page* | | **sqlserver.cache.object\_counts**(gauge) | Number of cache objects in the cache. (Perf. Counter: `Plan Cache - Cache Object Counts`)*Shown as object* | | **sqlserver.cache.pages**(gauge) | Number of 8-kilobyte (KB) pages used by cache objects. (Perf. Counter: `Plan Cache - Cache Pages`)*Shown as object* | | **sqlserver.database.active\_transactions**(gauge) | Number of active transactions across all databases on the SQL Server instance. Tags: `db`. (Perf. Counter: `Databases - Active Transactions`).*Shown as transaction* | | **sqlserver.database.avg\_fragment\_size\_in\_pages**(gauge) | The average number of pages in one fragment on the leaf level of an IN_ROW_DATA allocation unit. Tags: `db`, `object_name`, `schema`, `index_id`, `index_name` | | **sqlserver.database.avg\_fragmentation\_in\_percent**(gauge) | Logical fragmentation for indexes, or extent fragmentation for heaps in the IN_ROW_DATA allocation unit. Tags: `db`, `object_name`, `schema`, `index_id`, `index_name` | | **sqlserver.database.backup\_count**(gauge) | The total count of successful backups made for a database. **Note:** This metric is not emitted on Azure managed databases. Tags: `db` | | **sqlserver.database.backup\_restore\_throughput**(gauge) | Read/write throughput for backup and restore operations of a database per second. Tags: `db`. (Perf. Counter: `Databases - Backup/Restore Throughput/sec`) | | **sqlserver.database.files.size**(gauge) | Current size of the database file. Tags: `db`, `file_id`, `file_type`, `file_name`, `file_location`, `database_files_state_desc`*Shown as kibibyte* | | **sqlserver.database.files.space\_used**(gauge) | Current used space of the database file. Tags: `db`, `file_id`, `file_type`, `file_name`, `file_location`, `database_files_state_desc`*Shown as kibibyte* | | **sqlserver.database.files.state**(gauge) | Database file state: 0 = Online, 1 = Restoring, 2 = Recovering, 3 = Recovery_Pending, 4 = Suspect, 5 = Unknown, 6 = Offline, 7 = Defunct. Tags: `db`, `file_id`, `file_type`, `file_name`, `file_location`, `database_files_state_desc` | | **sqlserver.database.fragment\_count**(gauge) | The number of fragments in the leaf level of an IN_ROW_DATA allocation unit. Tags: `db`, `object_name`, `schema`, `index_id`, `index_name` | | **sqlserver.database.index\_page\_count**(gauge) | Total number of index or data pages. Tags: `db`, `object_name`, `schema`, `index_id`, `index_name` | | **sqlserver.database.is\_in\_standby**(gauge) | Whether or not the database is read-only for restore log. Tags: `db`, `database_state_desc`, `database_recovery_model_desc` | | **sqlserver.database.is\_read\_only**(gauge) | Whether or not the database is marked as READ_ONLY. 0 = READ_WRITE, 1 = READ_ONLY. Tags: `db`, `database_state_desc`, `database_recovery_model_desc` | | **sqlserver.database.is\_sync\_with\_backup**(gauge) | Whether or not the database is marked for replication synchronization with backup. 0 = Not marked for replication sync, 1 = Marked for replication sync. Tags: `db`, `database_state_desc`, `database_recovery_model_desc` | | **sqlserver.database.log\_bytes\_flushed**(gauge) | Total number of log bytes flushed. Tags: `db`. (Perf. Counter: `Databases - Log Bytes Flushed/sec`)*Shown as byte* | | **sqlserver.database.log\_flush\_wait**(gauge) | Total wait time (in milliseconds) to flush the log. On an Always On secondary database, this value indicates the wait time for log records to be hardened to disk. Tags: `db`. (Perf. Counter: `Databases - Log Flush Wait Time`)*Shown as millisecond* | | **sqlserver.database.log\_flushes**(gauge) | Number of log flushes per second. Tags: `db`. (Perf. Counter: `Databases - Log Flushes/sec`)*Shown as flush* | | **sqlserver.database.master\_files.size**(gauge) | Current size of the database file. For a database snapshot, size reflects the maximum space that the snapshot can ever use for the file. **Note**: Use `sqlserver.database.files.size` for the actual size of FILESTREAM containers. Tags: `db`, `file_id`, `file_type`, `file_location`, `database_files_state_desc`*Shown as kibibyte* | | **sqlserver.database.master\_files.state**(gauge) | Database file state: 0 = Online, 1 = Restoring, 2 = Recovering, 3 = Recovery_Pending, 4 = Suspect, 5 = Unknown, 6 = Offline, 7 = Defunct. Tags: `db`, `file_id`, `file_type`, `file_location`, `database_files_state_desc` | | **sqlserver.database.replica.transaction\_delay**(gauge) | Total delay in waiting for unterminated commit acknowledgment for all the current transactions, in milliseconds. Tags: `db`. (Perf. Counter: `Database Replica - Transaction Delay`)*Shown as millisecond* | | **sqlserver.database.state**(gauge) | Database state: 0 = Online, 1 = Restoring, 2 = Recovering, 3 = Recovery_Pending, 4 = Suspect, 5 = Emergency, 6 = Offline, 7 = Copying, 10 = Offline_Secondary. Tags: `db`, `database_state_desc`, `database_recovery_model_desc` | | **sqlserver.database.transactions**(gauge) | Number of transactions started for the SQL Server instance per second. Tags: `db`. (Perf. Counter: `Databases - Transactions/sec`)*Shown as transaction* | | **sqlserver.database.user\_access**(gauge) | Database user access: 0 = Multi_user, 1 = Single_user, 2 = Restricted_user. Tags: `db`, `database_state_desc`, `database_recovery_model_desc` | | **sqlserver.database.write\_transactions**(gauge) | Number of transactions that wrote to all databases on the SQL Server instance and committed, in the last second. Tags: `db`. (Perf. Counter: `Databases - Write Transactions/sec`)*Shown as transaction* | | **sqlserver.fci.is\_current\_owner**(gauge) | Whether or not this node is the current owner of the SQL Server FCI. Tags: `node_name`, `status`, `failover_cluster` | | **sqlserver.fci.status**(gauge) | Status of the node in a SQL Server failover cluster instance. Tags: `node_name`, `status`, `failover_cluster` | | **sqlserver.files.io\_stall**(count) | Total time that users waited for I/O to complete on the file. Tags: `logical_name`, `file_location`, `db`, `state`*Shown as millisecond* | | **sqlserver.files.read\_bytes**(count) | Bytes read from the file. Tags: `logical_name`, `file_location`, `db`, `state`*Shown as byte* | | **sqlserver.files.read\_io\_stall**(count) | Total time that users waited for reads on the file. Tags: `logical_name`, `file_location`, `db`, `state`*Shown as millisecond* | | **sqlserver.files.read\_io\_stall\_queued**(count) | Total latency from IO governance pools for reads on the file. Tags: `logical_name`, `file_location`, `db`, `state`*Shown as millisecond* | | **sqlserver.files.reads**(count) | Number of reads issued on the file. Tags: `logical_name`, `file_location`, `db`, `state`*Shown as read* | | **sqlserver.files.size\_on\_disk**(gauge) | Number of bytes used on the disk for this file. Tags: `logical_name`, `file_location`, `db`, `state`*Shown as byte* | | **sqlserver.files.write\_io\_stall**(count) | Total time that users waited for writes on the file. Tags: `logical_name`, `file_location`, `db`, `state`*Shown as millisecond* | | **sqlserver.files.write\_io\_stall\_queued**(count) | Total latency from IO governance pools for writes on the file. Tags: `logical_name`, `file_location`, `db`, `state`*Shown as millisecond* | | **sqlserver.files.writes**(count) | Number of writes issued on the file. Tags: `logical_name`, `file_location`, `db`, `state`*Shown as write* | | **sqlserver.files.written\_bytes**(count) | Bytes written to the file. Tags: `logical_name`, `file_location`, `db`, `state`*Shown as byte* | | **sqlserver.index.user\_lookups**(count) | Number of bookmark lookups by user queries. Tags: `db`, `table`, `index_name`, `schema`*Shown as occurrence* | | **sqlserver.index.user\_scans**(count) | Number of scans by user queries that did not use 'seek' predicate. Tags: `db`, `table`, `index_name`, `schema`*Shown as scan* | | **sqlserver.index.user\_seeks**(count) | Number of seeks by user queries. Tags: `db`, `table`, `index_name`, `schema`*Shown as occurrence* | | **sqlserver.index.user\_updates**(count) | Number of updates by user queries. This includes Insert, Delete, and Updates representing the number of operations done, not the actual rows affected. Tags: `db`, `table`, `index_name`, `schema`*Shown as update* | | **sqlserver.latches.latch\_wait\_time**(gauge) | Average latch wait time (in milliseconds) for latch requests that had to wait. (Perf. Counter: `Locks - Average Latch Wait Time (ms)`)*Shown as millisecond* | | **sqlserver.latches.latch\_waits**(gauge) | Number of latch requests that could not be granted immediately. (Perf. Counter: `Locks - Latch Waits/sec`)*Shown as request* | | **sqlserver.locks.deadlocks**(gauge) | Number of lock requests per second that resulted in a deadlock. (Perf. Counter: `Locks - Number of Deadlocks/sec`)*Shown as request* | | **sqlserver.log\_shipping\_primary.backup\_threshold**(gauge) | Seconds allowed to elapse between backup operations before a SQL Server job alert is generated. (Tags: `primary_db`, `primary_server`, `primary_id`)*Shown as second* | | **sqlserver.log\_shipping\_primary.time\_since\_backup**(gauge) | Seconds since the last transaction log backup operation on the primary server. (Tags: `primary_db`, `primary_server`, `primary_id`)*Shown as second* | | **sqlserver.log\_shipping\_secondary.last\_restored\_latency**(gauge) | The amount of time, in seconds, that elapsed between when the log backup was created on the primary and when it was restored on the secondary. (Tags: `primary_db`, `primary_server`, `secondary_db`, `secondary_server`, `secondary_id`)*Shown as second* | | **sqlserver.log\_shipping\_secondary.restore\_threshold**(gauge) | Seconds allowed to elapse between restore operations before a SQL Server job alert is generated. (Tags: `primary_db`, `primary_server`, `secondary_db`, `secondary_server`, `secondary_id`)*Shown as second* | | **sqlserver.log\_shipping\_secondary.time\_since\_copy**(gauge) | Seconds since last copy operation to the secondary server. (Tags: `primary_db`, `primary_server`, `secondary_db`, `secondary_server`, `secondary_id`)*Shown as second* | | **sqlserver.log\_shipping\_secondary.time\_since\_restore**(gauge) | Seconds since the last restore operation on the secondary server. (Tags: `primary_db`, `primary_server`, `secondary_db`, `secondary_server`, `secondary_id`)*Shown as second* | | **sqlserver.memory.connection**(gauge) | Specifies the total amount of dynamic memory the server is using for maintaining connections. (Perf. Counter: `Memory Manager - Connection Memory (KB)`)*Shown as kibibyte* | | **sqlserver.memory.database\_cache**(gauge) | Specifies the amount of memory the server is currently using for the database pages cache. (Perf. Counter: `Memory Manager - Database Cache Memory (KB)`)*Shown as kibibyte* | | **sqlserver.memory.granted\_workspace**(gauge) | Specifies the total amount of memory currently granted to executing processes, such as hash, sort, bulk copy, and index creation operations. (Perf. Counter: `Memory Manager - Granted Workspace Memory (KB)`)*Shown as kibibyte* | | **sqlserver.memory.grants\_outstanding**(gauge) | Specifies the total number of processes that have successfully acquired a workspace memory grant. (Perf. Counter: `Memory Manager - Memory Grants Outstanding`) | | **sqlserver.memory.lock**(gauge) | Specifies the total amount of dynamic memory the server is using for locks. (Perf. Counter: `Memory Manager - Lock Memory (KB)`)*Shown as kibibyte* | | **sqlserver.memory.log\_pool\_memory**(gauge) | Total amount of dynamic memory the server is using for Log Pool. (Perf. Counter: `Memory Manager - Log Pool Memory (KB)`)*Shown as kibibyte* | | **sqlserver.memory.memory\_grants\_pending**(gauge) | Specifies the total number of processes waiting for a workspace memory grant (Perf. Counter: `Memory Manager - Memory Grants Pending`) | | **sqlserver.memory.optimizer**(gauge) | Specifies the total amount of dynamic memory the server is using for query optimization. (Perf. Counter: `Memory Manager - Optimizer Memory (KB)`)*Shown as kibibyte* | | **sqlserver.memory.sql\_cache**(gauge) | Specifies the total amount of dynamic memory the server is using for the dynamic SQL cache. (Perf. Counter: `Memory Manager - SQL Cache Memory (KB)`)*Shown as kibibyte* | | **sqlserver.memory.stolen**(gauge) | Specifies the amount of memory the server is using for purposes other than database pages. (Perf. Counter: `Memory Manager - Stolen Server Memory (KB)`)*Shown as kibibyte* | | **sqlserver.memory.total\_server\_memory**(gauge) | Specifies the amount of memory the server has committed using the memory manager. (Perf. Counter: `Memory Manager - Total Server Memory (KB)`)*Shown as kibibyte* | | **sqlserver.procedures.count**(count) | Total count of executed stored procedures per procedure (DBM only). Tags: `db`, `procedure_name`.*Shown as query* | | **sqlserver.procedures.logical\_reads**(count) | Total number of logical reads performed by executed stored procedures per procedure (DBM only). Tags: `db`, `procedure_name`.*Shown as read* | | **sqlserver.procedures.logical\_writes**(count) | Total number of logical writes performed by executed stored procedures per procedure (DBM only). Tags: `db`, `procedure_name`.*Shown as write* | | **sqlserver.procedures.physical\_reads**(count) | Total number of physical reads performed by executed stored procedures per procedure (DBM only). Tags: `db`, `procedure_name`.*Shown as read* | | **sqlserver.procedures.spills**(count) | The total number of pages spilled by execution of this stored procedure per procedure (DBM only). Tags: `db`, `procedure_name`. | | **sqlserver.procedures.time**(count) | Total elapsed time for executed stored procedures per procedure (DBM only)*Shown as nanosecond* | | **sqlserver.procedures.worker\_time**(count) | Total CPU time consumed by executed stored procedures per procedure (DBM only). Tags: `db`, `procedure_name`.*Shown as nanosecond* | | **sqlserver.queries.clr\_time**(count) | Total time consumed inside Microsoft .NET Framework common language runtime (CLR) objects for executed queries per query (DBM only)*Shown as nanosecond* | | **sqlserver.queries.columnstore\_segment\_reads**(count) | Total columnstore segments read by executed queries per query (DBM only)*Shown as segment* | | **sqlserver.queries.columnstore\_segment\_skips**(count) | Total columnstore segments skipped by executed queries per query (DBM only)*Shown as segment* | | **sqlserver.queries.count**(count) | Total count of executed queries per query (DBM only)*Shown as query* | | **sqlserver.queries.dop**(count) | The total sum of degree of parallelism used by executions of this query per query (DBM only) | | **sqlserver.queries.duration.max**(gauge) | The age of the longest running query per user, db, and app. (DBM only)*Shown as nanosecond* | | **sqlserver.queries.duration.sum**(gauge) | The sum of the age of all running queries per user, db, and app. (DBM only)*Shown as nanosecond* | | **sqlserver.queries.ideal\_memory\_grant**(count) | The total amount of ideal memory grant estimated by executions of this query per query (DBM only)*Shown as kilobyte* | | **sqlserver.queries.logical\_reads**(count) | Total number of logical reads performed by executed queries per query (DBM only)*Shown as read* | | **sqlserver.queries.logical\_writes**(count) | Total number of logical writes performed by executed queries per query (DBM only)*Shown as write* | | **sqlserver.queries.memory\_grant**(count) | The total amount of reserved memory received by executions of this query per query. It will always be 0 for querying a memory-optimized table (DBM only).*Shown as kilobyte* | | **sqlserver.queries.physical\_reads**(count) | Total number of physical reads performed by executed queries per query (DBM only)*Shown as read* | | **sqlserver.queries.reserved\_threads**(count) | The total sum of reserved parallel threads used by executions of this query per query (DBM only)*Shown as thread* | | **sqlserver.queries.rows**(count) | Total number of rows returned by executed queries per query (DBM only)*Shown as row* | | **sqlserver.queries.spills**(count) | The total number of pages spilled by execution of this query per query (DBM only) | | **sqlserver.queries.time**(count) | Total elapsed time for executed queries per query (DBM only)*Shown as nanosecond* | | **sqlserver.queries.used\_memory\_grant**(count) | The total amount of reserved memory used by executions of this query per query. It will always be 0 for querying a memory-optimized table (DBM only).*Shown as kilobyte* | | **sqlserver.queries.used\_threads**(count) | The total sum of used parallel threads used by executions of this query per query (DBM only)*Shown as thread* | | **sqlserver.queries.worker\_time**(count) | Total CPU time consumed by executed queries per query (DBM only)*Shown as nanosecond* | | **sqlserver.replica.flow\_control\_sec**(gauge) | Number of times flow-control initiated in the last second. Flow Control Time (ms/sec) divided by Flow Control/sec is the average time per wait. (Perf. Counter: `Database Replica - Flow Control/sec`) | | **sqlserver.replica.transaction\_delay**(gauge) | Total delay in waiting for unterminated commit acknowledgment for all the current transactions, in milliseconds. (Perf. Counter: `Database Replica - Transaction Delay`)*Shown as millisecond* | | **sqlserver.scheduler.active\_workers\_count**(gauge) | Number of workers that are active. An active worker is never preemptive, must have an associated task, and is either running, runnable, or suspended. Tags: 'scheduler_id', `parent_node_id`*Shown as worker* | | **sqlserver.scheduler.current\_tasks\_count**(gauge) | Number of current tasks that are associated with this scheduler. Tags: 'scheduler_id', `parent_node_id`*Shown as task* | | **sqlserver.scheduler.current\_workers\_count**(gauge) | Number of workers that are associated with this scheduler. Tags: 'scheduler_id', `parent_node_id`*Shown as worker* | | **sqlserver.scheduler.runnable\_tasks\_count**(gauge) | Number of workers, with tasks assigned to them, that are waiting to be scheduled on the runnable queue. Tags: 'scheduler_id', `parent_node_id`*Shown as task* | | **sqlserver.scheduler.work\_queue\_count**(gauge) | Number of tasks in the pending queue. These tasks are waiting for a worker to pick them up. Tags: 'scheduler_id', `parent_node_id`*Shown as unit* | | **sqlserver.server.committed\_memory**(gauge) | The amount of memory committed to the memory manager*Shown as byte* | | **sqlserver.server.cpu\_count**(gauge) | The number of logical CPUs or vCPUs on the server.*Shown as byte* | | **sqlserver.server.physical\_memory**(gauge) | Total physical memory on the machine*Shown as byte* | | **sqlserver.server.target\_memory**(gauge) | Amount of memory that can be consumed by the memory manager. When this value is larger than the committed memory, then the memory manager will try to obtain more memory. When it is smaller, the memory manager will try to shrink the amount of memory committed.*Shown as byte* | | **sqlserver.server.uptime**(gauge) | Total time elapsed since the last computer restart.*Shown as second* | | **sqlserver.server.virtual\_memory**(gauge) | Amount of virtual memory available to the process in user mode.*Shown as byte* | | **sqlserver.stats.auto\_param\_attempts**(gauge) | Number of auto-parameterization attempts per second. (Perf. Counter: `SQL Statistics - Auto-Param Attempts/sec`)*Shown as attempt* | | **sqlserver.stats.batch\_requests**(gauge) | The number of batch requests per second. (Perf. Counter: `Buffer Manager - Batch Requests/sec`)*Shown as request* | | **sqlserver.stats.connections**(gauge) | The number of user connections. If DBM is enabled, this metric is tagged with status, db, and user.*Shown as connection* | | **sqlserver.stats.failed\_auto\_param\_attempts**(gauge) | Number of failed auto-parameterization attempts per second. (Perf. Counter: `SQL Statistics - Failed Auto-Params/sec`)*Shown as attempt* | | **sqlserver.stats.lock\_waits**(gauge) | The number of times per second that SQL Server is unable to retain a lock right away for a resource. (Perf. Counter: `Locks - Lock Waits/sec`)*Shown as lock* | | **sqlserver.stats.procs\_blocked**(gauge) | The number of processes blocked. (Perf. Counter: `General Statistics - Processes blocked`)*Shown as process* | | **sqlserver.stats.safe\_auto\_param\_attempts**(gauge) | Number of safe auto-parameterization attempts per second. (Perf. Counter: `SQL Statistics - Safe Auto-Params/sec`)*Shown as attempt* | | **sqlserver.stats.sql\_compilations**(gauge) | The number of SQL compilations per second. (Perf. Counter: `SQL Statistics - SQL Compilations/sec`)*Shown as operation* | | **sqlserver.stats.sql\_recompilations**(gauge) | The number of SQL re-compilations per second. (Perf. Counter: `SQL Statistics - SQL Re-Compilations/sec`)*Shown as operation* | | **sqlserver.table.data\_size**(gauge) | The size in kibibytes of data stored in this table excluding internal index pages and allocation-management pages. Tags: `database` `schema` `table`*Shown as kibibyte* | | **sqlserver.table.row\_count**(gauge) | The number of rows in this table. Tags: `database` `schema` `table`*Shown as row* | | **sqlserver.table.total\_size**(gauge) | The total size of the table in kibibytes. Tags: `database` `schema` `table`*Shown as kibibyte* | | **sqlserver.table.used\_size**(gauge) | The size in kibibytes of data stored in this table including internal index pages and allocation-management pages. Tags: `database` `schema` `table`*Shown as kibibyte* | | **sqlserver.task.context\_switches\_count**(gauge) | Number of scheduler context switches that this task has completed. Tags: 'scheduler_id'*Shown as unit* | | **sqlserver.task.pending\_io\_byte\_average**(gauge) | Average byte count of I/Os that are performed by this task. Tags: 'scheduler_id'*Shown as byte* | | **sqlserver.task.pending\_io\_byte\_count**(gauge) | Total byte count of I/Os that are performed by this task. Tags: 'scheduler_id'*Shown as byte* | | **sqlserver.task.pending\_io\_count**(gauge) | Number of physical I/Os that are performed by this task. Tags: 'scheduler_id'*Shown as unit* | | **sqlserver.tempdb.file\_space\_usage.free\_space**(gauge) | The amount of free space in the tempdb database file. **Note:** This metric is not emitted on Azure managed databases. Tags: `db`*Shown as mebibyte* | | **sqlserver.tempdb.file\_space\_usage.internal\_object\_space**(gauge) | The amount of space used by internal objects in the tempdb database file. **Note:** This metric is not emitted on Azure managed databases. Tags: `db`*Shown as mebibyte* | | **sqlserver.tempdb.file\_space\_usage.mixed\_extent\_space**(gauge) | The amount of space used by mixed extents in the tempdb database file. **Note:** This metric is not emitted on Azure managed databases. Tags: `db`*Shown as mebibyte* | | **sqlserver.tempdb.file\_space\_usage.user\_object\_space**(gauge) | The amount of space used by user objects in the tempdb database file. **Note:** This metric is not emitted on Azure managed databases. Tags: `db`*Shown as mebibyte* | | **sqlserver.tempdb.file\_space\_usage.version\_store\_space**(gauge) | The amount of space used by the version store in the tempdb database file. **Note:** This metric is not emitted on Azure managed databases.*Shown as mebibyte* | | **sqlserver.transactions.longest\_transaction\_running\_time**(gauge) | The time (in seconds) that the oldest active transaction has been running. Only works if database is under read committed snapshot isolation level. (Perf. Counter: `Transactions - Longest Transaction Running Time`)*Shown as second* | | **sqlserver.transactions.version\_cleanup\_rate**(gauge) | The cleanup rate of the version store in tempdb. (Perf. Counter: `Transactions - Version Cleanup rate (KB/s)`)*Shown as kibibyte* | | **sqlserver.transactions.version\_generation\_rate**(gauge) | The generation rate of the version store in tempdb. (Perf. Counter: `Transactions - Version Generation rate (KB/s)`)*Shown as kibibyte* | | **sqlserver.transactions.version\_store\_size**(gauge) | The size of the version store in tempdb. (Perf. Counter: `Transactions - Version Store Size (KB)`)*Shown as kibibyte* | | **sqlserver.xe.events\_not\_in\_xml**(gauge) | Number of generated events that are missing in the XML representation of the ring buffer. Tags: `session_name`*Shown as event* | | **sqlserver.xe.session\_status**(gauge) | Status of the node in a SQL Server failover cluster instance. Tags: `session_name` | Most of these metrics come from your SQL Server's `sys.dm_os_performance_counters` table. ### Events{% #events %} The SQL server check does not include any events. ### Service Checks{% #service-checks %} **sqlserver.can\_connect** Returns `CRITICAL` if the Agent is unable to connect to the monitored SQL Server instance. Returns `OK` otherwise. *Statuses: ok, critical* **sqlserver.database.can\_connect** Returns `CRITICAL` if the Agent is unable to connect to the autodiscovered SQL Server Database. Returns `OK` otherwise. *Statuses: ok, critical* ## Troubleshooting{% #troubleshooting %} Need help? Contact [Datadog support](https://docs.datadoghq.com/help/). If you are running the Agent on an ARM aarch64 processor, there is a known issue starting in version 14.0.0 of this check, which is bundled with Agent version 7.48.0. A Python dependency fails to load, and you'll see the following message when running [the Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands.md#agent-status-and-information): ``` Loading Errors ============== sqlserver --------- Core Check Loader: Check sqlserver not found in Catalog JMX Check Loader: check is not a jmx check, or unable to determine if it's so Python Check Loader: unable to import module 'sqlserver': No module named 'sqlserver' ``` This is fixed in version 15.2.0 of the check and in Agent versions 7.49.1 and above. ## Further Reading{% #further-reading %} - [Monitor your Azure SQL Databases with Datadog](https://www.datadoghq.com/blog/monitor-azure-sql-databases-datadog) - [Key metrics for SQL Server monitoring](https://www.datadoghq.com/blog/sql-server-monitoring) - [SQL Server monitoring tools](https://www.datadoghq.com/blog/sql-server-monitoring-tools) - [Monitor SQL Server performance with Datadog](https://www.datadoghq.com/blog/sql-server-performance) - [Custom SQL Server metrics for detailed monitoring](https://www.datadoghq.com/blog/sql-server-metrics) - [Strategize your Azure migration for SQL workloads with Datadog](https://www.datadoghq.com/blog/migrate-sql-workloads-to-azure-with-datadog/)