blob: a4877f48a5f219e4ae674af6698ef632ea55cfd5 (
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
80
81
82
83
|
<!--
title: "IRC"
sidebar_label: "IRC"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/irc/README.md"
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Setup/Notification/Agent"
learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# IRC
This is what you will get:
IRCCloud web client:\
Irssi terminal client:
You need:
1. The `nc` utility. If you do not set the path, Netdata will search for it in your system `$PATH`.
Set the path for `nc` in `/etc/netdata/health_alarm_notify.conf` (to edit it on your system run `/etc/netdata/edit-config health_alarm_notify.conf`), like this:
```
#------------------------------------------------------------------------------
# external commands
#
# The full path of the nc command.
# If empty, the system $PATH will be searched for it.
# If not found, irc notifications will be silently disabled.
nc="/usr/bin/nc"
```
2. Αn `IRC_NETWORK` to which your preferred channels belong to.
3. One or more channels ( `DEFAULT_RECIPIENT_IRC` ) to post the messages to.
4. An `IRC_NICKNAME` and an `IRC_REALNAME` to identify in IRC.
Set them in `/etc/netdata/health_alarm_notify.conf` (to edit it on your system run `/etc/netdata/edit-config health_alarm_notify.conf`), like this:
```
#------------------------------------------------------------------------------
# irc notification options
#
# irc notifications require only the nc utility to be installed.
# multiple recipients can be given like this:
# "<irc_channel_1> <irc_channel_2> ..."
# enable/disable sending irc notifications
SEND_IRC="YES"
# if a role's recipients are not configured, a notification will not be sent.
# (empty = do not send a notification for unconfigured roles):
DEFAULT_RECIPIENT_IRC="#system-alarms"
# The irc network to which the recipients belong. It must be the full network.
IRC_NETWORK="irc.freenode.net"
# The irc nickname which is required to send the notification. It must not be
# an already registered name as the connection's MODE is defined as a 'guest'.
IRC_NICKNAME="netdata-alarm-user"
# The irc realname which is required in order to make the connection and is an
# extra identifier.
IRC_REALNAME="netdata-user"
```
You can define multiple channels like this: `#system-alarms #networking-alarms`.\
You can also filter the notifications like this: `#system-alarms|critical`.\
You can give different channels per **role** using these (at the same file):
```
role_recipients_irc[sysadmin]="#user-alarms #networking-alarms #system-alarms"
role_recipients_irc[dba]="#databases-alarms"
role_recipients_irc[webmaster]="#networking-alarms"
```
The keywords `#user-alarms`, `#networking-alarms`, `#system-alarms`, `#databases-alarms` are irc channels which belong to the specified IRC network.
|
