From 6168e7f95f40c6a66d308ce62c26aaa6b11193eb Mon Sep 17 00:00:00 2001 From: dmitryk-dk Date: Tue, 25 Apr 2023 12:42:20 +0300 Subject: [PATCH] app/vmctl: fix comments --- .../setup-notifications.md | 44 +++++++------------ 1 file changed, 17 insertions(+), 27 deletions(-) diff --git a/docs/managed-victoriametrics/setup-notifications.md b/docs/managed-victoriametrics/setup-notifications.md index fc3a1a0900..5d367615e8 100644 --- a/docs/managed-victoriametrics/setup-notifications.md +++ b/docs/managed-victoriametrics/setup-notifications.md @@ -12,29 +12,29 @@ menu: The guide covers how to enable email and Slack notifications. Table of content: -1. [Setup slack channels](#setup-slack-channels) -2. [Setup emails](#setup-emails) +1. [Setup Slack notifications](#setup-slack-notifications) +2. [Setup emails notifications](#setup-emails-notifications) 3. [Send test notification](#send-test-notification) -When you entered to the notification section you will be able to fill in the channels in which you +When you enter the notification section, you will be able to fill in the channels in which you want to receive notifications

-## Setup slack channels +## Setup Slack notifications -To send alerts to Slack, it is required to set up a webhook. How to do this is indicated on the following -link https://api.slack.com/messaging/webhooks - -When webhook enabled correctly the next step is fill channels and webhook fields in the managed-victoriametrics. +1. Setup Slack webhook +How to do this is indicated on the following link https://api.slack.com/messaging/webhooks

-If you want to set slack channels just enter one or more channels into input and press enter or choose it after each input. +2. Specify Slack channels + +Enter one or more channels into input and press enter or choose it after each input.

@@ -44,16 +44,10 @@ If you want to set slack channels just enter one or more channels into input and

-If you want to delete it simply press cross on entered element. +## Setup emails notifications -

- -

- -## Setup emails - -If you want to set emails just enter one or more email into input and press enter or choose it after each input. -By default, account holder will be present in the email field. +You can specify one or multiple emails for notifications in the input field. By default, +email notifications are enabled for the account owner

@@ -63,17 +57,13 @@ By default, account holder will be present in the email field.

-If you want to delete it simply press cross on entered element. - -

- -

- ## Send test notification -When all fields are filled in correctly, all entered information should be saved. +To test your notification settings, press Save and Test. -Press Save or Save and Test button. +If only Slack channels and webhook are specified correctly, you will receive the notification in the Slack channels. +If only the emails are specified сщккуседн, you will receive notifications to those emails. +When both notifications are specified, all notifications will be sent to Slack channels and emails.

@@ -92,7 +82,7 @@ and test notifications will be sent to the entered channels

-All test notifications will be sent to the defined channels. +Examples of the test notification messages: