Regenerate integrations docs (#20916)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Sep 3, 2025 at 07:11 UTC
10c586e560103c7c066897f303b91762c9e0d3e2
1 file changed
+96
src/health/notifications/signl4/README.md
new
+96
@@ -0,0 +1,96 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/health/notifications/signl4/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/health/notifications/signl4/metadata.yaml"
4
+sidebar_label: "SIGNL4"
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
+# SIGNL4
11
+
12
+
13
+<img src="https://netdata.cloud/img/signl4.svg" width="150"/>
14
+
15
+
16
+SIGNL4 offers critical alerting, incident response and service dispatching for operating critical infrastructure. It alerts you persistently via app push, SMS text, voice calls, and email including tracking, escalation, on-call duty scheduling and collaboration.
17
+You can send notifications to SIGNL4 using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
18
+
19
+
20
+
21
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
22
+
23
+## Setup
24
+
25
+### Prerequisites
26
+
27
+####
28
+
29
+- An inbound webhook in SIGNL4
30
+- Access to the terminal where Netdata Agent is running
31
+
32
+
33
+
34
+### Configuration
35
+
36
+#### File
37
+
38
+The configuration file name for this integration is `health_alarm_notify.conf`.
39
+
40
+
41
+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
42
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
43
+
44
+```bash
45
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
46
+sudo ./edit-config health_alarm_notify.conf
47
+```
48
+#### Options
49
+
50
+The following options can be defined for this notification
51
+
52
+<details open><summary>Config Options</summary>
53
+
54
+| Name | Description | Default | Required |
55
+|:----|:-----------|:-------|:--------:|
56
+| SEND_SIGNL4 | Set `SEND_SIGNL4` to YES | YES | yes |
57
+| SIGNL4_WEBHOOK_URL | set `SIGNL4_WEBHOOK_URL` to your SIGNL4 webhook URL. | | yes |
58
+
59
+</details>
60
+
61
+#### Examples
62
+
63
+##### Basic Configuration
64
+
65
+
66
+
67
+```yaml
68
+SEND_SIGNL4="YES"
69
+SIGNL4_WEBHOOK_URL="https://connect.signl4.com/webhook/xxxxxxxx"
70
+
71
+```
72
+
73
+
74
+## Troubleshooting
75
+
76
+### Test Notification
77
+
78
+You can run the following command by hand, to test alerts configuration:
79
+
80
+```bash
81
+# become user netdata
82
+sudo su -s /bin/bash netdata
83
+
84
+# enable debugging info on the console
85
+export NETDATA_ALARM_NOTIFY_DEBUG=1
86
+
87
+# send test alarms to sysadmin
88
+/usr/libexec/netdata/plugins.d/alarm-notify.sh test
89
+
90
+# send test alarms to any role
91
+/usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE"
92
+```
93
+
94
+Note that this will test _all_ alert mechanisms for the selected role.
95
+
96
+