ContextQMD
Back to Netdata

Flock

src/health/notifications/flock/README.md

2.10.33.6 KB
Original Source
<!--startmeta custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/health/notifications/flock/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/health/notifications/flock/metadata.yaml" sidebar_label: "Flock" learn_status: "Published" learn_rel_path: "Alerts & Notifications/Notifications/Agent Dispatched Notifications" keywords: ['Flock'] message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE" endmeta-->

Flock

Send notifications to Flock using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.

Setup

Prerequisites

  • The incoming webhook URL as given by flock.com. You can use the same on all your Netdata servers (or you can have multiple if you like). Read more about flock webhooks and how to get one here.
  • Access to the terminal where Netdata Agent is running

Configuration

Options

The following options can be defined for this notification

<details open><summary>Config Options</summary>
OptionDescriptionDefaultRequired
SEND_FLOCKSet SEND_FLOCK to YESYESyes
FLOCK_WEBHOOK_URLset FLOCK_WEBHOOK_URL to your webhook URL.yes
DEFAULT_RECIPIENT_FLOCKSet DEFAULT_RECIPIENT_FLOCK to the Flock channel you want the alert notifications to be sent to. All roles will default to this variable if left unconfigured.yes

<a id="option-default-recipient-flock"></a>

DEFAULT_RECIPIENT_FLOCK

You can have different channels per role, by editing DEFAULT_RECIPIENT_FLOCK with the channel you want, in the following entries at the bottom of the same file:

text
role_recipients_flock[sysadmin]="systems"
role_recipients_flock[domainadmin]="domains"
role_recipients_flock[dba]="databases systems"
role_recipients_flock[webmaster]="marketing development"
role_recipients_flock[proxyadmin]="proxy-admin"
role_recipients_flock[sitemgr]="sites"
</details>

via File

The configuration file name for this integration is health_alarm_notify.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config health_alarm_notify.conf
Examples
Basic Configuration
yaml
#------------------------------------------------------------------------------
# flock (flock.com) global notification options

SEND_FLOCK="YES"
FLOCK_WEBHOOK_URL="https://api.flock.com/hooks/sendMessage/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
DEFAULT_RECIPIENT_FLOCK="alarms"

Troubleshooting

Test Notification

You can run the following command by hand, to test alerts configuration:

bash
# become user netdata
sudo su -s /bin/bash netdata

# enable debugging info on the console
export NETDATA_ALARM_NOTIFY_DEBUG=1

# send test alarms to sysadmin
/usr/libexec/netdata/plugins.d/alarm-notify.sh test

# send test alarms to any role
/usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE"

Note that this will test all alert mechanisms for the selected role.