elementary - Meltano Hub

Elementary

elementary (elementary variant)

Elementary is an open-source data observability solution for data & analytics engineers.

The elementary utility enables you to automate test report generation and anomaly detection using Elementary

This is a work in progress; any feedback on issues in the extension repo is appreciated!
When upgrading Elementary, ensure you update the dbt_packages entry version as well

EDK Based Plugin

This utility is based on the Meltano Extension Developer Kit (EDK) which is the preferred way to build and add non-Singer plugins to Meltano Hub. For more information about the EDK, please read this section of the Meltano docs. If you have any feedback or suggestions, add them to the EDK repo.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the elementary utility to your project using
```
meltano add
```
:

meltano add utility elementary

Configure the elementary settings using

meltano config

meltano config elementary set --interactive

Next steps

This a dbt extension, and therefore requires knowledge and understanding of dbt before adding to your project. Please install one of the available dbt extensions from Meltano Hub before proceeding with the rest of the setup.

Specify your dbt adapter in the pip_url and in your profiles directory

Example, in the case of BigQuery:

pip_url: elementary-data[bigquery] git+https://github.com/potloc/elementary-ext.git
config:
  profiles_dir: ${MELTANO_PROJECT_ROOT}/transform/profiles/

Run dbt deps

This will populate you dbt_packages folder with pertinent dbt models

It is important to note that you will need to update your dbt packages file when you update your your elementary pip url. These 2 different packages Should have the same version

Follow elementary setup tutorial

Tutorial found here: https://docs.elementary-data.com/quickstart

Invoke Elementary

Run meltano invoke elementary:monitor-report and see your brand new report!

If you run into any issues, learn how to get help.

Capabilities

This plugin currently has no capabilities defined. If you know the capabilities required by this plugin, please contribute!

Settings

The elementary settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

file-path
profiles-dir
project_dir
slack-channel-name
slack-token

You can also list these settings using

meltano config

with the list subcommand:

meltano config elementary list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

File Path (file-path)

Environment variable: ELEMENTARY_FILE-PATH

Location of the file generated by the monitor-report commands