diff --git a/docs/managed-victoriametrics/README.md b/docs/managed-victoriametrics/README.md index 15fb34f1b3..26dbf11bc7 100644 --- a/docs/managed-victoriametrics/README.md +++ b/docs/managed-victoriametrics/README.md @@ -14,6 +14,7 @@ Guides: * [Quick Start](/managed-victoriametrics/quickstart.html) * [Kubernetes Monitoring with Managed VictoriaMetrics](/managed-victoriametrics/how-to-monitor-k8s.html) * [Understand Your Setup Size](/guides/understand-your-setup-size.html) +* [Setup Notifications](/managed-victoriametrics/setup-notifications.html) See more about Managed VictoriaMetrics in the following articles: diff --git a/docs/managed-victoriametrics/notifications-buttons.png b/docs/managed-victoriametrics/notifications-buttons.png new file mode 100644 index 0000000000..3d3a15f9f8 Binary files /dev/null and b/docs/managed-victoriametrics/notifications-buttons.png differ diff --git a/docs/managed-victoriametrics/notifications-email-test.png b/docs/managed-victoriametrics/notifications-email-test.png new file mode 100644 index 0000000000..d9e8ba5b47 Binary files /dev/null and b/docs/managed-victoriametrics/notifications-email-test.png differ diff --git a/docs/managed-victoriametrics/notifications-emails-delete.png b/docs/managed-victoriametrics/notifications-emails-delete.png new file mode 100644 index 0000000000..8296fff37c Binary files /dev/null and b/docs/managed-victoriametrics/notifications-emails-delete.png differ diff --git a/docs/managed-victoriametrics/notifications-emails-filled.png b/docs/managed-victoriametrics/notifications-emails-filled.png new file mode 100644 index 0000000000..f496125f65 Binary files /dev/null and b/docs/managed-victoriametrics/notifications-emails-filled.png differ diff --git a/docs/managed-victoriametrics/notifications-emails.png b/docs/managed-victoriametrics/notifications-emails.png new file mode 100644 index 0000000000..76bf14531e Binary files /dev/null and b/docs/managed-victoriametrics/notifications-emails.png differ diff --git a/docs/managed-victoriametrics/notifications-save-and-test.png b/docs/managed-victoriametrics/notifications-save-and-test.png new file mode 100644 index 0000000000..b8686ca3c3 Binary files /dev/null and b/docs/managed-victoriametrics/notifications-save-and-test.png differ diff --git a/docs/managed-victoriametrics/notifications-saved-successfully.png b/docs/managed-victoriametrics/notifications-saved-successfully.png new file mode 100644 index 0000000000..1ff2fcc1ca Binary files /dev/null and b/docs/managed-victoriametrics/notifications-saved-successfully.png differ diff --git a/docs/managed-victoriametrics/notifications-slack-channel.png b/docs/managed-victoriametrics/notifications-slack-channel.png new file mode 100644 index 0000000000..a63e36bfbe Binary files /dev/null and b/docs/managed-victoriametrics/notifications-slack-channel.png differ diff --git a/docs/managed-victoriametrics/notifications-slack-channels-delete.png b/docs/managed-victoriametrics/notifications-slack-channels-delete.png new file mode 100644 index 0000000000..db7a1a517a Binary files /dev/null and b/docs/managed-victoriametrics/notifications-slack-channels-delete.png differ diff --git a/docs/managed-victoriametrics/notifications-slack-channels-webhook.png b/docs/managed-victoriametrics/notifications-slack-channels-webhook.png new file mode 100644 index 0000000000..6250046e39 Binary files /dev/null and b/docs/managed-victoriametrics/notifications-slack-channels-webhook.png differ diff --git a/docs/managed-victoriametrics/notifications-slack-channels.png b/docs/managed-victoriametrics/notifications-slack-channels.png new file mode 100644 index 0000000000..305c74d40e Binary files /dev/null and b/docs/managed-victoriametrics/notifications-slack-channels.png differ diff --git a/docs/managed-victoriametrics/notifications-slack-test.png b/docs/managed-victoriametrics/notifications-slack-test.png new file mode 100644 index 0000000000..d4c013a460 Binary files /dev/null and b/docs/managed-victoriametrics/notifications-slack-test.png differ diff --git a/docs/managed-victoriametrics/notifications-start.png b/docs/managed-victoriametrics/notifications-start.png new file mode 100644 index 0000000000..42df62e696 Binary files /dev/null and b/docs/managed-victoriametrics/notifications-start.png differ diff --git a/docs/managed-victoriametrics/setup-notifications.md b/docs/managed-victoriametrics/setup-notifications.md new file mode 100644 index 0000000000..ad052be9d5 --- /dev/null +++ b/docs/managed-victoriametrics/setup-notifications.md @@ -0,0 +1,104 @@ +--- +sort: 6 +weight: 6 +title: Notifications in Managed VictoriaMetrics +menu: + docs: + parent: "managed" + weight: 6 +--- +# Notifications in Managed VictoriaMetrics + +This section add ability to setup channels for sending alerting notifications. + +The document covers the following topics +1. [Setup slack channels](#setup-slack-channels) +2. [Setup emails](#setup-emails) +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 +want to receive notifications + +

+ +

+ +## Setup slack channels + +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. + +

+ +

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

+ +

+ +

+ +

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

+ +

+ +## 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. + +

+ +

+ +

+ +

+ +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. + +Press Save or Save and Test button. + +

+ +

+ +If the Save button is pressed, then entered channels will be only saved, and you get a success message. + +

+ +

+ +If the Save and Test button is pressed, then all entered information will be saved, +and test notifications will be sent to the entered channels + +

+ +

+ +All test notifications will be sent to the defined channels. + +

+ +

+ +

+ +

+