Adding upstream version 1.39.0.upstream/1.39.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 38 insertions, 53 deletions

diff --git a/health/notifications/opsgenie/README.md b/health/notifications/opsgenie/README.md
index 20f14b39..5b030324 100644
--- a/health/notifications/opsgenie/README.md
+++ b/health/notifications/opsgenie/README.md
@@ -1,66 +1,51 @@
-<!--
-title: "Send notifications to Opsgenie"
-description: "Send alerts to your Opsgenie incident response account any time an anomaly or performance issue strikes a node in your infrastructure."
-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_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
--->
-
-# Send notifications to Opsgenie
-
-[Opsgenie](https://www.atlassian.com/software/opsgenie) is an alerting and incident response tool. It is designed to
-group and filter alarms, build custom routing rules for on-call teams, and correlate deployments and commits to
-incidents.
-
-The first step is to create a [Netdata integration](https://docs.opsgenie.com/docs/api-integration) in the
-[Opsgenie](https://www.atlassian.com/software/opsgenie) dashboard. After this, you need to edit
-`health_alarm_notify.conf` on your system, by running the following from
-your [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md):
-
-```bash
-./edit-config health_alarm_notify.conf
-```
+# Opsgenie Agent alert notifications
 
-Change the variable `OPSGENIE_API_KEY` with the API key you got from Opsgenie. `OPSGENIE_API_URL` defaults to
-`https://api.opsgenie.com`, however there are region-specific API URLs such as `https://eu.api.opsgenie.com`, so set
-this if required.
+Learn how to send notifications to Opsgenie using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
 
-```conf
-SEND_OPSGENIE="YES"
+> ### Note
+>
+> This file assumes you have read the [Introduction to Agent alert notifications](https://github.com/netdata/netdata/blob/master/health/notifications/README.md), detailing how the Netdata Agent's alert notification method works.
 
-# Api key
-# Default Opsgenie API
-OPSGENIE_API_KEY="11111111-2222-3333-4444-555555555555"
-OPSGENIE_API_URL=""
-```
+[Opsgenie](https://www.atlassian.com/software/opsgenie) is an alerting and incident response tool.
+It is designed to group and filter alarms, build custom routing rules for on-call teams, and correlate deployments and commits to incidents.
 
-Changes to `health_alarm_notify.conf` do not require a Netdata restart. You can test your Opsgenie notifications
-configuration by issuing the commands, replacing `ROLE` with your preferred role:
+This is what you will get:
+![Example alarm notifications in
+Opsgenie](https://user-images.githubusercontent.com/49162938/92184518-f725f900-ee40-11ea-9afa-e7c639c72206.png)
 
-```sh
-# become user netdata
-sudo su -s /bin/bash netdata
+## Prerequisites
 
-# send a test alarm
-/usr/libexec/netdata/plugins.d/alarm-notify.sh test ROLE
-```
+You will need:
 
-If everything works, you'll see alarms in your Opsgenie platform:
+- An Opsgenie integration. You can create an [integration](https://docs.opsgenie.com/docs/api-integration) in the [Opsgenie](https://www.atlassian.com/software/opsgenie) dashboard.
 
-![Example alarm notifications in
-Opsgenie](https://user-images.githubusercontent.com/49162938/92184518-f725f900-ee40-11ea-9afa-e7c639c72206.png)
+- terminal access to the Agent you wish to configure
 
-If sending the test notifications fails, you can look in `/var/log/netdata/error.log` to find the relevant error
-message:
+## Configure Netdata to send alert notifications to your Opsgenie account
 
-```log
-2020-09-03 23:07:00: alarm-notify.sh: ERROR: failed to send opsgenie notification for: hades test.chart.test_alarm is CRITICAL, with HTTP error code 401.
-```
+> ### Info
+>
+> This file mentions editing configuration files.  
+>
+> - To edit configuration files in a safe way, we provide the [`edit config` script](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) located in your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) (typically is `/etc/netdata`) that creates the proper file and opens it in an editor automatically.  
+> Note that to run the script you need to be inside your Netdata config directory.
+>
+> It is recommended to use this way for configuring Netdata.
+
+Edit `health_alarm_notify.conf`, changes to this file do not require restarting Netdata:
+
+1. Set `SEND_OPSGENIE` to `YES`.
+2. Set `OPSGENIE_API_KEY` to the API key you got from Opsgenie.
+3. `OPSGENIE_API_URL` defaults to `https://api.opsgenie.com`, however there are region-specific API URLs such as `https://eu.api.opsgenie.com`, so set this if required.
+
+An example of a working configuration would be:
 
-You can find more details about the Opsgenie error codes in
-their [response docs](https://docs.opsgenie.com/docs/response).
+```conf
+SEND_OPSGENIE="YES"
+OPSGENIE_API_KEY="11111111-2222-3333-4444-555555555555"
+OPSGENIE_API_URL=""
+```
 
+## Test the notification method
 
+To test this alert notification method refer to the ["Testing Alert Notifications"](https://github.com/netdata/netdata/blob/master/health/notifications/README.md#testing-alert-notifications) section of the Agent alert notifications page.