Skip to content

Commit

Permalink
docs(alerting): Fix wrong gitlab terminology (alert key vs. PAT) (#694)
Browse files Browse the repository at this point in the history
Fix wrong term (alert key vs. PAT)
  • Loading branch information
salim-b authored Mar 7, 2024
1 parent 1eba430 commit 143a093
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -596,15 +596,15 @@ endpoints:
![GitHub alert](.github/assets/github-alerts.png)

#### Configuring GitLab alerts
| Parameter | Description | Default |
| Parameter | Description | Default |
|:------------------------------------|:----------------------------------------------------------------------------------------------------------------|:--------------|
| `alerting.gitlab` | Configuration for alerts of type `gitlab` | `{}` |
| `alerting.gitlab.webhook-url` | GitLab alert webhook URL (e.g. `https://gitlab.com/hlidotbe/example/alerts/notify/gatus/xxxxxxxxxxxxxxxx.json`) | Required `""` |
| `alerting.gitlab.authorization-key` | Personal access token to use for authentication. <br />Must have at least RW on issues and RO on metadata. | Required `""` |
| `alerting.gitlab.authorization-key` | GitLab alert authorization key. | Required `""` |
| `alerting.gitlab.severity` | Override default severity (critical), can be one of `critical, high, medium, low, info, unknown` | `""` |
| `alerting.gitlab.monitoring-tool` | Override the monitoring tool name (gatus) | `"gatus"` |
| `alerting.gitlab.environment-name` | Set gitlab environment's name. Required to display alerts on a dashboard. | `""` |
| `alerting.gitlab.service` | Override endpoint displayname | `""` |
| `alerting.gitlab.service` | Override endpoint displayname | `""` |
| `alerting.gitlab.default-alert` | Default alert configuration. <br />See [Setting a default alert](#setting-a-default-alert). | N/A |

The GitLab alerting provider creates an alert prefixed with `alert(gatus):` and suffixed with the endpoint's display
Expand Down

0 comments on commit 143a093

Please sign in to comment.