blob: a97cdc71286d7e6ccf151fc0623f9e5cdafdd078 (
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
76
77
78
79
|
# yamllint disable rule:line-length
---
- id: 'notify-messagebird'
meta:
name: 'MessageBird'
link: 'https://messagebird.com/'
categories:
- notify.agent
icon_filename: 'messagebird.svg'
keywords:
- MessageBird
overview:
notification_description: |
Send notifications to MessageBird using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
notification_limitations: ''
setup:
prerequisites:
list:
- title: ''
description: |
- An access key under 'API ACCESS (REST)' (you will want a live key), you can read more [here](https://developers.messagebird.com/quickstarts/sms/test-credits-api-keys/).
- 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_MESSAGEBIRD'
default_value: 'YES'
description: "Set `SEND_MESSAGEBIRD` to YES"
required: true
- name: 'MESSAGEBIRD_ACCESS_KEY'
default_value: ''
description: "Set `MESSAGEBIRD_ACCESS_KEY` to your API key."
required: true
- name: 'MESSAGEBIRD_NUMBER'
default_value: ''
description: "Set `MESSAGEBIRD_NUMBER` to the MessageBird number you want to use for the alert."
required: true
- name: 'DEFAULT_RECIPIENT_MESSAGEBIRD'
default_value: ''
description: "Set `DEFAULT_RECIPIENT_MESSAGEBIRD` to the number you want the alert notification to be sent as an SMS. You can define multiple recipients like this: +15555555555 +17777777777."
required: true
detailed_description: |
All roles will default to this variable if left unconfigured.
You can then have different recipients per role, by editing `DEFAULT_RECIPIENT_MESSAGEBIRD` with the number you want, in the following entries at the bottom of the same file:
```conf
role_recipients_messagebird[sysadmin]="+15555555555"
role_recipients_messagebird[domainadmin]="+15555555556"
role_recipients_messagebird[dba]="+15555555557"
role_recipients_messagebird[webmaster]="+15555555558"
role_recipients_messagebird[proxyadmin]="+15555555559"
role_recipients_messagebird[sitemgr]="+15555555550"
```
examples:
folding:
enabled: true
title: ''
list:
- name: 'Basic Configuration'
folding:
enabled: false
description: ''
config: |
#------------------------------------------------------------------------------
# Messagebird (messagebird.com) SMS options
SEND_MESSAGEBIRD="YES"
MESSAGEBIRD_ACCESS_KEY="XXXXXXXX"
MESSAGEBIRD_NUMBER="XXXXXXX"
DEFAULT_RECIPIENT_MESSAGEBIRD="+15555555555"
troubleshooting:
problems:
list: []
|
