Skip to content

Commit

Permalink
chore: minor doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mr-karan committed Feb 18, 2022
1 parent 76356ca commit d1a53a1
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ Here's an example `docker-compose` config with a custom `message.tmpl` mounted i

Refer to [config.sample.toml](./config.sample.toml) for instructions on how to configure `calert`.

All the config variables can also be supplied as Environment Variables by prefixing `CALERT_` and replacing `.` with `__`. Example:
All the config variables can also be supplied as Environment Variables by prefixing `CALERT_` and replacing `.` (_period_) with `__` (_double underscores_).

Example:

- `app.address` would become `CALERT_APP__ADDRESS`

Expand Down Expand Up @@ -118,7 +120,7 @@ Here's a list of internal app metrics available at `/metrics`:
| `calert_alerts_dispatched_total` | Number of alerts dispatched to upstream providers, grouped with labels like `provider` and `room`. | `counter` |
| `calert_alerts_dispatched_duration_seconds_{sum,count,bucket}` | Duration to send an alert to upstream provider. | `histogram` |

It also exposes Go process metrics in addition to app metrics, which you can use to monitor the performance of `calert.
It also exposes Go process metrics in addition to app metrics, which you can use to monitor the performance of `calert`.

## v2 Migration

Expand Down Expand Up @@ -146,7 +148,6 @@ Here's an example of how the Prometheus Alert should look like (Notice the `labe
description: This is a DeadMansSwitch meant to ensure that the entire alerting pipeline is functional.
summary: Consider running `htop` and check the processes consuming max RAM.
severity: "{{ $labels.severity }}"
instance: "{{ $labels.instance }}"
```

## Contribution
Expand Down

0 comments on commit d1a53a1

Please sign in to comment.