Documentation Plugins Databricks data source for Grafana

Databricks data source for Grafana

The Databricks data source allows a direct connection to Databricks to query and visualize Databricks data in Grafana.

This data source provides an SQL editor to format and color code your SQL statements.

Installation

For detailed instructions on how to install the plugin on Grafana Cloud or locally, please checkout the Plugin installation docs.

Note: This plugin uses dynamic links for Credentials authentication (deprecated). We suggest using Token authentication. If you run the plugin on bare Alpine Linux, using Credentials authentication it will not work. If for some reason Token based auth is not an option and Alpine Linux is a requirement, we suggest using our Alpine images.

Manual configuration

Once the plugin is installed on your Grafana instance, follow these instructions to add a new Databricks data source, and enter configuration options.

With a configuration file

It is possible to configure data sources using configuration files with Grafana’s provisioning system. To read about how it works, including all the settings that you can set for this data source, refer to Provisioning Grafana data sources.

Here are some provisioning examples for this data source using basic authentication:

yaml Copy

apiVersion: 1
datasources:
  - name: Databricks
    type: grafana-databricks-datasource
    jsonData:
      host: community.cloud.databricks.com
      httpPath: path-from-databricks-odbc-settings
    secureJsonData:
      token: password/personal-token

Time series

Time series visualization options are selectable after adding a datetime field type to your query. This field will be used as the timestamp. You can select time series visualizations using the visualization options. Grafana interprets timestamp rows without explicit time zone as UTC. Any column except time is treated as a value column.

Multi-line time series

To create multi-line time series, the query must return at least 3 fields in the following order:

• field 1: datetime field with an alias of time
• field 2: value to group by
• field 3+: the metric values

For example:

sql Copy

SELECT log_time AS time, machine_group, avg(disk_free) AS avg_disk_free
FROM mgbench.logs1
GROUP BY machine_group, log_time
ORDER BY log_time

Templates and variables

To add a new Databricks query variable, refer to Add a query variable.

After creating a variable, you can use it in your Databricks queries by using Variable syntax. For more information about variables, refer to Templates and variables.

Macros in Databricks Query

$__interval_long macro

In some cases, you may want to use window grouping with Spark SQL.

Example:

sql Copy

SELECT window.start, avg(aggqueue) FROM a17
GROUP BY window(_time,  '$__interval_long')

will be translated into the following query based on dashboard interval.

sql Copy

SELECT window.start, avg(aggqueue) FROM a17
GROUP BY window(_time,  '2 MINUTE')

Macro examples

The following table shows the macro expansion for the $__interval_long macro when Grafana has a 1m interval.

OAuth Configuration

OAuth Passthrough with Microsoft Entra ID (Azure Active Directory)

Gather information

1. Go to your Databricks Dashboard as an administrator under Settings > Identity and access > SSO and sync > SSO Settings > Manage:
2. Copy the Databricks SAML URL. (Don’t close the tab)
3. Create your App Registration:
4. Go to the Azure Portal
5. Microsoft Entra ID > Add > Enterprise Application
6. Enter a name for the application. When asked “What are you looking to do with your application?”, choose Integrate any other application you don’t find in the gallery.
7. Under Properties set Assignment Required to NO:
8. Under Single-sign on click on SAML and under Basic SAML Configuration click edit:
9. Set Identifier ID to the Databricks SAML URL saved from earlier and for Reply URLS set it also to the Databricks SAML URL as well as the Grafana redirect URLs from this guide
10. Under SAML Sign-in Certificate click Edit and set Sign-in Option to Sign SAML response and assertion. Click Save.
11. Under Attributes & Claims click edit. Set the Unique User Identifier (Name ID) field to user.mail
12. Under SAML Certificates next to Certificate Base 64 click Download. This will download a .cer file. Copy the contents for further steps in Databricks.
13. Also save Login URL and Microsoft Entra ID Identifier for Databricks
14. Back in your Databricks SSO Settings tab

• Single Sign-On URL => Login URL (from previous step)
• Identity Provider Entity ID => Microsoft Entra Identifier (from previous step)
• X.509 Certificate => Contents from downloaded certificate

Complete Grafana OAuth Setup

1. On the Azure Portal go to App Registrations > All Applications and find your application name
2. On the overview page note the Application (client) ID. For config in your conf.ini file this is the Oauth client ID as well of Directory (tenant) ID.
3. Click on Endpoints:
4. Note the OAuth 2.0 authorization endpoint (v2) URL. This is the authorization URL.
5. Note the OAuth 2.0 token endpoint (v2). This is the token URL.
6. Click Certificates & secrets, then add a new entry under Client secrets with the following configuration.
7. Description: Grafana OAuth
8. Expires: Never
9. Click Add then copy the key value. This is the OAuth client secret.

Define Required Roles

1. Go to Microsoft Entra ID and then to Enterprise Applications.
2. Search for your application and click it.
3. Click Users and Groups.
4. Click Add user/group to add a user or group to the Grafana roles.
5. Now go back to Microsoft Entra ID and then to App Registrations. Search for your app and click it.
6. Go to App Roles and configure roles like described in here.
7. Now Configure AD Oauth in Grafana Configuration file as described in here.

Forward Token to Users

In your grafana.ini file set:

ini Copy

[azure]
forward_settings_to_plugins = grafana-azure-monitor-datasource, prometheus, grafana-azure-data-explorer-datasource, mssql, grafana-databricks-datasource

Finally, under the data source settings page set the Authentication Type to OAuth Passthrough.

On-behalf-of Authentication

On-behalf-of authentication is only applicable to Azure Databricks clusters. It allows individual users to be authenticated using their own credentials via an App Registration configured in Azure with access to Databricks resources.

On-behalf-of authentication is not supported for private clouds (Azure China Cloud, Azure Government Cloud) at this time.

Note: Do not set up alerts when your data source is configured to use the on-behalf-of authentication. Alert rules will not work as there will not be a user in scope to provide credentials for the query.

Setup

1. Configure Grafana to use OAuth2 with Microsoft Entra ID as documented. The [auth.azuread] scopes (or $GF_AUTH_AZUREAD_SCOPES) must contain “openid email profile offline_access”.

2. ID tokens must be enabled with a checkbox found on the Azure portal under “App Registrations” → the respective application → “Manage” → “Authentication”.

3. In addition to the “Microsoft Graph” User.Read, a special “Azure Databricks” user_impersonation permission must be enabled on the Azure portal under “App Registrations” → the respective application → “Manage” → “API permissions”.

4. Enable “Admin consent” under “App Registrations” → the respective application → “Security” → “Permissions”. Enabling “Admin consent” will grant consent on behalf of all users in the current tenant, ensuring the users will not be required to consent when using the application.

5. When configuring the data source for an Azure Databricks cluster, the hostname and HTTP path can be found by navigating to your Azure Databricks cluster → SQL Warehouses → Connection details → Server hostname and HTTP path.

6. Use the Tenant ID, Client ID, and Client secret values for the Application Registration created in step 1.

Learn more

• Add Annotations.
• Configure and use Templates and variables.
• Add Transformations.
• Set up alerting; refer to Alerts overview.