oncall-engine/README.md

62 lines
2.3 KiB
Markdown
Raw Normal View History

2022-06-09 16:35:04 +03:00
<img width="400px" src="docs/img/logo.png">
Developer-friendly, incident response management with brilliant Slack integration.
2022-06-09 16:29:14 +03:00
2022-06-09 16:35:47 +03:00
<img width="60%" src="screenshot.png">
2022-06-09 16:29:14 +03:00
2022-06-09 15:58:10 +03:00
- Collect and analyze alerts from multiple monitoring systems
- On-call rotations based on schedules
- Automatic escalations
- Phone calls, SMS, Slack, Telegram notifications
## Getting Started
2022-06-09 17:47:33 +03:00
We prepared multiple environments: [production](PRODUCTION.md), [developer](DEVELOPER.md) and hobby:
2022-06-09 15:49:14 +03:00
2022-06-09 17:47:33 +03:00
1. Download docker-compose.yaml:
```bash
2022-06-09 23:55:57 +03:00
curl https://github.com/grafana/oncall/blob/dev/docker-compose.yml -o docker-compose.yaml
```
2022-06-09 17:47:33 +03:00
2. Set variables:
```bash
2022-06-09 15:49:14 +03:00
export DOMAIN=http://localhost
export SECRET_KEY=my_random_secret_must_be_more_than_32_characters_long
export RABBITMQ_PASSWORD=rabbitmq_secret_pw
export MYSQL_PASSWORD=mysql_secret_pw
2022-06-10 00:11:14 +03:00
export COMPOSE_PROFILES=with_grafana # Comment this line if you want to use existing grafana
2022-06-09 15:49:14 +03:00
export GRAFANA_USER=admin
export GRAFANA_PASSWORD=admin
```
2022-06-09 17:47:33 +03:00
3. Launch services:
```bash
2022-06-09 15:49:14 +03:00
docker-compose -f docker-compose.yml up --build -d
```
2022-06-09 19:52:09 +03:00
4. Issue one-time invite token:
2022-06-09 15:49:14 +03:00
```bash
docker-compose -f docker-compose.yml run engine python manage.py issue_invite_for_the_frontend --override
```
2022-06-10 00:11:14 +03:00
5. Go to [OnCall Plugin Configuration](http://localhost:3000/plugins/grafana-oncall-app) (or find OnCall plugin in configuration->plugins) and connect OnCall _plugin_ with OnCall _backend_:
2022-06-09 19:52:09 +03:00
```
Invite token: ^^^ from the previous step.
OnCall backend URL: http://engine:8080
Grafana Url: http://grafana:3000
```
6. Enjoy!
2022-06-09 17:48:26 +03:00
## Join community
<a href="https://github.com/grafana/oncall/discussions/categories/community-calls"><img width="200px" src="docs/img/community_call.png"></a>
<a href="https://github.com/grafana/oncall/discussions"><img width="200px" src="docs/img/GH_discussions.png"></a>
<a href="https://slack.grafana.com/"><img width="200px" src="docs/img/slack.png"></a>
## Further Reading
- *Documentation* - [Grafana OnCall](https://grafana.com/docs/grafana-cloud/oncall/)
- *Blog Post* - [Announcing Grafana OnCall, the easiest way to do on-call management](https://grafana.com/blog/2021/11/09/announcing-grafana-oncall/)
- *Presentation* - [Deep dive into the Grafana, Prometheus, and Alertmanager stack for alerting and on-call management](https://grafana.com/go/observabilitycon/2021/alerting/?pg=blog)