Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix broken links and more stuff #1410

Merged
merged 2 commits into from
Feb 14, 2024
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
34 changes: 17 additions & 17 deletions docs/_snippets/guides/alerts-code-configuration.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
You can enrich your alerts by adding properties to tests, models and sources in your `.yml` files.
The supported attributes are: [owner](./alerts-configuration/#owner),
[subscribers](./alerts-configuration#subscribers),
[description](./alerts-configuration#test-description),
[tags](./alerts-configuration#tags).
The supported attributes are: [owner](./alerts-code-configuration/#owner),
[subscribers](./alerts-code-configuration#subscribers),
[description](./alerts-code-configuration#test-description),
[tags](./alerts-code-configuration#tags).

You can configure and customize your alerts by configuring:
[custom channel](./alerts-configuration#custom-channel),
[suppression interval](./alerts-configuration#suppression_interval),
[alert fields](./alerts-configuration#alert_fields)(for test alerts only), [alert grouping](./alerts-configuration#group-alerts-by-table),
[alert filters](./alerts-configuration#filter-alerts).
[custom channel](./alerts-code-configuration#custom-channel),
[suppression interval](./alerts-code-configuration#suppression_interval),
[alert fields](./alerts-code-configuration#alert_fields)(for test alerts only), [alert grouping](./alerts-code-configuration#group-alerts-by-table),
[alert filters](./alerts-code-configuration#filter-alerts).

## Alert properties in `.yml` files

Expand All @@ -30,14 +30,14 @@ Elementary prioritizes configuration in the following order:
<pre>
<code>
meta:
&nbsp;&nbsp;<a href="./alerts-configuration#owner"><font color="#CD7D55">owner: "@jessica.jones"</font></a>
&nbsp;&nbsp;<a href="./alerts-configuration#subscribers"><font color="#CD7D55">subscribers: ["@jessica.jones", "@joe.joseph"]</font></a>
&nbsp;&nbsp;<a href="./alerts-configuration#test-description"><font color="#CD7D55">description: "This is the test description"</font></a>
&nbsp;&nbsp;<a href="./alerts-configuration#tags"><font color="#CD7D55">tags: ["#marketing", "#data_ops"]</font></a>
&nbsp;&nbsp;<a href="./alerts-configuration#custom-channel"><font color="#CD7D55">channel: data_ops</font></a>
&nbsp;&nbsp;<a href="./alerts-configuration#suppression-interval"><font color="#CD7D55">alert_suppression_interval: 24</font></a>
&nbsp;&nbsp;<a href="./alerts-configuration#group-alerts-by-table"><font color="#CD7D55">slack_group_alerts_by: table</font></a>
&nbsp;&nbsp;<a href="./alerts-configuration#alert-fields"><font color="#CD7D55">alert_fields: ["description", "owners", "tags", "subscribers", ...]</font></a>
&nbsp;&nbsp;<a href="./alerts-code-configuration#owner"><font color="#CD7D55">owner: "@jessica.jones"</font></a>
&nbsp;&nbsp;<a href="./alerts-code-configuration#subscribers"><font color="#CD7D55">subscribers: ["@jessica.jones", "@joe.joseph"]</font></a>
&nbsp;&nbsp;<a href="./alerts-code-configuration#test-description"><font color="#CD7D55">description: "This is the test description"</font></a>
&nbsp;&nbsp;<a href="./alerts-code-configuration#tags"><font color="#CD7D55">tags: ["#marketing", "#data_ops"]</font></a>
&nbsp;&nbsp;<a href="./alerts-code-configuration#custom-channel"><font color="#CD7D55">channel: data_ops</font></a>
&nbsp;&nbsp;<a href="./alerts-code-configuration#suppression-interval"><font color="#CD7D55">alert_suppression_interval: 24</font></a>
&nbsp;&nbsp;<a href="./alerts-code-configuration#group-alerts-by-table"><font color="#CD7D55">slack_group_alerts_by: table</font></a>
&nbsp;&nbsp;<a href="./alerts-code-configuration#alert-fields"><font color="#CD7D55">alert_fields: ["description", "owners", "tags", "subscribers", ...]</font></a>
</code>
</pre>

Expand Down Expand Up @@ -434,7 +434,7 @@ You can choose to enable / disable alert types by adding a var to your `dbt_proj

<Warning>
Vars will be deprecated soon! For OSS users, we recommend filtering the alerts
using [CLI selectors](/oss/guides/alerts-configuration#alerts-cli-flags)
using [CLI selectors](/oss/guides/alerts/alerts-configuration#alerts-cli-flags)
instead.
</Warning>

Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/products-cards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Read about the key features and product offerings:
title="Key Features"
icon="stars"
iconType="solid"
href="../../key-features"
href="/key-features"
></Card>
<Card
title="Elementary Cloud"
Expand Down
4 changes: 2 additions & 2 deletions docs/features/elementary-alerts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ icon: "bell-exclamation"
<Card title="Activate alerts in Cloud" icon="cloud" iconType="solid" href="/cloud/guides/enable-slack-alerts">
Signup to cloud, and activate the Slack integration.
</Card>
<Card title="Setup alerts in OSS" icon="square-terminal" iconType="solid" href="/oss/guides/send-slack-alerts">
<Card title="Setup alerts in OSS" icon="square-terminal" iconType="solid" href="/oss/guides/alerts/elementary-alerts">
Install the CLI tool, and configure a profile. Use the `edr monitor` command to send alerts.
If you want continuous alerting, you will need to orchestrate the CLI.
</Card>
Expand All @@ -27,7 +27,7 @@ icon: "bell-exclamation"
<Card title="Alerts configuration in Cloud" icon="cloud" iconType="solid" href="/cloud/guides/alert-rules">
Use Alert Rules to distribute your alerts to the right channels.
</Card>
<Card title="Alerts configuration in OSS" icon="square-terminal" iconType="solid" href="/oss/guides/alerts-configuration">
<Card title="Alerts configuration in OSS" icon="square-terminal" iconType="solid" href="/oss/guides/alerts/alerts-configuration">
All alerts configuration is as code in your project YML files.
</Card>
</CardGroup>
4 changes: 2 additions & 2 deletions docs/oss/cli-commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Here is a list of all the available options:

- **Select:**
Filter the alerts / report using a selector.
- See all of the alerts supported selector methods [here](/oss/guides/alerts-configuration#alerts-cli-flags).
- See all of the alerts supported selector methods [here](/oss/guides/alerts/alerts-configuration#alerts-cli-flags).
- See all of the report supported selector methods [here](/oss/guides/generate-report-ui#generating-a-report-for-single-invocation).

```shell
Expand Down Expand Up @@ -195,7 +195,7 @@ Here is a list of all the available options:

- **Suppression interval:**
Suppress similar alerts for a given number of hours.
[Read more about this setting here.](/oss/guides/alerts-configuration#suppression-interval-flag)
[Read more about this setting here.](/oss/guides/alerts/alerts-configuration#suppression-interval-flag)
The default suppression interval is 0.

```shell
Expand Down
2 changes: 1 addition & 1 deletion docs/oss/deployment-and-configuration/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Slack setup for Elementary CLI"
sidebarTitle: "Slack"
---

Elementary Slack integration includes sending [Slack alerts](/oss/guides/send-slack-alerts) on failures in dbt tests and models, and the option to distribute the [data observability report](/oss/guides/generate-report-ui) as a message attachment.
Elementary Slack integration includes sending [Slack alerts](/oss/guides/alerts/send-slack-alerts) on failures in dbt tests and models, and the option to distribute the [data observability report](/oss/guides/generate-report-ui) as a message attachment.

## Token vs Webhook

Expand Down
2 changes: 1 addition & 1 deletion docs/oss/deployment-and-configuration/teams.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Teams setup for Elementary CLI"
sidebarTitle: "Teams"
---

Elementary Teams integration includes sending [Teams alerts](/oss/guides/send-teams-alerts) on failures in dbt tests and models.
Elementary Teams integration includes sending [Teams alerts](/oss/guides/alerts/send-teams-alerts) on failures in dbt tests and models.

## Integration options

Expand Down
2 changes: 1 addition & 1 deletion docs/oss/guides/alerts/elementary-alerts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ title: "Elementary alerts"
<Card
title="Setup alerts on MS Teams"
iconType="solid"
href="oss/quickstart/quickstart-cli-package"
href="/oss/guides/alerts/send-teams-alerts"
>
<br />
<img
Expand Down
2 changes: 1 addition & 1 deletion docs/oss/guides/alerts/send-slack-alerts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Or just `edr monitor` if you used `config.yml`. Please note that when you specif
default channel name to which all the alerts will be sent that are not attributed to any custom channel. Therefore,
if you execute several `edr monitor` commands at the same time with different `slack-channel-name` arguments, they can
be sent to the wrong one due to the overlap accessing the backend table of elementary. For avoiding this problem,
[the guide](/oss/guides/alerts-configuration#custom-channel) can be followed.
[the guide](/oss/guides/alerts/alerts-configuration#custom-channel) can be followed.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/oss/quickstart/quickstart-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ Before installing the CLI, make sure to complete the steps dbt package installat

1. Use the CLI to:
- [Visualize all dbt test results and runs in a report](/oss/guides/generate-report-ui) ✨
- [Send informative Slack alerts](/oss/guides/send-slack-alerts) 📣
- [Send informative alerts on failures](/oss/guides/alerts/elementary-alerts) 📣
2. [Add data anomaly detection dbt tests](/data-tests/add-elementary-tests) 📈
3. [Deploy Elementary in production](/oss/deployment-and-configuration/elementary-in-production) 🚀
2 changes: 1 addition & 1 deletion docs/release-notes/releases/0.5.4.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ _November 3, 2022: [v0.5.4 Python](https://github.com/elementary-data/elementary
- **Source freshness alerts** 🥬🔔

- Elementary now provides alerts for all dbt operations, including source freshness!
- Here are [the docs](/oss/guides/send-slack-alerts#alert-on-source-freshness-failures).
- Here are [the docs](/oss/guides/alerts/elementary-alerts#alert-on-source-freshness-failures).

- **Artifacts are uploaded at on-run-end hooks** ⚡️

Expand Down
4 changes: 2 additions & 2 deletions docs/release-notes/releases/0.6.3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ _December 21, 2022: [v0.6.3 Python](https://github.com/elementary-data/elementar
- **Slack alerts V2** 2️⃣

- **Elementary now supports customizing alerts, so you could notify data producers and consumers** 🧑‍🔧
- Instead of sending detailed technical alerts, you can select fields. Learn more here [how to configure it](/oss/guides/send-slack-alerts#customize-alerts-owners-test-descriptions-tags-subscribers-and-layout).
- Instead of sending detailed technical alerts, you can select fields. Learn more here [how to configure it](/oss/guides/alerts/elementary-alerts#customize-alerts-owners-test-descriptions-tags-subscribers-and-layout).
- Email owners will be translated to Slack handles in the alerts. Thanks [Josh Elston-Green](https://github.com/jelstongreen) for contributing.
- Alerts also underwent **layout improvements** 🎨

- **New data tests** 🩺

- [Advanced schema tests](/data-tests/add-schema-tests), **useful for source monitoring and enforcing data contracts:** ✅
- [Advanced schema tests](/data-tests/schema-tests/schema-changes), **useful for source monitoring and enforcing data contracts:** ✅
- `schema_changes_from_baseline` - Define a schema in your `models/<properties.yml>` and ensure its validity.
- `json_schema` - Validate the schema of JSON columns. 😱
- To ease configuration and implementation - both tests include operations to **auto-generate the schema.**
Expand Down
4 changes: 2 additions & 2 deletions docs/release-notes/releases/0.6.5.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ _January 10, 2023: [v0.6.5 Python](https://github.com/elementary-data/elementary
- **Alerts suppression** 💤🔕
- Don't want to get multiple alerts if the same test keeps failing?
- You can now configure an alert_suppression_interval, this is a "snooze" period for alerts on the same issue.
- [Docs here](/oss/guides/send-slack-alerts#customize-alerts-owners-test-descriptions-tags-subscribers-layout-and-suppression)
- [Docs here](/oss/guides/alerts/elementary-alerts#customize-alerts-owners-test-descriptions-tags-subscribers-layout-and-suppression)
- **Alerts filtering using selectors** 🔘

- You can now configure edr to send only selected alerts, using tags, owners or models selectors.
- This enables you to send only the alerts you actually care about.
- [Docs here](/oss/guides/send-slack-alerts#execute-the-cli)
- [Docs here](/oss/guides/alerts/elementary-alerts#execute-the-cli)

- **Generate report for a single invocation** 1️⃣
- Use selectors to generate a pre-filtered report with the results you want to see.
Expand Down
4 changes: 2 additions & 2 deletions docs/release-notes/releases/0.6.7.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ _January 19, 2023: [v0.6.7 Python](https://github.com/elementary-data/elementary

- **Postgres integration** 🆕
- Elementary now supports Postgres! Thank you [Tasos Kouridis](https://github.com/kouridis) for this meaningful contribution!
- [Docs here](/integrations/postgres)
- [Docs here](oss/integrations/postgres)
- **Freshness anomalies monitoring improvements** 🥬
- We have split our freshness anomalies test into two different tests to better handle two common different use cases:
- `freshness_anomalies` - monitors anomalies in the frequency of updates. Imagine a table that is being updated hourly and then all of a sudden this table wasn't updated for 4 hours. Here you would probably use the `updated_at`/`inserted_at` column as an input for this test.
- `event_freshness_anomalies` - monitors that the underlying data is up to date. Imagine an events table that is being updated hourly correctly but the events themselves are coming with a delay of 2 days from your production databases. Here, you would probably use the `event_timestamp` column as an input for this test.
- [Docs here](guides/add-elementary-tests#table-model-source-tests)
- [Docs here](data-tests/anomaly-detection-tests/freshness-anomalies)

### 💫 More changes

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/releases/0.7.2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ _February 16, 2023: [v0.7.2 Python](https://github.com/elementary-data/elementar

- When you generate a new report and using `send-report`, you can also trigger a Slack notification summary of the report.
- This is useful for you and your team members to understand quickly if there is something in the new report you should address.
- [Docs here](/quickstart/share-report-ui#slack-summary-configurations), screen shot attached 📸
- [Docs here](/oss/guides/share-report-ui#slack-summary-configurations), screen shot attached 📸

- **Dashboard graphs are now clickable** #️⃣📊

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/releases/0.7.5.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ _March 6, 2023: [v0.7.5 Python](https://github.com/elementary-data/elementary/re

- Feeling overwhelmed by alerts on each failed test?
- You can now add `-group-by table` to `edr monitor` and the table test results will be sent as one message.
- Docs are [here](/oss/guides/send-slack-alerts#notification-settings-decide-how-you-want-to-get-your-alerts) ; Pic attached 📸
- Docs are [here](/oss/guides/alerts/elementary-alerts#notification-settings-decide-how-you-want-to-get-your-alerts) ; Pic attached 📸
- This was requested by [@Jake Beresford](https://elementary-community.slack.com/team/U03BN2E93SQ) and [@Ekaterina Khrushch](https://elementary-community.slack.com/team/U03PVN83DC2)

- **Add `sum` to column anomaly tests** ➕
Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/releases/0.9.1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ _July 20, 2023: [v0.9.1 Python](https://github.com/elementary-data/elementary/re
- **Alert Suppression in CLI** 🚦
- Now, you can suppress alerts in the Command Line Interface (CLI) using the --suppression-interval flag.
- This feature gives you more control over your alerts and helps you manage notifications effectively.
- Check out the [docs](https://docs.elementary-data.com/oss/guides/send-slack-alerts)
- Check out the [docs](https://docs.elementary-data.com)

### 💫 More changes

Expand Down
2 changes: 1 addition & 1 deletion docs/x_old/understand-elementary/elementary-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Monitor the operations of your dbt easily. Collect dbt artifacts, run and test r

The dbt artifacts uploader is included in the [dbt package](/guides/modules-overview/dbt-package).

## [Slack alerts](/oss/guides/send-slack-alerts)
## [Failure alerts](/oss/guides/alerts/elementary-alerts)

Get notifications on data issues, schema changes, jobs and tests failures. Alerts are enriched with data from your dbt projects, such as owners, tags, results sample and test query.

Expand Down
Loading