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
90 changes: 40 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,70 @@
<p align="center">
<img alt="Logo" src="static/github_banner.png"/ width="1000">
<img alt="Logo" src="https://res.cloudinary.com/do5hrgokq/image/upload/v1764493013/github_banner_zp5l2o.png" width="1000">
</p>
<p align="center">
<a href="https://join.slack.com/t/elementary-community/shared_invite/zt-uehfrq2f-zXeVTtXrjYRbdE_V6xq4Rg"><img src="https://img.shields.io/badge/join-Slack-ff69b4"/></a>
<a href="https://docs.elementary-data.com/oss/quickstart/quickstart-cli-package"><img src="https://img.shields.io/badge/docs-quickstart-orange"/></a>
<img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-ff69b4"/>
<img alt="Downloads" src="https://static.pepy.tech/personalized-badge/elementary-lineage?period=total&units=international_system&left_color=grey&right_color=orange"&left_text=Downloads/>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Fix malformed HTML attribute in Downloads badge.

The src attribute is not properly closed. The URL is followed by "&left_text=Downloads/>, which breaks the tag syntax.

Apply this diff:

-<img alt="Downloads" src="https://static.pepy.tech/personalized-badge/elementary-lineage?period=total&units=international_system&left_color=grey&right_color=orange"&left_text=Downloads/>
+<img alt="Downloads" src="https://static.pepy.tech/personalized-badge/elementary-lineage?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads" />
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<img alt="Downloads" src="https://static.pepy.tech/personalized-badge/elementary-lineage?period=total&units=international_system&left_color=grey&right_color=orange"&left_text=Downloads/>
<img alt="Downloads" src="https://static.pepy.tech/personalized-badge/elementary-lineage?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads" />
🤖 Prompt for AI Agents
In README.md around line 8, the <img> tag has a malformed src attribute because
the closing quote is placed before the &left_text parameter; move the
&left_text=Downloads fragment inside the src value and close the quote properly,
then ensure the tag is closed (e.g.,
src="...&left_color=orange&left_text=Downloads" />) so the attribute syntax and
tag are valid.

</p>

<h2 align="center">
dbt-native data observability for analytics & data engineers
Elementary OSS: dbt-native data observability
</h2>

<p align="center">
<a href="https://www.elementary-data.com/community"><img src="https://img.shields.io/badge/join-Slack-ff69b4"/></a>
<a href="https://docs.elementary-data.com/quickstart"><img src="https://img.shields.io/badge/docs-quickstart-orange"/></a>
<img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-ff69b4"/>
<img alt="Downloads" src="https://static.pepy.tech/personalized-badge/elementary-lineage?period=total&units=international_system&left_color=grey&right_color=orange"&left_text=Downloads"/>

<div align="center">

⭐️ Star the repo <a href="https://github.com/elementary-data/elementary/stargazers"><img src="static/star_github.png" width="45"/></a> ⭐

[Demo »](https://bit.ly/3IAp9wf) | [Docs »](https://docs.elementary-data.com/) | [Slack »](https://www.elementary-data.com/community)
[Docs »](https://docs.elementary-data.com/) | [Join the Elementary Community »](https://www.elementary-data.com/community)

</div>
<div align="center">
⭐️ Star the repo <a href="https://github.com/elementary-data/elementary/stargazers"><img src="static/star_github.png" width="45"/></a>
</div>
</br>

## What is Elementary?

Elementary is a dbt-native data observability solution for data and analytics engineers.
Set up in minutes, gain immediate visibility, detect data issues, send actionable alerts, and understand impact and root cause.
Elementary has two offerings: an open-source package and managed platform.
**Built by the [Elementary](https://www.elementary-data.com) team, helping you deliver trusted data in the AI era.**

<kbd align="center">
<a href="https://storage.googleapis.com/elementary_static/elementary_demo.html"><img align="center" style="max-width:300px;" src="static/report_ui.gif"> </a>
</kbd>
Elementary OSS is the open-source CLI for dbt-native data observability. It works with the [Elementary dbt package](https://github.com/elementary-data/dbt-data-reliability) to generate the basic Elementary observability report and send alerts to Slack and Microsoft Teams.

<br>
For teams that need data reliability at scale, we offer **[Elementary Cloud](https://www.elementary-data.com/)**, a full Data & AI Control Plane with automated ML monitoring, column-level lineage from source to BI, a built-in catalog, and AI agents that scale reliability workflows for both engineers and business users.

## Open-source Package vs. Cloud Platform
![Demo](static/newreadmedemo.gif)

### Elementary Cloud Platform
## How It Works

Ideal for teams monitoring mission-critical data pipelines, requiring guaranteed uptime and reliability, short-time-to-value, advanced features, collaboration, and professional support.
The solution is secure by design, and requires no access to your data from cloud.
Elementary OSS connects to your warehouse and reads the metadata, artifacts, and test results collected by the Elementary dbt package.
With this information, it can:

[Get started with Elementary Cloud](https://docs.elementary-data.com/quickstart)
- Generate a data observability report
- Surface anomalies and failed tests
- Send alerts to Slack and Teams
- Track model and test performance trends

### Open-source Package
## Quickstart

Elementary Community is an open-source CLI tool you can deploy and orchestrate to send Slack alerts and self-host the Elementary report. It is best for data and analytics engineers that require basic observability capabilities.
Follow the quickstart guide to install and configure the Elementary dbt package and CLI:

[Get started with the Open-source Package](https://docs.elementary-data.com/oss/oss-introduction)
👉 https://docs.elementary-data.com/oss/quickstart
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Wrap bare URL in markdown link syntax.

Line 48 contains a bare URL that violates markdown lint conventions. URLs should be wrapped in markdown link syntax for better formatting and consistency.

- 👉 https://docs.elementary-data.com/oss/quickstart
+ 👉 [https://docs.elementary-data.com/oss/quickstart](https://docs.elementary-data.com/oss/quickstart)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
👉 https://docs.elementary-data.com/oss/quickstart
👉 [https://docs.elementary-data.com/oss/quickstart](https://docs.elementary-data.com/oss/quickstart)
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

48-48: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents
In README.md around line 48, the bare URL
"https://docs.elementary-data.com/oss/quickstart" should be wrapped in markdown
link syntax; replace the raw URL with a markdown link like [Quickstart
Guide](https://docs.elementary-data.com/oss/quickstart) or an appropriately
labeled link so it conforms to markdown linting and improves readability.


## Features

**Anomaly detection tests** - Collect data quality metrics and detect anomalies, as native dbt tests.

**Automated monitors** - Out-of-the-box cloud monitors to detect freshness, volume and schema issues.

**End-to-End Data Lineage** - Enriched with the latest test results, for impact and root cause analysis of data issues. Elementary Cloud offers **Column Level Lineage** and **BI integrations**.

**Data quality dashboard** - Single interface for all your data monitoring and test results.

**Models performance** - Monitor models and jobs run results and performance over time.

**Configuration-as-code** - Elementary configuration is managed in your dbt code.

**Alerts** - Actionable alerts including custom channels and tagging of owners.

**Data catalog** - Explore your datasets information - descriptions, columns, datasets health, etc.

**dbt artifacts uploader** - Save metadata and run results as part of your dbt runs.

**AI-Powered Data Tests & Unstructured Data Validations** - Validate and monitor data using AI powered tests to validate both structured and unstructured data
- **Anomaly detection tests** - Collect data quality metrics and detect anomalies, as native dbt tests.
- **Automated monitors** - Out-of-the-box cloud monitors to detect freshness, volume and schema issues.
- **End-to-End Data Lineage** - Enriched with the latest test results, for impact and root cause analysis of data issues. Elementary Cloud offers **Column-Level-Lineage from ingestion to BI**.
- **Data quality dashboard** - Single interface for all your data monitoring and test results.
- **Models performance** - Monitor models and jobs run results and performance over time.
- **Configuration-as-code** - Elementary configuration is managed in your dbt code.
- **Alerts** - Actionable alerts including custom channels and tagging of owners.
- **Data catalog** - Explore your datasets information - descriptions, columns, datasets health, etc.
- **dbt artifacts uploader** - Save metadata and run results as part of your dbt runs.
- **AI-Powered Data Tests & Unstructured Data Validations** - Validate and monitor data using AI powered tests to validate both structured and unstructured data
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Hyphenate "AI-powered" for proper grammar.

The phrase "AI powered" on Line 60 should use a hyphen to join the compound modifier.

- - **AI-Powered Data Tests & Unstructured Data Validations** - Validate and monitor data using AI powered tests to validate both structured and unstructured data
+ - **AI-Powered Data Tests & Unstructured Data Validations** - Validate and monitor data using AI-powered tests to validate both structured and unstructured data
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **AI-Powered Data Tests & Unstructured Data Validations** - Validate and monitor data using AI powered tests to validate both structured and unstructured data
- **AI-Powered Data Tests & Unstructured Data Validations** - Validate and monitor data using AI-powered tests to validate both structured and unstructured data
🧰 Tools
🪛 LanguageTool

[grammar] ~60-~60: Use a hyphen to join words.
Context: ...s** - Validate and monitor data using AI powered tests to validate both structure...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
In README.md around line 60, the phrase "AI powered" should be hyphenated as
"AI-powered"; update the line to use "AI-powered Data Tests & Unstructured Data
Validations" (i.e., replace "AI powered" with "AI-powered") to correct the
compound modifier grammar.


## Support

For additional information and help, you can use one of these channels:
For additional information and help:

- [Slack community](https://www.elementary-data.com/community) \(Release announcements, community support, discussions, etc.\)
- [GitHub issues](https://github.com/elementary-data/elementary/issues) \(Bug reports, feature requests)
- [Join thousands of users in the Slack community](https://www.elementary-data.com/community) \(Release announcements, community and AI support, discussions, etc.\)
- [Open a GitHub issue](https://github.com/elementary-data/elementary/issues) \(Bug reports, feature requests)
- Check out the [contributions guide](./CONTRIBUTING.md) and [open issues](https://github.com/elementary-data/elementary/issues).

##
Expand Down
Binary file added static/demoreadme.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/newreadmedemo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.