How to crawl Redash

Updated May 14, 2024 12:29

Once you have configured the Redash permissions, you can establish a connection between Atlan and Redash.

To crawl metadata from Redash, review the order of operations and then complete the following steps.

Select the source

To select Redash as your source:

In the top right of any screen in Atlan, navigate to +New and click New Workflow.
From the Marketplace page, click Redash Assets.
In the right panel, click Setup Workflow.

To enter your Redash credentials:

For Host Name, enter the URL for your Redash instance.
For Authentication, API Key is the default selection.
For API Key, enter the API key you copied from your Redash instance.
Click the Test Authentication button to confirm connectivity to Redash.
Once authentication is successful, navigate to the bottom of the screen and click Next.

To complete the Redash connection configuration:

Provide a Connection Name that represents your source environment. For example, you might use values like production,development,gold, or analytics.
(Optional) To change the users who are able to manage this connection, change the users or groups listed under Connection Admins.
🚨 Careful! If you do not specify any user or group, no one will be able to manage the connection — not even admins.
Navigate to the bottom of the screen and click Next to proceed.

Before running the Redash crawler, you can further configure it.

On the Metadata page, you can override the defaults for any of these options:

To select the queries with tags you want to include in crawling, click Include queries with tags. (This will default to all assets, if none are specified.)
To select the queries with tags you want to exclude from crawling, click Exclude queries with tags. (This will default to no assets, if none are specified.)
To select the dashboards with tags you want to include in crawling, click Include dashboards with tags. (This will default to all assets, if none are specified.)
To select the dashboards with tags you want to exclude from crawling, click Exclude dashboards with tags. (This will default to no assets, if none are specified.)
For Advanced Config, you can either keep Default to allow default options for asset inclusion or click Custom to further configure the crawler:
- For Include unpublished queries, click Yes to enable crawling unpublished queries or No to skip crawling them.
- For Include queries without tags, click Yes to enable crawling queries without tags or No to skip crawling them.
- For Include dashboards without tags, click Yes to enable crawling dashboards without tags or No to skip crawling them.
- For Alternate Host URL, enter the protocol and host name to be used for viewing your assets directly in Redash from Atlan. If added, the View in Redash option will redirect to the alternate host URL instead of the host URL used to run the crawler.

💪 Did you know? If an asset appears in both the include and exclude filters, the exclude filter takes precedence.

To run the Redash crawler, after completing the steps above:

To check for any permissions or other configuration issues before running the crawler, click Preflight checks.
You can either:
- To run the crawler once immediately, at the bottom of the screen, click the Run button.
- To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the Schedule Run button.

Once the crawler has completed running, you will see the assets on Atlan's asset page! 🎉