Regenerate integrations docs (#19541)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Jan 31, 2025 at 03:56 UTC
018a57d7bbbbb81a97f3d64b017dd38715af72f5
1 file changed
+154
src/health/notifications/smseagle/README.md
new
+154
@@ -0,0 +1,154 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/health/notifications/smseagle/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/health/notifications/smseagle/metadata.yaml"
4
+sidebar_label: "SMSEagle"
5
+learn_status: "Published"
6
+learn_rel_path: "Alerts & Notifications/Notifications/Agent Dispatched Notifications"
7
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
8
+endmeta-->
9
+
10
+# SMSEagle
11
+
12
+
13
+<img src="https://netdata.cloud/img/smseagle.svg" width="150"/>
14
+
15
+
16
+Forward notifications to SMSEagle device to send SMS, MMS, wake-up, or text-to-speech calls.
17
+
18
+
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Setup
23
+
24
+### Prerequisites
25
+
26
+####
27
+
28
+Before using the API, you'll need to enable API access on your SMSEagle device by following these steps:
29
+
30
+1. Navigate to the Web-GUI and select the "Users" menu.
31
+2. Create a new user account with "User" access level.
32
+3. Locate the "Access to API" option next to your newly created user.
33
+4. Select APIv2 and click the "Generate new token" button to create your API access token.
34
+5. Set up the appropriate permissions in the APIv2 Permission section.
35
+
36
+Optional: Enable the "Access to resources of all users" checkbox if you want this API key to access data across all users. By default, the API key can only access data created under its credentials.
37
+
38
+
39
+
40
+### Configuration
41
+
42
+#### File
43
+
44
+The configuration file name for this integration is `health_alarm_notify.conf`.
45
+
46
+
47
+You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the
48
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
49
+
50
+```bash
51
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
52
+sudo ./edit-config health_alarm_notify.conf
53
+```
54
+#### Options
55
+
56
+The following options can be defined for this notification
57
+
58
+<details open><summary>Config Options</summary>
59
+
60
+| Name | Description | Default | Required |
61
+|:----|:-----------|:-------|:--------:|
62
+| DEFAULT_RECIPIENT_SMSEAGLE | If a role's recipients are not configured, a notification will be sent to this SMS recipient (empty = do not send a notification for unconfigured roles). Multiple recipients can be given like this: "PHONE1,PHONE2..." | | yes |
63
+| SMSEAGLE_API_URL | | | yes |
64
+| SMSEAGLE_API_ACCESSTOKEN | | | yes |
65
+| SMSEAGLE_MSG_TYPE | | sms | yes |
66
+| SMSEAGLE_CALL_DURATION | | 10 | yes |
67
+| SMSEAGLE_VOICE_ID | | 10 | yes |
68
+
69
+##### DEFAULT_RECIPIENT_SMSEAGLE
70
+
71
+All roles will default to this variable if left unconfigured.
72
+
73
+You can then have different recipients per role, by editing `DEFAULT_RECIPIENT_SMSEAGLE` with the number you want, in the following entries at the bottom of the same file:
74
+```
75
+role_recipients_smseagle[sysadmin]="+11222333444"
76
+role_recipients_smseagle[domainadmin]="+11222333445"
77
+role_recipients_smseagle[dba]="+11222333446"
78
+role_recipients_smseagle[webmaster]="+11222333447"
79
+role_recipients_smseagle[proxyadmin]="+11222333448"
80
+role_recipients_smseagle[sitemgr]="+11222333449"
81
+```
82
+
83
+
84
+##### SMSEAGLE_API_URL
85
+
86
+The url of the SMSEagle device accessible from NetData, e.g https://192.168.0.101
87
+
88
+
89
+##### SMSEAGLE_API_ACCESSTOKEN
90
+
91
+An access token for the user created at SMSEagle device
92
+
93
+
94
+##### SMSEAGLE_MSG_TYPE
95
+
96
+Choose a type of message/call. Available types: sms, mms, ring (wake-up call), tts (text-to-speech call), tts_advanced (multilanguage text-to-speech call). Be aware that some types require additional parameters to be set.
97
+
98
+
99
+##### SMSEAGLE_CALL_DURATION
100
+
101
+Call duration, parameter required for Ring, TTS and TTS Advanced.
102
+
103
+
104
+##### SMSEAGLE_VOICE_ID
105
+
106
+ID of the voice model, required for TTS Advanced.
107
+
108
+
109
+</details>
110
+
111
+#### Examples
112
+
113
+##### Basic Configuration
114
+
115
+
116
+
117
+```yaml
118
+#------------------------------------------------------------------------------
119
+# SMSEagle options
120
+
121
+SEND_SMSEAGLE="YES"
122
+SMSEAGLE_API_URL="XXXXXXXX"
123
+SMSEAGLE_API_ACCESSTOKEN="XXXXXXX"
124
+SMSEAGLE_MSG_TYPE="sms"
125
+SMSEAGLE_CALL_DURATION="10"
126
+SMSEAGLE_VOICE_ID="1"
127
+DEFAULT_RECIPIENT_SMSEAGLE="+11222333444"
128
+
129
+```
130
+
131
+
132
+## Troubleshooting
133
+
134
+### Test Notification
135
+
136
+You can run the following command by hand, to test alerts configuration:
137
+
138
+```bash
139
+# become user netdata
140
+sudo su -s /bin/bash netdata
141
+
142
+# enable debugging info on the console
143
+export NETDATA_ALARM_NOTIFY_DEBUG=1
144
+
145
+# send test alarms to sysadmin
146
+/usr/libexec/netdata/plugins.d/alarm-notify.sh test
147
+
148
+# send test alarms to any role
149
+/usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE"
150
+```
151
+
152
+Note that this will test _all_ alert mechanisms for the selected role.
153
+
154
+