| 1 | # yamllint disable rule:line-length |
| 2 | --- |
| 3 | - id: 'notify-slack' |
| 4 | meta: |
| 5 | name: 'Slack' |
| 6 | link: 'https://slack.com/' |
| 7 | categories: |
| 8 | - notify.agent |
| 9 | icon_filename: 'slack.png' |
| 10 | keywords: |
| 11 | - Slack |
| 12 | overview: |
| 13 | notification_description: | |
| 14 | Send notifications to a Slack workspace using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. |
| 15 | notification_limitations: '' |
| 16 | setup: |
| 17 | prerequisites: |
| 18 | list: |
| 19 | - title: '' |
| 20 | description: | |
| 21 | - Slack app along with an incoming webhook, read Slack's guide on the topic [here](https://api.slack.com/messaging/webhooks). |
| 22 | - One or more channels to post the messages to |
| 23 | - Access to the terminal where Netdata Agent is running |
| 24 | configuration: |
| 25 | file: |
| 26 | name: 'health_alarm_notify.conf' |
| 27 | options: |
| 28 | description: 'The following options can be defined for this notification' |
| 29 | folding: |
| 30 | title: 'Config Options' |
| 31 | enabled: true |
| 32 | list: |
| 33 | - name: 'SEND_SLACK' |
| 34 | default_value: 'YES' |
| 35 | description: "Set `SEND_SLACK` to YES" |
| 36 | required: true |
| 37 | - name: 'SLACK_WEBHOOK_URL' |
| 38 | default_value: '' |
| 39 | description: "set `SLACK_WEBHOOK_URL` to your Slack app's webhook URL." |
| 40 | required: true |
| 41 | - name: 'DEFAULT_RECIPIENT_SLACK' |
| 42 | default_value: '' |
| 43 | description: "Set `DEFAULT_RECIPIENT_SLACK` to the Slack channel your Slack app is set to send messages to. The syntax for channels is `#channel` or `channel`." |
| 44 | required: true |
| 45 | examples: |
| 46 | folding: |
| 47 | enabled: true |
| 48 | title: '' |
| 49 | list: |
| 50 | - name: 'Basic Configuration' |
| 51 | folding: |
| 52 | enabled: false |
| 53 | description: '' |
| 54 | config: | |
| 55 | #------------------------------------------------------------------------------ |
| 56 | # slack (slack.com) global notification options |
| 57 | |
| 58 | SEND_SLACK="YES" |
| 59 | SLACK_WEBHOOK_URL="https://hooks.slack.com/services/XXXXXXXX/XXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" |
| 60 | DEFAULT_RECIPIENT_SLACK="#alarms" |
| 61 | troubleshooting: |
| 62 | problems: |
| 63 | list: [] |