| 1 | # yamllint disable rule:line-length |
| 2 | --- |
| 3 | - id: 'notify-irc' |
| 4 | meta: |
| 5 | name: 'IRC' |
| 6 | link: '' |
| 7 | categories: |
| 8 | - notify.agent |
| 9 | icon_filename: 'irc.png' |
| 10 | keywords: |
| 11 | - IRC |
| 12 | overview: |
| 13 | notification_description: | |
| 14 | Send notifications to IRC using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. |
| 15 | notification_limitations: '' |
| 16 | setup: |
| 17 | prerequisites: |
| 18 | list: |
| 19 | - title: '' |
| 20 | description: | |
| 21 | - The `nc` utility. You can set the path to it, or Netdata will search for it in your system `$PATH`. |
| 22 | - Access to the terminal where Netdata Agent is running |
| 23 | configuration: |
| 24 | file: |
| 25 | name: 'health_alarm_notify.conf' |
| 26 | options: |
| 27 | description: 'The following options can be defined for this notification' |
| 28 | folding: |
| 29 | title: 'Config Options' |
| 30 | enabled: true |
| 31 | list: |
| 32 | - name: 'nc path' |
| 33 | default_value: '' |
| 34 | description: "Set the path for nc, otherwise Netdata will search for it in your system $PATH" |
| 35 | required: true |
| 36 | detailed_description: | |
| 37 | ```sh |
| 38 | #------------------------------------------------------------------------------ |
| 39 | # external commands |
| 40 | # |
| 41 | # The full path of the nc command. |
| 42 | # If empty, the system $PATH will be searched for it. |
| 43 | # If not found, irc notifications will be silently disabled. |
| 44 | nc="/usr/bin/nc" |
| 45 | ``` |
| 46 | - name: 'SEND_IRC' |
| 47 | default_value: 'YES' |
| 48 | description: "Set `SEND_IRC` YES." |
| 49 | required: true |
| 50 | - name: 'IRC_NETWORK' |
| 51 | default_value: '' |
| 52 | description: "Set `IRC_NETWORK` to the IRC network which your preferred channels belong to." |
| 53 | required: true |
| 54 | - name: 'IRC_PORT ' |
| 55 | default_value: '' |
| 56 | description: "Set `IRC_PORT` to the IRC port to which a connection will occur." |
| 57 | required: false |
| 58 | - name: 'IRC_NICKNAME' |
| 59 | default_value: '' |
| 60 | description: "Set `IRC_NICKNAME` to 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." |
| 61 | required: true |
| 62 | - name: 'IRC_REALNAME' |
| 63 | default_value: '' |
| 64 | description: "Set `IRC_REALNAME` to the IRC realname which is required in order to make the connection." |
| 65 | required: true |
| 66 | - name: 'DEFAULT_RECIPIENT_IRC' |
| 67 | default_value: '' |
| 68 | description: "You can have different channels per role, by editing `DEFAULT_RECIPIENT_IRC` with the channel you want" |
| 69 | required: true |
| 70 | detailed_description: | |
| 71 | The `DEFAULT_RECIPIENT_IRC` can be edited in the following entries at the bottom of the same file: |
| 72 | ```text |
| 73 | role_recipients_irc[sysadmin]="#systems" |
| 74 | role_recipients_irc[domainadmin]="#domains" |
| 75 | role_recipients_irc[dba]="#databases #systems" |
| 76 | role_recipients_irc[webmaster]="#marketing #development" |
| 77 | role_recipients_irc[proxyadmin]="#proxy-admin" |
| 78 | role_recipients_irc[sitemgr]="#sites" |
| 79 | ``` |
| 80 | examples: |
| 81 | folding: |
| 82 | enabled: true |
| 83 | title: '' |
| 84 | list: |
| 85 | - name: 'Basic Configuration' |
| 86 | folding: |
| 87 | enabled: false |
| 88 | description: '' |
| 89 | config: | |
| 90 | #------------------------------------------------------------------------------ |
| 91 | # irc notification options |
| 92 | # |
| 93 | SEND_IRC="YES" |
| 94 | DEFAULT_RECIPIENT_IRC="#system-alarms" |
| 95 | IRC_NETWORK="irc.freenode.net" |
| 96 | IRC_NICKNAME="netdata-alarm-user" |
| 97 | IRC_REALNAME="netdata-user" |
| 98 | troubleshooting: |
| 99 | problems: |
| 100 | list: [] |