diff --git a/docs/cloud/guides/alert-rules.mdx b/docs/cloud/guides/alert-rules.mdx new file mode 100644 index 000000000..3716c2893 --- /dev/null +++ b/docs/cloud/guides/alert-rules.mdx @@ -0,0 +1,35 @@ +--- +title: "Alert rules" +--- + +Elementary cloud allows you to create rules that route your alerts. +Each rule is a combination of a filter and a destination. + +The Slack channel you choose when connecting your Slack workspace is automatically added as a default alert rule, that sends all the alerts to that channel without any filtering. +To modify, deactivate or add more rules, simply navigate to the "Alert routing rules" page in the left menu. + +

+ +

+ Alert routing rules screen +
+ +

+ +

+ +

+ Create a new alert rule or edit an existing one +
+ +

+ + + When the alerts are fetched, each alert is evaluated against all the rules, + until a rule matches. The alert is then routed to the destination of the + matching rule, and no further rules are evaluated. This is why the order of + the rules matters! + diff --git a/docs/cloud/guides/alerts-configuration.mdx b/docs/cloud/guides/alerts-configuration.mdx index 6a2477cb5..fd4996dda 100644 --- a/docs/cloud/guides/alerts-configuration.mdx +++ b/docs/cloud/guides/alerts-configuration.mdx @@ -1,5 +1,5 @@ --- -title: "Alerts configuration" +title: "Alert configuration" --- diff --git a/docs/cloud/guides/enable-slack-alerts.mdx b/docs/cloud/guides/enable-slack-alerts.mdx index 98097273d..42429aa84 100644 --- a/docs/cloud/guides/enable-slack-alerts.mdx +++ b/docs/cloud/guides/enable-slack-alerts.mdx @@ -6,83 +6,10 @@ title: "Enable Slack alerts" -## Setup Slack Integration +## Connect Slack - - - First create a Slack app: +On the environment configuration in Elementary Cloud, click on the "Connect Slack" button. +After you approve the Elementary Cloud app, select the default Slack channel to which you'd like to send alerts, and the [suppression interval](https://docs.elementary-data.com/cloud/guides/alerts-configuration#suppression-interval). +Afterwards you will be redirected back to the environment configuration page. - - - ## 1. Create a Slack app - - Go to the [Slack page to create apps](https://api.slack.com/apps?new_app=1) and create a new app (from scratch). - Call it "[Elementary](#slack-app-display)" and connect it to the workspace of your choice. - - Slack app - - ## 2. Optional - Slack app display - - To change the display of the Elementary slack app, scroll down on the Slack app basic information page to the 'Display Information' section: - - Slack display - - Here is the Elementary icon for your use (click to download): - - - Elementary logo - - - - - - - After the app is ready, create a Slack Token: - - - -## 1. Create a Slack token - -Go to the "OAauth & Permissions" page for your newly-created app, and add the following scopes under "Bot Token Scopes": - -- `channels:join` - Join public channels in a workspace - - `channels:read` - View basic information about public channels in a workspace - - `chat:write` - Send messages as \ - - `files:write` - Upload, edit, and delete files as \ - - `users:read` - View people in a workspace - - `users:read.email` - View email addresses of people in a workspace - - `groups:read` - View basic information about private channels that your slack app has been added to - -Slack scopes - -## 2. Install app at your Workspace - -At the "OAuth & Permissions" page, press on "Install to Workspace" in order to generate Slack token: - -Slack OAuth - - - - - On the environment configuration in Elementary Cloud, add the Slack token and configure a default channel. - - + diff --git a/docs/mint.json b/docs/mint.json index 7c80775c8..5ed9f1463 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -228,7 +228,8 @@ "group": "Send Slack alerts", "pages": [ "cloud/guides/enable-slack-alerts", - "cloud/guides/alerts-configuration" + "cloud/guides/alerts-configuration", + "cloud/guides/alert-rules" ] }, "cloud/guides/sync-scheduling", diff --git a/docs/pics/cloud/alert_rules.png b/docs/pics/cloud/alert_rules.png new file mode 100644 index 000000000..7ad2ad59e Binary files /dev/null and b/docs/pics/cloud/alert_rules.png differ diff --git a/docs/pics/cloud/alert_rules_drawer.png b/docs/pics/cloud/alert_rules_drawer.png new file mode 100644 index 000000000..a521a21b4 Binary files /dev/null and b/docs/pics/cloud/alert_rules_drawer.png differ diff --git a/docs/pics/cloud/connect_slack.png b/docs/pics/cloud/connect_slack.png new file mode 100644 index 000000000..34a5463ea Binary files /dev/null and b/docs/pics/cloud/connect_slack.png differ