Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions knowledge_base/dashboard_nyc_taxi/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,33 @@
# Dashboard for NYC Taxi Trip Analysis

This example demonstrates how to define an AI/BI dashboard in a Databricks Asset Bundle.
This example shows how to define a Databricks Asset Bundle with an AI/BI dashboard and a job that captures a snapshot of the dashboard and emails it to a subscriber.

It includes and deploys the sample __NYC Taxi Trip Analysis__ dashboard to a Databricks workspace.
It deploys the sample __NYC Taxi Trip Analysis__ dashboard to a Databricks workspace and configures a daily schedule to run the dashboard and send the snapshot in email to a specified email address.

For more information about AI/BI dashboards, please refer to the [documentation](https://docs.databricks.com/dashboards/index.html).

## Prerequisites

* Databricks CLI v0.232.0 or above
This example includes a dashboard snapshot task, which requires Databricks CLI v0.250.0 or above. Creating dashboards in bundles is supported in Databricks CLI v0.232.0 or above.

## Usage

Modify `databricks.yml`:
* Update the `host` field under `workspace` to the Databricks workspace to deploy to.
* Update the `warehouse` field under `warehouse_id` to the name of the SQL warehouse to use.
1. Modify `databricks.yml`:
- Update the `host` field under `workspace` to the Databricks workspace to deploy to.
- Update the `warehouse` field under `warehouse_id` to the name of the SQL warehouse to use.

Run `databricks bundle deploy` to deploy the dashboard.
2. Modify `resources/nyc_taxi_trip_analysis.job.yml`:
- Update the `user_name` field under `subscribers` to the dashboard subscriber's email.

Run `databricks bundle open` to navigate to the deployed dashboard in your browser. Alternatively, run `databricks bundle summary` to display its URL.
3. Deploy the dashboard:
- Run `databricks bundle deploy` to deploy the dashboard.
- Run `databricks bundle open` to navigate to the deployed dashboard in your browser. Alternatively, run `databricks bundle summary` to display its URL.

The AI/BI dashboard is created and the snapshot job is set to run daily at 8 AM, which captures a snapshot of the dashboard, and sends it in email to the specified subscriber.

### Visual modification

You can use the Databricks UI to modify the dashboard, but any modifications made through the UI will not be applied to the bundle `.lvdash.json` file unless you explicitly update it.
You can use the Databricks UI to modify the dashboard, but any modifications made through the UI will not be applied to the bundle `.lvdash.json` file unless you explicitly update it.

To update the local bundle `.lvdash.json` file, run:

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
resources:
jobs:
dashboard_snapshot_job:
name: "Daily NYC Taxi Trip Analysis refresh"

schedule:
quartz_cron_expression: '0 0 8 * * ?' # daily at 8am
timezone_id: UTC

tasks:
- task_key: dashboard_task
dashboard_task:
subscription:
subscribers:
- user_name: ${workspace.current_user.userName} # Replace this with the email of snapshot subscriber email
paused: false
warehouse_id: ${var.warehouse_id}
dashboard_id: ${resources.dashboards.nyc_taxi_trip_analysis.id}