Skip to content

Commit 573bc31

Browse files
RounakDhillon“Rounak
RounakDhillon
and
“Rounak
authored
Docsv1 Content Updation (#60)
* Docs: Docsv1 Great Expectation changes * Docs: Docsv1 Salesforce Change * Docs: Docsv1 Metabase note updation * Docs: Docsv1 Code Runner Documentation addition * Docs: Docsv1 Alerts Doc Addition --------- Co-authored-by: “Rounak <“rounakpreet.d@deuexsolutions.com”>
1 parent 3e2b00e commit 573bc31

33 files changed

+3409
-133
lines changed

‎connectors/dashboard/metabase/index.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Configure and schedule Metabase metadata and profiler workflows from the OpenMet
2424
- [Lineage](#lineage)
2525
- [Troubleshooting](/connectors/dashboard/metabase/troubleshooting)
2626
## Requirements
27+
The service account must have view access to all dashboards and charts that need to be ingested. Without view access, the connector cannot retrieve those objects.
2728
**Note:** We have tested Metabase with Versions `0.42.4` and `0.43.4`.
2829
## Metadata Ingestion
2930
<MetadataIngestionUi connector={"Metabase"} selectServicePath={"/public/images/connectors/metabase/select-service.png"} addNewServicePath={"/public/images/connectors/metabase/add-new-service.png"} serviceConnectionPath={"/public/images/connectors/metabase/service-connection.png"} />

‎connectors/dashboard/metabase/yaml.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Configure and schedule Metabase metadata and profiler workflows from the OpenMet
2727
- [Metadata Ingestion](#metadata-ingestion)
2828
<ExternalIngestionDeployment />
2929
## Requirements
30+
The service account must have view access to all dashboards and charts that need to be ingested. Without view access, the connector cannot retrieve those objects.
3031
**Note:** We have tested Metabase with Versions `0.42.4` and `0.43.4`.
3132
### Python Requirements
3233
<PythonRequirements />

‎docs.json‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1170,7 +1170,18 @@
11701170
"how-to-guides/data-quality-observability/quality/configure",
11711171
"how-to-guides/data-quality-observability/quality/tests-yaml",
11721172
"how-to-guides/data-quality-observability/quality/tests-ui",
1173-
"how-to-guides/data-quality-observability/quality/custom-tests"
1173+
"how-to-guides/data-quality-observability/quality/custom-tests",
1174+
{
1175+
"group": "Data Quality as Code",
1176+
"pages": [
1177+
"how-to-guides/data-quality-observability/quality/data-quality-as-code/index",
1178+
"how-to-guides/data-quality-observability/quality/data-quality-as-code/getting-started",
1179+
"how-to-guides/data-quality-observability/quality/data-quality-as-code/test-runner",
1180+
"how-to-guides/data-quality-observability/quality/data-quality-as-code/dataframe-validation",
1181+
"how-to-guides/data-quality-observability/quality/data-quality-as-code/test-definitions",
1182+
"how-to-guides/data-quality-observability/quality/data-quality-as-code/advanced-usage"
1183+
]
1184+
}
11741185
]
11751186
},
11761187
{
@@ -1208,6 +1219,19 @@
12081219
"how-to-guides/data-quality-observability/observability/webhooks"
12091220
]
12101221
},
1222+
{
1223+
"group": "Alerts & Notifications",
1224+
"pages": [
1225+
"how-to-guides/data-quality-observability/alerts-notifications/index",
1226+
"how-to-guides/data-quality-observability/alerts-notifications/data-observability-alerts",
1227+
"how-to-guides/data-quality-observability/alerts-notifications/system-governance-notifications",
1228+
"how-to-guides/data-quality-observability/alerts-notifications/email-alerts-configuration",
1229+
"how-to-guides/data-quality-observability/alerts-notifications/slack-alerts-configuration",
1230+
"how-to-guides/data-quality-observability/alerts-notifications/microsoft-teams-alerts-configuration",
1231+
"how-to-guides/data-quality-observability/alerts-notifications/google-chat-alerts-configuration",
1232+
"how-to-guides/data-quality-observability/alerts-notifications/generic-webhook-alerts-configuration"
1233+
]
1234+
},
12111235
{
12121236
"group": "Incident Manager",
12131237
"pages": [

‎how-to-guides/admin-guide/alerts.mdx‎

Lines changed: 0 additions & 132 deletions
This file was deleted.

‎how-to-guides/data-quality-observability/alerts-notifications/data-observability-alerts.mdx‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: Data Observability Alerts | Collate
3+
description: Configure alerts for data quality failures, schema changes, and pipeline issues.
4+
slug: /how-to-guides/data-quality-observability/alerts-notifications/data-observability-alerts
5+
sidebarTitle: Data Observability Alerts
6+
---
7+
8+
# Data Observability Alerts
9+
10+
Monitor the health of your data systems by setting up alerts for pipeline failures, data quality issues, and schema changes.
11+
12+
## Open the Alerts Page
13+
14+
Navigate to the lateral menu **Observability > Alerts**.
15+
16+
<img noZoom src="/public/images/how-to-guides/data-quality-observability/observability/alerts/data-observability-navigate-collate.webp" alt="Navigate to Observability Alerts" />
17+
18+
Click the **Add Alert** button.
19+
20+
<img noZoom src="/public/images/how-to-guides/data-quality-observability/observability/alerts/data-observability-add-alert.webp" alt="Add Alert Button" />
21+
22+
## Name the Alert and Add Context
23+
24+
Provide a unique, descriptive **Name** for your alert. You can also add an optional **Description** to provide further context and clarity regarding the alert's intent.
25+
26+
<img noZoom src="/public/images/how-to-guides/data-quality-observability/observability/alerts/data-observability-alert-name-description.webp" alt="Input fields for Alert Name and Description" />
27+
28+
## Select a Source
29+
30+
Choose the operational entity you want to monitor:
31+
32+
* **Container** - Monitors schema changes for the container asset
33+
* **Ingestion Pipeline** - Monitors status changes to your Collate ingestion pipelines
34+
* **Pipeline** - Monitors updates to pipeline assets that you have ingested
35+
* **Table** - Monitors schema changes and table metrics changes
36+
* **Test Case** - Triggers an alert for the specific test case selected
37+
* **Test Suite** - Triggers an alert for any test case event linked to the test suite. This is a great way to group alerts and reduce notification fatigue
38+
* **Topic** - Monitors schema changes for the topic asset
39+
40+
<img noZoom src="/public/images/how-to-guides/data-quality-observability/observability/alerts/data-observability-source-collate.webp" alt="Select the Source Resource for Data Observability" />
41+
42+
## Configure Filters (Optional)
43+
44+
Filters allow you to refine the scope of the alert to focus only on relevant changes, significantly improving the signal-to-noise ratio. You can narrow down events based on a variety of criteria, including:
45+
46+
* **Entity Specific Name:** Filter by the defined specific name of the entity.
47+
* **Owner Name:** Filter events based on the designated owner of the asset.
48+
* **Domain:** Filter events based on the Data Domain the entity belongs to.
49+
* **Filter By Updater Is Bot:** Filter to include or exclude changes made by automated ingestion or system processes.
50+
51+
Use the **Include** toggle to define the logic for the filter condition:
52+
* **Include (Toggle ON):** If the event meets the filter condition, the alert is **sent**.
53+
* **Exclude (Toggle OFF):** If the event meets the filter condition, the alert is **silenced** (not sent).
54+
55+
<Note>
56+
If you do not set any filter, the alert will apply to **all** relevant events over the selected source entity type, which may lead to excessive notifications.
57+
</Note>
58+
59+
<img noZoom src="/public/images/how-to-guides/data-quality-observability/observability/alerts/data-observability-filter-overview.webp" alt="Define Filters" />
60+
<img noZoom src="/public/images/how-to-guides/data-quality-observability/observability/alerts/data-observability-filter-options.webp" alt="Filter Options" />
61+
62+
63+
## Select Trigger Conditions (Optional)
64+
65+
Define the specific conditions that will trigger the alert:
66+
67+
* **Schema Changes** - Alert on added, deleted, or updated columns
68+
* **Test Case Status** - Trigger when tests are `Failed`, `Aborted`, or `Queued`
69+
* **Pipeline Status** - Alert when pipeline execution is `Failed` or `Pending`
70+
* **Metric Updates** - Notify when table metrics are updated
71+
72+
<Tip>
73+
You can select multiple trigger conditions to create comprehensive monitoring coverage.
74+
</Tip>
75+
76+
<img noZoom src="/public/images/how-to-guides/admin-guide/trigger.webp" alt="Select Trigger Conditions" />
77+
78+
Choose where to send your alerts. Collate supports both internal and external channels.
79+
80+
**Internal Destinations:**
81+
* **Admins** - Notify all platform administrators
82+
* **Followers** - Notify users following the asset
83+
* **Owners** - Alert the asset owners
84+
* **Teams or Specific Users** - Target specific teams or individuals
85+
86+
**External Destinations:**
87+
* **Email**
88+
* **Chat**: Slack, MS Teams, Google Chat
89+
* **Automation**: Generic Webhooks
90+
91+
<img noZoom src="/public/images/how-to-guides/admin-guide/internal.webp" alt="Internal Destinations" />
92+
93+
<img noZoom src="/public/images/how-to-guides/admin-guide/external.webp" alt="External Destinations" />

0 commit comments

Comments
 (0)