blob: f644b93e1d993cf7495fe4c3b7759f670cc5f7fa (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# yamllint disable rule:line-length
---
- id: 'notify-rocketchat'
meta:
name: 'RocketChat'
link: 'https://rocket.chat/'
categories:
- notify.agent
icon_filename: 'rocketchat.png'
keywords:
- RocketChat
overview:
notification_description: |
Send notifications to Rocket.Chat using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
notification_limitations: ''
setup:
prerequisites:
list:
- title: ''
description: |
- The incoming webhook URL as given by RocketChat. You can use the same on all your Netdata servers (or you can have multiple if you like - your decision).
- One or more channels to post the messages to
- Access to the terminal where Netdata Agent is running
configuration:
file:
name: 'health_alarm_notify.conf'
options:
description: 'The following options can be defined for this notification'
folding:
title: 'Config Options'
enabled: true
list:
- name: 'SEND_ROCKETCHAT'
default_value: 'YES'
description: "Set `SEND_ROCKETCHAT` to `YES`"
required: true
- name: 'ROCKETCHAT_WEBHOOK_URL'
default_value: ''
description: "set `ROCKETCHAT_WEBHOOK_URL` to your webhook URL."
required: true
- name: 'DEFAULT_RECIPIENT_ROCKETCHAT'
default_value: ''
description: "Set `DEFAULT_RECIPIENT_ROCKETCHAT` to the channel you want the alert notifications to be sent to. You can define multiple channels like this: `alerts` `systems`."
required: true
detailed_description: |
All roles will default to this variable if left unconfigured.
The `DEFAULT_RECIPIENT_ROCKETCHAT` can be edited in the following entries at the bottom of the same file:
```conf
role_recipients_rocketchat[sysadmin]="systems"
role_recipients_rocketchat[domainadmin]="domains"
role_recipients_rocketchat[dba]="databases systems"
role_recipients_rocketchat[webmaster]="marketing development"
role_recipients_rocketchat[proxyadmin]="proxy_admin"
role_recipients_rocketchat[sitemgr]="sites"
```
examples:
folding:
enabled: true
title: ''
list:
- name: 'Basic Configuration'
folding:
enabled: false
description: ''
config: |
#------------------------------------------------------------------------------
# rocketchat (rocket.chat) global notification options
SEND_ROCKETCHAT="YES"
ROCKETCHAT_WEBHOOK_URL="<your_incoming_webhook_url>"
DEFAULT_RECIPIENT_ROCKETCHAT="monitoring_alarms"
troubleshooting:
problems:
list: []
|