Elementary data observability report can be used for visualization and exploration of data from the dbt-package tables. That includes dbt test results, Elementary anomaly detection results, dbt artifacts, tests runs, etc.
Before you can start using the report, make sure to install the dbt package, configure a profile and install the CLI. This is required for the report to work.
dbt package installation
Configure connection profile
In order to connect, Elementary needs a connection profile in a file named profiles.yml
.
This profile will be used by the CLI, to connect to the DWH and find the dbt package tables.
The easiest way to generate the profile is to run the following command within the dbt project where you deployed the elementary dbt package (works in dbt cloud as well):
Ensure that you fill in your password and any other missing fields after you
paste the profile in your local profiles.yml
file.
Copy the output, fill in the missing fields and add the profile to your profiles.yml
.
Here is a demonstration:
HOME_DIR/.dbt/profiles.yml
elementary
<your_dbt_project_schema>_elementary
Install CLI
To install the monitor module run:
Run one of the following commands based on your platform (no need to run all):
Run edr --help
in order to ensure the installation was successful.
If you're receiving command not found: edr
please check our troubleshooting guide.
edr report
in your terminalAfter installing and configuring the CLI, execute the command:
The command will use the provided connection profile to access the data warehouse, read from the Elementary tables, and generate the report as an HTML file.
Elementary support filtering the report by invocation on generation.
The filtered report will only include data for the selected invocation (This applies only on the Test Results
and Lineage
screens).
There are 3 ways to filter the report by invocation:
dbt test
/ dbt build
) that ran.dbt test
/ dbt build
) to the provided time (the provided time should be in ISO format local time).dbt test
/ dbt build
) id.Filters usage example:
Elementary offers 3 methods that make it easy to share the report with others:
Refer to this guide for detailed instructions.
Elementary data observability report can be used for visualization and exploration of data from the dbt-package tables. That includes dbt test results, Elementary anomaly detection results, dbt artifacts, tests runs, etc.
Before you can start using the report, make sure to install the dbt package, configure a profile and install the CLI. This is required for the report to work.
dbt package installation
Configure connection profile
In order to connect, Elementary needs a connection profile in a file named profiles.yml
.
This profile will be used by the CLI, to connect to the DWH and find the dbt package tables.
The easiest way to generate the profile is to run the following command within the dbt project where you deployed the elementary dbt package (works in dbt cloud as well):
Ensure that you fill in your password and any other missing fields after you
paste the profile in your local profiles.yml
file.
Copy the output, fill in the missing fields and add the profile to your profiles.yml
.
Here is a demonstration:
HOME_DIR/.dbt/profiles.yml
elementary
<your_dbt_project_schema>_elementary
Install CLI
To install the monitor module run:
Run one of the following commands based on your platform (no need to run all):
Run edr --help
in order to ensure the installation was successful.
If you're receiving command not found: edr
please check our troubleshooting guide.
edr report
in your terminalAfter installing and configuring the CLI, execute the command:
The command will use the provided connection profile to access the data warehouse, read from the Elementary tables, and generate the report as an HTML file.
Elementary support filtering the report by invocation on generation.
The filtered report will only include data for the selected invocation (This applies only on the Test Results
and Lineage
screens).
There are 3 ways to filter the report by invocation:
dbt test
/ dbt build
) that ran.dbt test
/ dbt build
) to the provided time (the provided time should be in ISO format local time).dbt test
/ dbt build
) id.Filters usage example:
Elementary offers 3 methods that make it easy to share the report with others:
Refer to this guide for detailed instructions.