ContextQMD
Back to Netdata

Slack

src/health/notifications/slack/README.md

2.10.33.0 KB
Original Source
<!--startmeta custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/health/notifications/slack/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/health/notifications/slack/metadata.yaml" sidebar_label: "Slack" learn_status: "Published" learn_rel_path: "Alerts & Notifications/Notifications/Agent Dispatched Notifications" keywords: ['Slack'] message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE" endmeta-->

Slack

Send notifications to a Slack workspace using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.

Setup

Prerequisites

  • Slack app along with an incoming webhook, read Slack's guide on the topic here.
  • One or more channels to post the messages to
  • Access to the terminal where Netdata Agent is running

Configuration

Options

The following options can be defined for this notification

<details open><summary>Config Options</summary>
OptionDescriptionDefaultRequired
SEND_SLACKSet SEND_SLACK to YESYESyes
SLACK_WEBHOOK_URLset SLACK_WEBHOOK_URL to your Slack app's webhook URL.yes
DEFAULT_RECIPIENT_SLACKSet DEFAULT_RECIPIENT_SLACK to the Slack channel your Slack app is set to send messages to. The syntax for channels is #channel or channel.yes
</details>

via File

The configuration file name for this integration is health_alarm_notify.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config health_alarm_notify.conf
Examples
Basic Configuration
yaml
#------------------------------------------------------------------------------
# slack (slack.com) global notification options

SEND_SLACK="YES"
SLACK_WEBHOOK_URL="https://hooks.slack.com/services/XXXXXXXX/XXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" 
DEFAULT_RECIPIENT_SLACK="#alarms"

Troubleshooting

Test Notification

You can run the following command by hand, to test alerts configuration:

bash
# become user netdata
sudo su -s /bin/bash netdata

# enable debugging info on the console
export NETDATA_ALARM_NOTIFY_DEBUG=1

# send test alarms to sysadmin
/usr/libexec/netdata/plugins.d/alarm-notify.sh test

# send test alarms to any role
/usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE"

Note that this will test all alert mechanisms for the selected role.