diff options
author | Chris Akritidis <43294513+cakrit@users.noreply.github.com> | 2023-02-15 10:04:45 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-02-15 10:04:45 -0800 |
commit | 736cc65834edffdb1e5bf1f1cf05575d95efa2c2 (patch) | |
tree | 32081a20e31bcc52a43e6fa440c396484c8a03d4 /health | |
parent | 70229a438b40fd8053d4810ee38c91ce45cafeaf (diff) |
Reorganize learn documents under Integrations part 2 (#14538)
* Reorge exporter integrations
* Reorg alert notifications.
change mdx to md for alert related files
* Move all .mdx to .md, including links.
Diffstat (limited to 'health')
28 files changed, 36 insertions, 37 deletions
diff --git a/health/notifications/README.md b/health/notifications/README.md index 45f56dc356..856ab2c44e 100644 --- a/health/notifications/README.md +++ b/health/notifications/README.md @@ -1,17 +1,16 @@ <!-- -title: "Alarm notifications" +title: "Agent alert notifications" description: "Reference documentation for Netdata's alarm notification feature, which supports dozens of endpoints, user roles, and more." custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/README.md" -sidebar_label: "Notifications Reference" +sidebar_label: "Agent alert notifications" learn_status: "Published" -learn_topic_type: "Tasks" -learn_rel_path: "Operations/Alerts" +learn_rel_path: "Integrations/Notify/Agent alert notifications" --> -# Alarm notifications +# Agent alert notifications The `exec` line in health configuration defines an external script that will be called once -the alarm is triggered. The default script is `alarm-notify.sh`. +the alert is triggered. The default script is `alarm-notify.sh`. You can change the default script globally by editing `/etc/netdata/netdata.conf`. @@ -23,7 +22,7 @@ You can change the default script globally by editing `/etc/netdata/netdata.conf It uses **roles**. For example `sysadmin`, `webmaster`, `dba`, etc. -Each alarm is assigned to one or more roles, using the `to` line of the alarm configuration. Then `alarm-notify.sh` uses +Each alert is assigned to one or more roles, using the `to` line of the alert configuration. Then `alarm-notify.sh` uses its own configuration file `/etc/netdata/health_alarm_notify.conf`. To edit it on your system, run `/etc/netdata/edit-config health_alarm_notify.conf` and find the destination address of the notification for each method. @@ -62,7 +61,7 @@ role_recipients_slack[sysadmin]="${DEFAULT_RECIPIENT_SLACK}" ## Testing Notifications -You can run the following command by hand, to test alarms configuration: +You can run the following command by hand, to test alerts configuration: ```sh # become user netdata @@ -80,9 +79,9 @@ export NETDATA_ALARM_NOTIFY_DEBUG=1 If you are [running your own registry](https://github.com/netdata/netdata/blob/master/registry/README.md#run-your-own-registry), add `export NETDATA_REGISTRY_URL=[YOUR_URL]` before calling `alarm-notify.sh`. -Note that in versions before 1.16, the plugins.d directory may be installed in a different location in certain OSs (e.g. under `/usr/lib/netdata`). You can always find the location of the alarm-notify.sh script in `netdata.conf`. +Note that in versions before 1.16, the plugins.d directory may be installed in a different location in certain OSs (e.g. under `/usr/lib/netdata`). You can always find the location of the `alarm-notify.sh` script in `netdata.conf`. -If you need to dig even deeper, you can trace the execution with `bash -x`. Note that in test mode, alarm-notify.sh calls itself with many more arguments. So first do +If you need to dig even deeper, you can trace the execution with `bash -x`. Note that in test mode, `alarm-notify.sh` calls itself with many more arguments. So first do ```sh bash -x /usr/libexec/netdata/plugins.d/alarm-notify.sh test diff --git a/health/notifications/alerta/README.md b/health/notifications/alerta/README.md index 5ecf55eea7..60eca3de55 100644 --- a/health/notifications/alerta/README.md +++ b/health/notifications/alerta/README.md @@ -5,7 +5,7 @@ description: "Send alarm notifications to Alerta to see the latest health status custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/alerta/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/awssns/README.md b/health/notifications/awssns/README.md index 97768399e6..ffe48b6e1c 100644 --- a/health/notifications/awssns/README.md +++ b/health/notifications/awssns/README.md @@ -5,7 +5,7 @@ description: "hello" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/awssns/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/custom/README.md b/health/notifications/custom/README.md index df8f88e403..eb6342914f 100644 --- a/health/notifications/custom/README.md +++ b/health/notifications/custom/README.md @@ -4,7 +4,7 @@ sidebar_label: "Custom endpoint" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/custom/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/discord/README.md b/health/notifications/discord/README.md index b4cbce5334..651703357d 100644 --- a/health/notifications/discord/README.md +++ b/health/notifications/discord/README.md @@ -4,7 +4,7 @@ sidebar_label: "Discord" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/discord/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/dynatrace/README.md b/health/notifications/dynatrace/README.md index a36683933f..4e799a40e9 100644 --- a/health/notifications/dynatrace/README.md +++ b/health/notifications/dynatrace/README.md @@ -4,7 +4,7 @@ sidebar_label: "Dynatrace Events" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/dynatrace/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/email/README.md b/health/notifications/email/README.md index 01dfd0e6ff..3f6bc585bb 100644 --- a/health/notifications/email/README.md +++ b/health/notifications/email/README.md @@ -4,7 +4,7 @@ sidebar_label: "Email" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/email/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': True, 'part_of_agent': True}" --> diff --git a/health/notifications/flock/README.md b/health/notifications/flock/README.md index 175f8a4661..4e513166bf 100644 --- a/health/notifications/flock/README.md +++ b/health/notifications/flock/README.md @@ -4,7 +4,7 @@ sidebar_label: "Flock" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/flock/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/gotify/README.md b/health/notifications/gotify/README.md index d01502b65a..a4765fa8a4 100644 --- a/health/notifications/gotify/README.md +++ b/health/notifications/gotify/README.md @@ -5,7 +5,7 @@ sidebar_label: "Gotify" custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/gotify/README.md learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/hangouts/README.md b/health/notifications/hangouts/README.md index 45da1bfa0b..f8efdcbb42 100644 --- a/health/notifications/hangouts/README.md +++ b/health/notifications/hangouts/README.md @@ -5,7 +5,7 @@ sidebar_label: "Google Hangouts" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/hangouts/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/irc/README.md b/health/notifications/irc/README.md index a4877f48a5..919668c0ad 100644 --- a/health/notifications/irc/README.md +++ b/health/notifications/irc/README.md @@ -4,7 +4,7 @@ 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_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/kavenegar/README.md b/health/notifications/kavenegar/README.md index 443fcdba46..1a41857013 100644 --- a/health/notifications/kavenegar/README.md +++ b/health/notifications/kavenegar/README.md @@ -4,7 +4,7 @@ sidebar_label: "Kavenegar" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/kavenegar/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/matrix/README.md b/health/notifications/matrix/README.md index 80e22da37e..8e81867827 100644 --- a/health/notifications/matrix/README.md +++ b/health/notifications/matrix/README.md @@ -5,7 +5,7 @@ sidebar_label: "Matrix" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/matrix/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/messagebird/README.md b/health/notifications/messagebird/README.md index 0143019851..1677e85448 100644 --- a/health/notifications/messagebird/README.md +++ b/health/notifications/messagebird/README.md @@ -4,7 +4,7 @@ sidebar_label: "Messagebird" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/messagebird/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/msteams/README.md b/health/notifications/msteams/README.md index 75e652a72b..ae779cab4a 100644 --- a/health/notifications/msteams/README.md +++ b/health/notifications/msteams/README.md @@ -4,7 +4,7 @@ sidebar_label: "Microsoft Teams" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/msteams/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/opsgenie/README.md b/health/notifications/opsgenie/README.md index 20f14b396a..dc5d33b909 100644 --- a/health/notifications/opsgenie/README.md +++ b/health/notifications/opsgenie/README.md @@ -5,7 +5,7 @@ sidebar_label: "Opsgenie" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/opsgenie/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/pagerduty/README.md b/health/notifications/pagerduty/README.md index 8b272f4f27..16e628947d 100644 --- a/health/notifications/pagerduty/README.md +++ b/health/notifications/pagerduty/README.md @@ -5,7 +5,7 @@ sidebar_label: "PagerDuty" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pagerduty/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/prowl/README.md b/health/notifications/prowl/README.md index 8656c13146..ce52f94132 100644 --- a/health/notifications/prowl/README.md +++ b/health/notifications/prowl/README.md @@ -4,7 +4,7 @@ sidebar_label: "Prowl" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/prowl/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/pushbullet/README.md b/health/notifications/pushbullet/README.md index 17ed936461..27b4547626 100644 --- a/health/notifications/pushbullet/README.md +++ b/health/notifications/pushbullet/README.md @@ -4,7 +4,7 @@ sidebar_label: "PushBullet" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pushbullet/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/pushover/README.md b/health/notifications/pushover/README.md index 4d5ea5a96d..f9335f90b5 100644 --- a/health/notifications/pushover/README.md +++ b/health/notifications/pushover/README.md @@ -4,7 +4,7 @@ sidebar_label: "PushOver" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pushover/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/rocketchat/README.md b/health/notifications/rocketchat/README.md index 0f7867d0f5..3aacacc8e9 100644 --- a/health/notifications/rocketchat/README.md +++ b/health/notifications/rocketchat/README.md @@ -4,7 +4,7 @@ sidebar_label: "Rocket Chat" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/rocketchat/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/slack/README.md b/health/notifications/slack/README.md index ad9a213460..35d6742869 100644 --- a/health/notifications/slack/README.md +++ b/health/notifications/slack/README.md @@ -4,7 +4,7 @@ sidebar_label: "Slack" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/slack/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/smstools3/README.md b/health/notifications/smstools3/README.md index 9535c9549c..42303b617f 100644 --- a/health/notifications/smstools3/README.md +++ b/health/notifications/smstools3/README.md @@ -4,7 +4,7 @@ sidebar_label: "SMS server" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/smstools3/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/stackpulse/README.md b/health/notifications/stackpulse/README.md index 25266e8225..57879e0a83 100644 --- a/health/notifications/stackpulse/README.md +++ b/health/notifications/stackpulse/README.md @@ -5,7 +5,7 @@ sidebar_label: "StackPulse" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/stackpulse/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/syslog/README.md b/health/notifications/syslog/README.md index 3527decc46..e7d5652411 100644 --- a/health/notifications/syslog/README.md +++ b/health/notifications/syslog/README.md @@ -4,7 +4,7 @@ sidebar_label: "Syslog" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/syslog/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/telegram/README.md b/health/notifications/telegram/README.md index f80a2838db..690798ffac 100644 --- a/health/notifications/telegram/README.md +++ b/health/notifications/telegram/README.md @@ -4,7 +4,7 @@ sidebar_label: "Telegram" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/telegram/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/twilio/README.md b/health/notifications/twilio/README.md index 470b2413b5..1a0d48a355 100644 --- a/health/notifications/twilio/README.md +++ b/health/notifications/twilio/README.md @@ -4,7 +4,7 @@ sidebar_label: "Twilio" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/twilio/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> diff --git a/health/notifications/web/README.md b/health/notifications/web/README.md index b4afd9ea78..b3713d588e 100644 --- a/health/notifications/web/README.md +++ b/health/notifications/web/README.md @@ -4,7 +4,7 @@ sidebar_label: "Pop up notifications" custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/web/README.md" learn_status: "Published" learn_topic_type: "Tasks" -learn_rel_path: "Setup/Notification/Agent" +learn_rel_path: "Integrations/Notify/Agent alert notifications" learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> |