Documentation Grafana documentation Data sources Microsoft SQL Server Configure

Configure the Microsoft SQL Server data source

This document provides instructions for configuring the Microsoft SQL Server data source and explains available configuration options. For general information on adding and managing data sources, refer to Grafana data sources and Data source management.

Before you begin

Before configuring the Microsoft SQL Server data source, ensure you have the following:

• Grafana permissions: You must have the Organization administrator role to add and configure data sources. Users with the Editor or Viewer role cannot access the data source configuration form unless granted additional permissions through RBAC. Organization administrators can also configure the data source via YAML with the Grafana provisioning system.

• A running SQL Server instance: Microsoft SQL Server 2012 or newer, Azure SQL Database, or Azure SQL Managed Instance.

• Network access: Grafana must be able to reach your SQL Server. The default port is 1433.

• Authentication credentials: Depending on your authentication method, you need one of:

  • SQL Server login credentials (username and password).
  • Windows/Kerberos credentials and configuration (not supported in Grafana Cloud).
  • Azure Entra ID app registration or managed identity.

• Security certificates: If using encrypted connections, gather any necessary TLS/SSL certificates.

Add the MSSQL data source

To add the MSSQL data source, complete the following steps:

1. Click Connections in the left-side menu.
2. Click Add new connection
3. Type Microsoft SQL Server in the search bar.
4. Select Microsoft SQL Server under data source.
5. Click Add new data source in the upper right.

Grafana takes you to the Settings tab, where you will set up your Microsoft SQL Server configuration.

Configure the data source in the UI

Following are configuration options for the Microsoft SQL Server data source.

Connection:

TLS/SSL encryption:

The Encrypt setting determines whether and to what extent a secure TLS/SSL connection is negotiated with the server.

When Encrypt is set to True, the following additional TLS options are available:

Choosing the right encryption configuration:

Authentication:

Additional settings:

Additional settings are optional settings you configure for more control over your data source. This includes connection limits, connection timeout, group-by time interval, and Secure Socks Proxy.

Connection limits:

Grafana maintains a connection pool for each configured MSSQL data source. These settings control pool behavior and directly affect performance, especially under concurrent load from dashboards and alerting.

Connection details:

Windows AD Advanced settings:

Kerberos SPN requirements:

For Kerberos authentication to succeed, a Service Principal Name (SPN) must be registered for the SQL Server instance that matches the hostname Grafana uses to connect. This is especially important when connecting through Availability Group Listeners or DNS aliases.

Register SPNs using the setspn command on the SQL Server host:

text Copy

setspn -S MSSQLSvc/<SQL_SERVER_FQDN>:1433 <DOMAIN>\<SERVICE_ACCOUNT>
setspn -S MSSQLSvc/<SQL_SERVER_FQDN> <DOMAIN>\<SERVICE_ACCOUNT>

If Grafana connects through a Listener or alias, register an additional SPN for that name. Verify registered SPNs with setspn -L <DOMAIN>\<SERVICE_ACCOUNT>.

Connect to on-premises SQL Server from Grafana Cloud

If your SQL Server instance is in a private network (on-premises, VPN, or VPC), Grafana Cloud cannot reach it directly over the internet. You must use Private data source connect (PDC) to establish a secure tunnel between your Grafana Cloud stack and your private network.

Network prerequisites:

• Port 22 (SSH): The PDC agent on your network must be able to reach the Grafana Cloud PDC endpoint over port 22 for the SSH tunnel.
• Port 1433 (SQL Server): The PDC agent must be able to reach your SQL Server instance on port 1433 (or your custom SQL Server port).
• DNS resolution: The PDC agent must be able to resolve the SQL Server hostname from within your private network.

Set up PDC for Microsoft SQL Server:

1. In your Grafana Cloud stack, navigate to Connections > Private data source connect.
2. Create a new PDC connection or use an existing one.
3. Install and configure the PDC agent on a host within your private network that has access to the SQL Server instance. For detailed instructions, refer to Configure Grafana private data source connect (PDC).
4. Return to the Microsoft SQL Server data source configuration.
5. Under Private data source connect, select your PDC connection from the drop-down.
6. Enter the SQL Server hostname as it’s resolvable from within your private network (not a public DNS name).
7. Click Save & test to verify connectivity.

Click Manage private data source connect to open your PDC connection page and view your configuration details.

For more information about PDC, refer to Private data source connect (PDC).

After configuring your MSSQL data source options, click Save & test at the bottom to test the connection. You should see a confirmation dialog box that says:

Database Connection OK

Azure Entra ID (formerly Azure AD) Authentication

The following Azure authentication methods are supported:

• App Registration (service principal)
• Managed Identity
• Current User authentication
• Azure Entra Password

The Azure SQL Server that you are connecting to must support Azure Entra authentication. For configuration details, refer to the Azure SQL documentation.

Required server configuration

Before you can use any Azure Entra ID authentication method, you must enable Azure authentication in the Grafana server configuration. Add the following to your grafana.ini or custom.ini file:

ini Copy

[azure]
azure_auth_enabled = true

Depending on the method you choose, additional flags are required (documented in each section below). After changing the .ini file, restart the Grafana server for the changes to take effect.

Current User authentication

This is the recommended authentication mechanism when working with SQL Server instances that are hosted in Azure. It allows users to be authenticated to and query the database using their own credentials rather than long-lived credentials.

This authentication method requires your Grafana instance to be configured with Azure Entra ID (formerly Active Directory) authentication for login. With Azure Entra ID login, this method can be used to forward the currently logged in user’s credentials to the data source. The users credentials will then be used when requesting data from the data source. For details on how to configure your Grafana instance using Azure Entra refer to the documentation.

This method of authentication doesn’t inherently support all backend functionality as a user’s credentials won’t be in scope. Affected functionality includes alerting, reporting, and recorded queries. Also, note that query and resource caching is disabled by default for data sources using current user authentication.

To enable current user authentication for Grafana:

1. Set the user_identity_enabled flag in the [azure] section of the Grafana server configuration.

   ini Copy

   [azure]
   user_identity_enabled = true

2. In the SQL Server data source configuration, set Authentication to Azure AD Authentication and the Azure Authentication type to Current User.

App Registration

Use an app registration (service principal) to authenticate the data source with a client ID and secret. This is the recommended method for automated, non-interactive access to Azure SQL.

Prerequisites:

• An app registration created in Azure Entra. For instructions, refer to the Azure documentation for service principals.
• The tenant ID, client (application) ID, and a client secret from the app registration.

Step 1: Add the app registration as a database user

1. Connect to your Azure SQL database as a user with administrative permissions (the user must have the ability to read your Azure Entra directory, for example, by possessing the Directory Readers role).

2. Run the following SQL to create a user for the app registration:

   SQL Copy

   CREATE USER [<APP_REGISTRATION_NAME>] FROM EXTERNAL PROVIDER;

3. Grant the created user appropriate permissions. Grafana recommends read-only access:

   SQL Copy

   ALTER ROLE db_datareader ADD MEMBER [<APP_REGISTRATION_NAME>];

Step 2: Configure the Grafana server

Ensure azure_auth_enabled is set in your grafana.ini:

ini Copy

[azure]
azure_auth_enabled = true

Step 3: Configure the data source

1. In the SQL Server data source configuration, set Authentication to Azure AD Authentication and the Azure Authentication type to App Registration.
2. Set Azure Cloud to Azure (for the Azure public cloud).
3. Enter the Directory (tenant) ID, Application (client) ID, and Client Secret from your app registration.

Managed Identity

You can use managed identity to configure SQL Server in Grafana if you host Grafana in Azure (such as an App Service or with Azure Virtual Machines) and have managed identity enabled on your VM. This lets you securely authenticate data sources without manually configuring credentials. For details on Azure managed identities, refer to the Azure documentation.

To enable managed identity for Grafana:

1. Set both azure_auth_enabled and managed_identity_enabled in the [azure] section of the Grafana server configuration:

   ini Copy

   [azure]
   azure_auth_enabled = true
   managed_identity_enabled = true

2. In the SQL Server data source configuration, set Authentication to Azure AD Authentication and the Azure Authentication type to Managed Identity.

   This hides the directory ID, application ID, and client secret fields, and the data source uses managed identity to authenticate to SQL Server.

3. Optionally, set managed_identity_client_id in the [azure] section to use a user-assigned managed identity instead of the default system-assigned identity.

Ensure that the managed identity is added to your Azure SQL instance as a user.

Azure Entra Password

You can connect to an Azure SQL database using the username and password of a user that has permissions in the desired database. This also requires an app registration to be configured with access to the database.

To enable Azure Entra password for Grafana:

1. Set the azure_entra_password_credentials_enabled flag in the [azure] section of the Grafana server configuration.

   ini Copy

   [azure]
   azure_entra_password_credentials_enabled = true

2. In the SQL Server data source configuration, set Authentication to Azure AD Authentication and the Azure Authentication type to Azure Entra Password.

3. Set the User ID value to the username of the user in the Azure SQL database.

4. Set the Application Client ID to the client ID of the app registration that has been added to the Azure SQL database

5. Set the Password value to the password of the user in the Azure SQL database.

Min time interval

The Min time interval setting defines a lower limit for the $__interval and [$__interval_ms][add-template-variables-interval_ms] variables.

This value must be formatted as a number followed by a valid time identifier:

Grafana recommends setting this value to match your Microsoft SQL Server write frequency. For example, use 1m if Microsoft SQL Server writes data every minute.

You can also override this setting in a dashboard panel under its data source options.

Database user permissions

When adding a data source, ensure the database user you specify has only SELECT permissions on the relevant database and tables. Grafana does not validate the safety of queries, which means they can include potentially harmful SQL statements, such as USE otherdb; or DROP TABLE user;, which could get executed. To minimize this risk, Grafana strongly recommends creating a dedicated MSSQL user with restricted permissions.

SQL Copy

CREATE USER grafanareader WITH PASSWORD 'password'
GRANT SELECT ON dbo.YourTable3 TO grafanareader

Also, ensure that the user doesn’t have any unwanted privileges from the public role.

Diagnose connection issues

If you use older versions of Microsoft SQL Server, such as 2008 and 2008R2, you might need to disable encryption before you can connect the data source.

Grafana recommends that you use the latest available service pack for optimal compatibility.

Provision the data source

You can define and configure the data source in YAML files as part of the Grafana provisioning system. For more information about provisioning, and for available configuration options, refer to Provision Grafana.

Provisioning example

YAML Copy

apiVersion: 1

datasources:
  - name: MSSQL
    type: mssql
    url: localhost:1433
    user: grafana
    jsonData:
      database: grafana
      maxOpenConns: 100
      maxIdleConns: 100
      maxIdleConnsAuto: true
      connMaxLifetime: 14400
      connectionTimeout: 0
      encrypt: 'false'
    secureJsonData:
      password: 'Password!'

Configure with Terraform

You can configure the Microsoft SQL Server data source using Terraform with the Grafana Terraform provider.

For more information about provisioning resources with Terraform, refer to the Grafana as code using Terraform documentation.

Terraform example

The following example creates a basic Microsoft SQL Server data source:

hcl Copy

resource "grafana_data_source" "mssql" {
  name = "MSSQL"
  type = "mssql"
  url  = "localhost:1433"
  user = "grafana"

  json_data_encoded = jsonencode({
    database           = "grafana"
    maxOpenConns       = 100
    maxIdleConns       = 100
    maxIdleConnsAuto   = true
    connMaxLifetime    = 14400
    connectionTimeout  = 0
    encrypt            = "false"
  })

  secure_json_data_encoded = jsonencode({
    password = "Password!"
  })
}

For all available configuration options, refer to the Grafana provider data source resource documentation.

Next steps

After configuring your Microsoft SQL Server data source, you can:

• Write queries using the query editor to explore and visualize your data
• Create template variables to build dynamic, reusable dashboards
• Add annotations to overlay SQL Server events on your graphs
• Set up alerting to create alert rules based on your SQL Server data
• Troubleshoot issues if you encounter problems with your data source