|
1 | 1 | <p align="center"> |
2 | | -<img alt="Logo" src="static/github_banner.png"/ width="1000"> |
| 2 | +<img alt="Logo" src="https://res.cloudinary.com/do5hrgokq/image/upload/v1764493013/github_banner_zp5l2o.png" width="1000"> |
| 3 | +</p> |
| 4 | +<p align="center"> |
| 5 | +<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> |
| 6 | +<a href="https://docs.elementary-data.com/oss/quickstart/quickstart-cli-package"><img src="https://img.shields.io/badge/docs-quickstart-orange"/></a> |
| 7 | +<img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-ff69b4"/> |
| 8 | +<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/> |
3 | 9 | </p> |
4 | 10 |
|
5 | 11 | <h2 align="center"> |
6 | | - dbt-native data observability for analytics & data engineers |
| 12 | +Elementary OSS: dbt-native data observability |
7 | 13 | </h2> |
8 | 14 |
|
9 | | -<p align="center"> |
10 | | -<a href="https://www.elementary-data.com/community"><img src="https://img.shields.io/badge/join-Slack-ff69b4"/></a> |
11 | | -<a href="https://docs.elementary-data.com/quickstart"><img src="https://img.shields.io/badge/docs-quickstart-orange"/></a> |
12 | | -<img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-ff69b4"/> |
13 | | -<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"/> |
14 | | - |
15 | 15 | <div align="center"> |
16 | 16 |
|
17 | | -⭐️ Star the repo <a href="https://github.com/elementary-data/elementary/stargazers"><img src="static/star_github.png" width="45"/></a> ⭐ |
18 | | - |
19 | | -[Demo »](https://bit.ly/3IAp9wf) | [Docs »](https://docs.elementary-data.com/) | [Slack »](https://www.elementary-data.com/community) |
| 17 | +[Docs »](https://docs.elementary-data.com/) | [Join the Elementary Community »](https://www.elementary-data.com/community) |
20 | 18 |
|
21 | 19 | </div> |
| 20 | +<div align="center"> |
| 21 | + ⭐️ Star the repo <a href="https://github.com/elementary-data/elementary/stargazers"><img src="static/star_github.png" width="45"/></a> |
| 22 | +</div> |
| 23 | +</br> |
22 | 24 |
|
23 | | -## What is Elementary? |
24 | | - |
25 | | -Elementary is a dbt-native data observability solution for data and analytics engineers. |
26 | | -Set up in minutes, gain immediate visibility, detect data issues, send actionable alerts, and understand impact and root cause. |
27 | | -Elementary has two offerings: an open-source package and managed platform. |
| 25 | +**Built by the [Elementary](https://www.elementary-data.com) team, helping you deliver trusted data in the AI era.** |
28 | 26 |
|
29 | | -<kbd align="center"> |
30 | | - <a href="https://storage.googleapis.com/elementary_static/elementary_demo.html"><img align="center" style="max-width:300px;" src="static/report_ui.gif"> </a> |
31 | | -</kbd> |
| 27 | +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. |
32 | 28 |
|
33 | | -<br> |
| 29 | +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. |
34 | 30 |
|
35 | | -## Open-source Package vs. Cloud Platform |
| 31 | + |
36 | 32 |
|
37 | | -### Elementary Cloud Platform |
| 33 | +## How It Works |
38 | 34 |
|
39 | | -Ideal for teams monitoring mission-critical data pipelines, requiring guaranteed uptime and reliability, short-time-to-value, advanced features, collaboration, and professional support. |
40 | | -The solution is secure by design, and requires no access to your data from cloud. |
| 35 | +Elementary OSS connects to your warehouse and reads the metadata, artifacts, and test results collected by the Elementary dbt package. |
| 36 | +With this information, it can: |
41 | 37 |
|
42 | | -[Get started with Elementary Cloud](https://docs.elementary-data.com/quickstart) |
| 38 | +- Generate a data observability report |
| 39 | +- Surface anomalies and failed tests |
| 40 | +- Send alerts to Slack and Teams |
| 41 | +- Track model and test performance trends |
43 | 42 |
|
44 | | -### Open-source Package |
| 43 | +## Quickstart |
45 | 44 |
|
46 | | -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. |
| 45 | +Follow the quickstart guide to install and configure the Elementary dbt package and CLI: |
47 | 46 |
|
48 | | -[Get started with the Open-source Package](https://docs.elementary-data.com/oss/oss-introduction) |
| 47 | +👉 https://docs.elementary-data.com/oss/quickstart |
49 | 48 |
|
50 | 49 | ## Features |
51 | 50 |
|
52 | | -**Anomaly detection tests** - Collect data quality metrics and detect anomalies, as native dbt tests. |
53 | | - |
54 | | -**Automated monitors** - Out-of-the-box cloud monitors to detect freshness, volume and schema issues. |
55 | | - |
56 | | -**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**. |
57 | | - |
58 | | -**Data quality dashboard** - Single interface for all your data monitoring and test results. |
59 | | - |
60 | | -**Models performance** - Monitor models and jobs run results and performance over time. |
61 | | - |
62 | | -**Configuration-as-code** - Elementary configuration is managed in your dbt code. |
63 | | - |
64 | | -**Alerts** - Actionable alerts including custom channels and tagging of owners. |
65 | | - |
66 | | -**Data catalog** - Explore your datasets information - descriptions, columns, datasets health, etc. |
67 | | - |
68 | | -**dbt artifacts uploader** - Save metadata and run results as part of your dbt runs. |
69 | | - |
70 | | -**AI-Powered Data Tests & Unstructured Data Validations** - Validate and monitor data using AI powered tests to validate both structured and unstructured data |
| 51 | +- **Anomaly detection tests** - Collect data quality metrics and detect anomalies, as native dbt tests. |
| 52 | +- **Automated monitors** - Out-of-the-box cloud monitors to detect freshness, volume and schema issues. |
| 53 | +- **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**. |
| 54 | +- **Data quality dashboard** - Single interface for all your data monitoring and test results. |
| 55 | +- **Models performance** - Monitor models and jobs run results and performance over time. |
| 56 | +- **Configuration-as-code** - Elementary configuration is managed in your dbt code. |
| 57 | +- **Alerts** - Actionable alerts including custom channels and tagging of owners. |
| 58 | +- **Data catalog** - Explore your datasets information - descriptions, columns, datasets health, etc. |
| 59 | +- **dbt artifacts uploader** - Save metadata and run results as part of your dbt runs. |
| 60 | +- **AI-Powered Data Tests & Unstructured Data Validations** - Validate and monitor data using AI powered tests to validate both structured and unstructured data |
71 | 61 |
|
72 | 62 | ## Support |
73 | 63 |
|
74 | | -For additional information and help, you can use one of these channels: |
| 64 | +For additional information and help: |
75 | 65 |
|
76 | | -- [Slack community](https://www.elementary-data.com/community) \(Release announcements, community support, discussions, etc.\) |
77 | | -- [GitHub issues](https://github.com/elementary-data/elementary/issues) \(Bug reports, feature requests) |
| 66 | +- [Join thousands of users in the Slack community](https://www.elementary-data.com/community) \(Release announcements, community and AI support, discussions, etc.\) |
| 67 | +- [Open a GitHub issue](https://github.com/elementary-data/elementary/issues) \(Bug reports, feature requests) |
78 | 68 | - Check out the [contributions guide](./CONTRIBUTING.md) and [open issues](https://github.com/elementary-data/elementary/issues). |
79 | 69 |
|
80 | 70 | ## |
|
0 commit comments