MSSQL monitoring integration

New Relic Infrastructure's MSSQL integration reports data from your Microsoft (MS) SQL Server environment to New Relic Infrastructure. This document explains how to install and configure the MSSQL integration and describes the data collected.

Access to this feature depends on your subscription level. Requires Infrastructure Pro.

Features

The New Relic MSSQL on-host integration collects and sends inventory and metrics from your MS SQL Server environment to New Relic Infrastructure, where you can see at-a-glance the health of your MS SQL Server environment. Database- and instance-level metrics are collected so that you can more easily find the source of any problems that arise.

Compatibility and requirements

To use the MSSQL integration, ensure your system meets these requirements:

MS SQL users and privileges

In the MS SQL Server that is to be monitored, execute the following script to create a new user and grant CONNECT, VIEW SERVER STATE, and read access permissions to that user. Note: login_name, user_name, tmp_password and similar user-specific values must be replaced. To help prevent login issues, it is recommended that login_name and user_name be the same value.

See the Microsoft documentation for details on creating logins and users in MS SQL Server.

The MSSQL Integration currently only supports SQL Authentication.

  1. Use the following statements to create a new login and new user, and to grant CONNECT and VIEW SERVER STATE permissions to the user.
    USE master;
    CREATE LOGIN login_name WITH PASSWORD = 'tmp_password';
    CREATE USER user_name FOR LOGIN login_name;
    GRANT CONNECT SQL TO user_name;
    GRANT VIEW SERVER STATE TO user_name;
    
  2. Use the following statements to grant read access privileges to the user.
    DECLARE @name NVARCHAR(max)
    DECLARE db_cursor CURSOR FOR
    SELECT NAME
    FROM master.dbo.sysdatabases
    WHERE NAME NOT IN ('master','msdb','tempdb','model')
    OPEN db_cursor
    FETCH NEXT FROM db_cursor INTO @name WHILE @@FETCH_STATUS = 0
    BEGIN
        EXECUTE('USE "' + @name + '"; CREATE USER user_name FOR LOGIN login_name;' );
        FETCH next FROM db_cursor INTO @name
    END
    CLOSE db_cursor
    DEALLOCATE db_cursor
    
  3. Run the following command to verify that the user was successfully created.
    sqlcmd -U user_name -S host_name

Install

On-host integrations do not automatically update. For best results, you should occasionally update the integration and update the Infrastructure agent.

To install the MSSQL integration:

  1. Download the latest .MSI installer image from:

    32-bit Windows
    http://download.newrelic.com/infrastructure_agent/windows/integrations/nri-mssql/386/nri-mssql-386.msi
    
    64-bit Windows
    http://download.newrelic.com/infrastructure_agent/windows/integrations/nri-mssql/nri-mssql-amd64.msi
    
  2. In an admin account, run the install script using an absolute path. To install from the Windows command prompt, run:

    32-bit Windows
    msiexec.exe /qn /i PATH\TO\nri-mssql-amd386.msi
    
    64-bit Windows
    msiexec.exe /qn /i PATH\TO\nri-mssql-amd64.msi
    
  3. Change C:\Program Files\New Relic\newrelic-infra\integrations.d\mssql-config.yml.sample to mssql-config.yml, and edit according to your instance.
  4. Restart the infrastructure agent.

Configure

Use the MSSQL integration's mssql-config.yml configuration file to put required login credentials and configure how data is collected. For an example configuration, see the example config file.

Commands

The mssql-config.yml file provides one command:

  • all_data: collects both inventory and metric data from the MS SQL Server environment.

Arguments

The all_data command accepts the following arguments:

  • username: Username used to authenticate the MS SQL Server. This field is required.

  • password: Password used to authenticate the MS SQL Server. This field is required.

  • hostname: Hostname or IP of the MS SQL Server installation. Default: 127.0.0.1.

  • port: Port number on which the MS SQL Server is listening. This is only required when instance is not specified.

  • instance: Instance the MS SQL Server is connected to. instance can be used in place of port by enabling SQL Browser; if enabled, do not include port in the argument.

  • enable_ssl: Indicates whether SSL is used to connect to the MS SQL Server. Default: false.

  • trust_server_certificate: If set to true, server certificate is not verified for SSL. If set to false, certificate will be verified against supplied certificate.

  • certificate_location: Certificate file to verify SSL encryption against.

  • timeout: Timeout for queries, in seconds. Default: 30.

If both port and instance are omitted, the default port of 1433 will be used.

Example mssql-config.yml file configuration:

Example configuration
integration_name: com.newrelic.mssql

instances:
  - name: mssql-server
    command: all_data
    arguments:
      hostname: mssql.localnet
      username: mssql_user
      password: mssql_password
      port: 1433
    labels:
      env: production
      role: mssql

Find and use data

To find your integration data in Infrastructure, go to infrastructure.newrelic.com > Integrations > On-host integrations and select one of the MSSQL integration links.

In New Relic Insights, MSSQL data is attached to the following Insights event types:

For more on how to find and use your data, see Understand integration data.

Metric data

The MSSQL integration collects the following metric data attributes. Some metric name are prefixed with a category indicator and a period, such as asserts. or flush..

These attributes can be found by querying the MssqlDatabaseSample event types in Insights.

Metric Description

bufferpool.sizePerDatabaseInBytes

The size of the buffer pool per database.

io.stallInMilliseconds

Wait time of stall since last restart, in milliseconds.

log.transactionGrowth

Total number of times the transaction log for the database has been expanded since the last restart.

pageFileAvailable

Available page file size, in bytes.

pageFileTotal

Total page file size, in bytes.

The MSSQL integration collects the following instance metrics. These attributes can be found by querying the MssqlInstanceSample event type in Insights.

Metric Description

access.pageSplitsPerSecond

The number of page splits per second.

activeConnections

The number of active connections.

buffer.cacheHitRatio

The ratio of data pages found and read from the buffer cache over all data page requests.

buffer.checkpointPagesPerSecond

The number of pages flushed to disk per second by a checkpoint or other operation that require all dirty pages to be flushed.

bufferpool.batchRequestsPerSecond

The number of batch requests per second on the buffer pool.

bufferpool.pageLifeExptancyInMilliseconds

The life expectancy of a page in the buffer pool, in milliseconds.

bufferpool.sizeInBytes

The size of the buffer pool, in bytes.

instance.backgroundProcessesCount

The number of background processes on the instance.

instance.blockedProcessesCount

The number of blocked processes on the instance.

instance.diskInBytes

The amount of disk space on the instance, in bytes.

instance.dormantProcessesCount

The number of dormant processes on the instance.

instance.forcedParameterizationsPerSecond

The number of forced parameterizations per second on the instance.

instance.preconnectProcessesCount

The number of preconnect processes on the instance.

instance.runnableProcessesCount

The number of runnable processes on the instance.

instance.runnableTasks

The number of runnable tasks on the instance.

instance.runningProcessesCount

The number of running processes on the instance.

instance.sleepingProcessesCount

The number of sleeping processes on the instance.

instance.suspendedProcessesCount

The number of suspended processes on the instance.

instance.transactionsPerSecond

The number of transactions per second on the instance.

memoryAvailable

The available physical memory, in bytes.

memoryTotal

The total physical memory, in bytes.

memoryUtilization

The percentage of memory utilization.

stats.connections

The number of user connections.

stats.deadlocksPerSecond

The number of lock requests per second that resulted in a deadlock since the last restart.

stats.killConnectionErrorsPerSecond

The number of kill connection errors per second since the last restart.

stats.lockWaitsPerSecond

The number of times per second that MS SQL Server is unable to retain a lock right away for a resource.

stats.sqlCompilations

The number of MS SQL compilations per second.

stats.sqlRecompilationsPerSecond

The number of MS SQL re-compilations per second.

stats.userErrorsPerSecond

The number of user errors per second since the last restart.

system.bufferPoolHit

The percentage of buffer pools hits on the instance.

system.waitTimeInMillisecondsPerSecond

The number of milliseconds per second spent waiting across the instance.

These attributes can be found by querying the MssqlWaitSample event types in Insights.

Metric Description

system.waitTimeCount

Total wait time for this wait type, in milliseconds. This time is inclusive of signal_wait_time_ms.

system.waitTimeInMillisecondsPerSecond

The number of waits on this wait type, in milliseconds. This counter is incremented at the start of each wait.

Inventory data

The MSSQL integration captures the configuration parameters and current settings of the MS SQL Server environment. It collects the results of the sp_configure stored procedure, as well as current running configuration settings from the sys.configurations table.

The data is available on the Infrastructure Inventory page, under the config/mssql source. For more about inventory data, see Understand integration data.

For more help

Recommendations for learning more: