Skip to content

Commit 0078f27

Browse files
committed
docs: add --slack-full-width documentation
Add docs for the new --slack-full-width CLI flag that enables full-width Slack alerts with Markdown test result tables. Made-with: Cursor
1 parent 273ac06 commit 0078f27

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

docs/oss/deployment-and-configuration/slack.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,15 @@ The alert format is:
5757
```
5858

5959
---
60+
61+
## Full-width alerts
62+
63+
By default, Slack alerts use a narrower layout with some content in attachments. To use the full message width and show test results as a Markdown table in the main message body, pass the flag when running the monitor:
64+
65+
```shell
66+
edr monitor --slack-token <your_slack_token> --slack-channel-name <channel> --slack-full-width
67+
```
68+
69+
With `--slack-full-width`, alerts are sent using Slack Block Kit in the main message body instead of attachments, so the full channel width is used and test result samples appear as formatted Markdown tables.
70+
71+
---

docs/oss/guides/alerts/send-slack-alerts.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ Make sure to run the following command after your dbt runs and tests:
2828
edr monitor --slack-token <your_slack_token> --slack-channel-name <slack_channel_to_post_at> --group-by [table | alert]
2929
```
3030

31+
Add `--slack-full-width` to use the full message width and show test results as Markdown tables. See [Slack setup - Full-width alerts](/oss/deployment-and-configuration/slack#full-width-alerts).
32+
3133
Or just `edr monitor` if you used `config.yml`. Please note that when you specify the --slack-channel-name, it's the
3234
default channel name to which all the alerts will be sent that are not attributed to any custom channel. Therefore,
3335
if you execute several `edr monitor` commands at the same time with different `slack-channel-name` arguments, they can

0 commit comments

Comments
 (0)