Connect Databricks

Connect your Databricks source to Bigeye, we recommend using serverless SQL warehouses on Databricks for cost efficiency.

📘

Connecting for AI Agent Trust Hub?

If you plan to bring Databricks Genie activity into Bigeye's Agent Trust Hub, follow this page to connect the source, then see Connect Databricks to Agent Trust Hub for the extra Genie permissions and setup.

One constraint affects the choice you make below: Agent Trust Hub requires Access Token (PAT) authentication. OAuth M2M works for data-quality monitoring but is not supported for Agent Trust Hub.

1. Allow Bigeye's IP address

If you've set up network policies to restrict the IP addresses that communicate with your Databricks instance, modify these policies to allow all of Bigeye's Static IP addresses .

2 Give Bigeye access to Databricks

2.1 Generate a service principal for Bigeye to use.

Credentials are needed for Bigeye to connect to Databricks. We recommend that you create a service principal and generate an access token for that service principal. We also support OAuth M2M tokens.

  1. Create service principal in the Databricks Account Console by going to Admin Settings -> Identity and Access -> Manage Service Principals -> Add service principal. Note the service principal's application id

2.2.1 Access token

  1. Give access token permissions to the service principal by following these instructions from Databricks.
  2. Generate an access token for the service principal by following these instructions from Databricks.

2.2.2 OAuth M2M Token

  1. Create an M2M token for the service principal by following these instructions from Databricks. Note the Secret and the Client ID.

2.2 Grant permissions to Bigeye's service principal

2.2.1 Unity Catalog

If you want to Grant access to all existing and future tables within catalog

GRANT USE_CATALOG ON CATALOG <catalog_name> TO `<application_id>`;
GRANT USE_SCHEMA ON CATALOG <catalog_name> TO `<application_id>`;
GRANT SELECT ON CATALOG <catalog_name> TO `<application_id>`;

If you want to Grant access to specific tables

GRANT USE_CATALOG ON CATALOG <catalog_name> TO `<application_id>`;
GRANT USE_SCHEMA ON SCHEMA <catalog_name>.<schema_name> TO `<application_id>`;
GRANT SELECT ON TABLE <catalog_name>.<schema_name>.<table_name> TO `<application_id>`;

2.2.2 Hive Metastore

GRANT READ_METADATA, USAGE, SELECT ON catalog <catalog_name> to `<application_id>`
📘

Agent Trust Hub needs additional grants

The permissions above cover data-quality monitoring. Agent Trust Hub also
requires workspace entitlements (workspace-access, databricks-sql-access),
CAN VIEW (or CAN MANAGE for full history) on each Genie Space, and CAN USE
on the SQL warehouse. See Connect Databricks to Agent Trust Hub.

3. Gather connection details from Delta Lake

Login to your Delta Lake account.

  1. Click Compute in the sidebar.
  2. Choose a cluster to connect to.
  3. Navigate to Advanced Options.
  4. Click the JDBC/ODBC tab.
  5. Copy Server Hostname, Port, and Http Path.

4. Add Databricks as a data source in Bigeye

Login to your Bigeye account.

On the Catalog page, click Add Source and then select Databricks from the Choose a data source section. Click Next to configure the connection to your database.

On the Configure source modal that opens, first select the authentication type that you are using and enter the following details:

4.1 Access token

Field NameDescription
NameThe identifying name of the data source in Bigeye.
HostThe hostname from step 3.
PortThe port from step 3.
AuthTypePersonal access token
HTTP pathThe HTTP path from step 3.
Access tokenThe access token for the service principal from step 2.2.1.2.

4.2 OAuth M2M Token

Field NameDescription
NameThe identifying name of the data source in Bigeye.
HostThe hostname from step 3.
PortThe port from step 3.
AuthTypeOAuth machine-to-machine (M2M)
HTTP pathThe HTTP path from step 3.
OAuth2ClientIdThe OAuth id from step 2.2.2.1.
OAuth2SecretThe OAuth secret from step 2.2.2.1.
🚧

Agent Trust Hub requires Access Token authentication

If you intend to use Agent Trust Hub, connect with Access Token
Authentication
(a personal access token). Agent Trust Hub calls the Databricks
Genie API with a bearer token and does not support OAuth M2M today.

5. Next Steps

After you've configured the source, Bigeye loads and profiles your tables. It can take up to 24 hours for the profiling to complete and your autometrics and autothresholds to populate. See how to deploy autometrics in the Getting Started guide.

To bring Databricks Genie activity into Bigeye, continue to Connect Databricks to Agent Trust Hub.



What’s Next

Did this page help you?