Menu

This is documentation for the next version of Grafana. For the latest stable release, go to the latest version.

Enterprise Open source

Get started with Grafana and MS SQL Server

You can use Grafana Cloud to avoid installing, maintaining, and scaling your own instance of Grafana. Create a free account to get started, which includes free forever access to 10k metrics, 50GB logs, 50GB traces, 500VUh k6 testing & more.

Microsoft SQL Server is a popular relational database management system that is widely used in development and production environments. This topic walks you through the steps to create a series of dashboards in Grafana to display metrics from a MS SQL Server database.

Download MS SQL Server

MS SQL Server can be installed on Windows or Linux operating systems and also on Docker containers. Refer to the MS SQL Server downloads page, for a complete list of all available options.

Install MS SQL Server

You can install MS SQL Server on the host running Grafana or on a remote server. To install the software from the downloads page, follow their setup prompts.

If you are on a Windows host but want to use Grafana and MS SQL data source on a Linux environment, refer to the WSL to set up your Grafana development environment. This will allow you to leverage the resources available in grafana/grafana GitHub repository. Here you will find a collection of supported data sources, including MS SQL Server, along with test data and pre-configured dashboards for use.

Add the MS SQL data source

There are several ways to authenticate in MSSQL. Start by:

  1. Click Connections in the left-side menu and filter by mssql.
  2. Select the Microsoft SQL Server option.
  3. Click Create a Microsoft SQL Server data source in the top right corner to open the configuration page.
  4. Select the desired authentication method and fill in the right information as detailed below.
  5. Click Save & test.
General configuration
NameDescription
NameThe data source name. This is how you refer to the data source in panels and queries.
HostThe IP address/hostname and optional port of your MS SQL instance. If port is omitted, the default 1433 will be used.
DatabaseName of your MS SQL database.
SQL Server Authentication
NameDescription
UserDatabase user’s login/username.
PasswordDatabase user’s password.
Windows Active Directory (Kerberos)

Below are the four possible ways to authenticate via Windows Active Directory/Kerberos.

Note

Windows Active Directory (Kerberos) authentication is not supported in Grafana Cloud at the moment.
MethodDescription
Username + passwordEnter the domain user and password
Keytab fileSpecify the path to a valid keytab file to use that for authentication.
Credential cacheLog in on the host via kinit and pass the path to the credential cache. The cache path can be found by running klist on the host in question.
Credential cache fileThis option allows multiple valid configurations to be present and matching is performed on host, database, and user. See the example JSON below this table.
json
[
  {
    "user": "grot@GF.LAB",
    "database": "dbone",
    "address": "mysql1.mydomain.com:3306",
    "credentialCache": "/tmp/krb5cc_1000"
  },
  {
    "user": "grot@GF.LAB",
    "database": "dbtwo",
    "address": "mysql2.gf.lab",
    "credentialCache": "/tmp/krb5cc_1000"
  }
]

For installations from the grafana/grafana repository, gdev-mssql data source is available. Once you add this data source, you can use the Datasource tests - MSSQL dashboard with three panels showing metrics generated from a test database.

MS SQL Server dashboard

Optionally, play around this dashboard and customize it to:

  • Create different panels.
  • Change titles for panels.
  • Change frequency of data polling.
  • Change the period for which the data is displayed.
  • Rearrange and resize panels.

Start building dashboards

Now that you have gained some idea of using the pre-packaged MS SQL data source and some test data, the next step is to setup your own instance of MS SQL Server database and data your development or sandbox area.

To fetch data from your own instance of MS SQL Server, add the data source using instructions in Step 4 of this topic. In Grafana Explore build queries to experiment with the metrics you want to monitor.

Once you have a curated list of queries, create dashboards to render metrics from the SQL Server database. For troubleshooting, user permissions, known issues, and query examples, refer to Using Microsoft SQL Server in Grafana.