From 24b72583384c3d3860b0da6518540263ac90bff2 Mon Sep 17 00:00:00 2001 From: TwiN Date: Tue, 11 Jan 2022 20:22:44 -0500 Subject: [PATCH] docs: Re-order parameters in Opsgenie and PagerDuty --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0f6e2da9..5e0cacf3 100644 --- a/README.md +++ b/README.md @@ -464,15 +464,16 @@ endpoints: #### Configuring Opsgenie alerts -| Parameter | Description | Default | -|:----------------------------------|:--------------------------------------------|:---------------------| -| `alerting.opsgenie` | Configuration for alerts of type `opsgenie` | `{}` | -| `alerting.opsgenie.api-key` | Opsgenie API Key | Required `""` | -| `alerting.opsgenie.priority` | Priority level of the alert. | `P1` | -| `alerting.opsgenie.source` | Source field of the alert. | `gatus` | -| `alerting.opsgenie.entity-prefix` | Entity field prefix. | `gatus-` | -| `alerting.opsgenie.alias-prefix` | Alias field prefix. | `gatus-healthcheck-` | -| `alerting.opsgenie.tags` | Tags of alert. | `[]` | +| Parameter | Description | Default | +|:----------------------------------|:-------------------------------------------------------------------------------------------|:---------------------| +| `alerting.opsgenie` | Configuration for alerts of type `opsgenie` | `{}` | +| `alerting.opsgenie.api-key` | Opsgenie API Key | Required `""` | +| `alerting.opsgenie.priority` | Priority level of the alert. | `P1` | +| `alerting.opsgenie.source` | Source field of the alert. | `gatus` | +| `alerting.opsgenie.entity-prefix` | Entity field prefix. | `gatus-` | +| `alerting.opsgenie.alias-prefix` | Alias field prefix. | `gatus-healthcheck-` | +| `alerting.opsgenie.tags` | Tags of alert. | `[]` | +| `alerting.opsgenie.default-alert` | Default alert configuration.
See [Setting a default alert](#setting-a-default-alert) | N/A | Opsgenie provider will automatically open and close alerts. @@ -488,10 +489,10 @@ alerting: |:-------------------------------------------------|:-------------------------------------------------------------------------------------------|:--------| | `alerting.pagerduty` | Configuration for alerts of type `pagerduty` | `{}` | | `alerting.pagerduty.integration-key` | PagerDuty Events API v2 integration key | `""` | -| `alerting.pagerduty.default-alert` | Default alert configuration.
See [Setting a default alert](#setting-a-default-alert) | N/A | | `alerting.pagerduty.overrides` | List of overrides that may be prioritized over the default configuration | `[]` | | `alerting.pagerduty.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` | | `alerting.pagerduty.overrides[].integration-key` | PagerDuty Events API v2 integration key | `""` | +| `alerting.pagerduty.default-alert` | Default alert configuration.
See [Setting a default alert](#setting-a-default-alert) | N/A | It is highly recommended to set `endpoints[].alerts[].send-on-resolved` to `true` for alerts of type `pagerduty`, because unlike other alerts, the operation resulting from setting said