dbt-heartbeat 0.1.14

A CLI tool to monitor individual dbt Cloud run jobs and receive macOS notifications when they complete.

dbt-heartbeat

A CLI tool to monitor individual dbt Cloud run jobs and receive macOS notifications when they complete.

Why This Exists

When working with large dbt projects that utilize a merge queue, developers often need to wait for long-running CI jobs to complete after syncing their branches with main before pushing changes. This tool solves two key problems:

1. Manual Monitoring: Instead of repeatedly checking job status or working on other things and forgetting about your dbt job and holding up the merge queue, automatically get notified when your specific run job completes.
2. Notification Control: AFAIK, dbt Cloud does not have notifications for job-specific runs. You can get notifications for all jobs of a specific environment/deployment, but not for specific runs within those environment/deployment jobs (i.e your own CI jobs in a staging environment).

All you need is a dbt Cloud developer PAT, dbt Cloud account ID, and a specific job run ID, and you'll be able to watch the status of the job run in your terminal and get notified in the macOS notification center when the job finishes.

Features

• Poll dbt Cloud job runs and monitor their status
• Cute terminal output with color-coded status updates xD
• System notifications for job completion (alerts sent to the macOS notification center)
• Configurable polling interval
• Can control the log level of the CLI output
• Detailed job run status information once complete in CLI + macOS notification center

Project Structure

dbt-heartbeat/
└── .github/
    └── workflows/
        └── ci_cd.yml         # CI/CD: lint, Publish to PyPi, GitHub Release
├── src/
│   ├── dbt_heartbeat.py      # Main Python module/entrypoint
│   └── utils/
│       ├── __init__.py
│       ├── dbt_cloud_api.py  # dbt Cloud API interactions
│       └── os_notifs.py      # macOS notifs
├── .pre-commit-config.yaml   # Pre-commits
├── pyproject.toml
└── README.md

Prerequisites

• Python 3.8 or higher
• Mac OS X 10.8 or higher
• dbt Cloud account with API access (via the dbt developer PAT)
• A Python package manager such as:
  • uv>=0.6.11
  • pip>=25.1.1

NOTE: While uv is the recommended method for installing dbt-heartbeat, you can also install it using pip install. However, when installing with pip, you are responsible for managing your Python virtual environment and ensuring that the directory containing the executable is included in your system's PATH. In contrast, when using uv (particularly as described in the For General Use section below) no additional environment configuration is required, and the executable is automatically made available in your PATH for immediate use.

Installation - For General Use

1. Add dbt environment variables to your shell configuration file (macOS defaults to ~/.zshrc)
   • Refer to the guide below for global export of environment variables for all terminal sessions
   • Other options are noted as well for non-global export of environment variables
2. Install uv
   • Check the installation with uv --version
3. Global installation:
   • Run uv tools install dbt-heartbeat
   • This will make dbt-heartbeat globally available on all terminal sessions
4. Check the installation with dh --version
5. Poll a job run!
   • dh <job_run_id>

Installation - For Contributors

1. Install uv

2. Clone the repository:

git clone [e-mail]:jairus-m/dbt-heartbeat.git
cd dbt-heartbeat

3. Add required environment variables in a .env file within your local repository's root directory

4. Create and activate the virtual environment:

uv venv # initialize
uv sync # sync
source .venv/bin/activate # activate

5. Run dh <job_run_id> --log-level DEBUG

Configuration Guide for Environment Variables

For global export

If you want to persist the environment variables in all terminal sessions without having to utilize a .env file or manually exporting the variables in your terminal session, you can add the export commands to your shell configuration file. (persisted)

# in shell configuration file (i.e `~/.zshrc` or `~/.bashrc`)
export DBT_CLOUD_API_KEY=your_dbt_cloud_api_key
export DBT_CLOUD_ACCOUNT_ID=your_dbt_cloud_account_id

For using a .env file

• Create a .env file in the project root with your dbt Cloud credentials
• The .env file is scoped to the terminal session that is loaded from the same working directory (persisted in project directory)

# add these to a .env file at the root of your directory
DBT_CLOUD_API_KEY=your_api_key
DBT_CLOUD_ACCOUNT_ID=your_account_id

For exporting manually in the terminal

Or export environment variables directly in your terminal session:

• Exporting is scoped to the specific terminal session you are in (ephemeral)

# run these in the terminal
export DBT_CLOUD_API_KEY=your_dbt_cloud_api_key
export DBT_CLOUD_ACCOUNT_ID=your_dbt_cloud_account_id

Usage

For help:

dh --help

For version:

dh --version

For installation location:

which dh

To upgrade:

uv tool upgrade dbt-heartbeat

Poll a dbt Cloud run job:

dh <job_run_id> [--log-level LEVEL] [--poll-interval SECONDS]

Note: You can find the <job_run_id> in the dbt Cloud UI:

• In the job run details page, look for Run #<job_run_id> in the header of each run
• Or from the URL when viewing a job run: https://cloud.getdbt.com/deploy/<account_id>/projects/<project_id>/runs/<job_run_id>

Arguments

• job_run_id: The ID of the dbt Cloud job run to monitor
• --log-level: Set the logging level (default: INFO)
  • Choices: DEBUG, INFO, WARNING, ERROR, CRITICAL
• --poll-interval: Time in seconds between polls (default: 30)

Example

# Poll run job with default settings
dh 123456

# Poll run job with debug logging and 15-second interval
dh 123456 --log-level DEBUG --poll-interval 15

Terminal Output

macOS Notification

Future Work & Limitations

1. The dbt CLoud API has a runs endpoint that's supposed to have a run_steps key within the data JSON object.
   • This would allow for dynamic output of which dbt command is currently running
   • Unfortunately, with dbt Cloud API v2, that endpoint has been unstable and is no longer populated leading to missing functionality for an enhanced CLI status output
2. I focused the notifications for my MacBook and thus, have used pync which is a wrapper for terminal-notifer (macOS-specific system notifications)
   • So unfortunately, this current version does not support notifications for other OS systems
   • Support for Windows is the goal for v0.2.0
3. Would like to add unit tests