oncall-engine/README.md

54 lines
1.9 KiB
Markdown
Raw Normal View History

2022-06-09 16:33:49 +03:00
<img width="200px" 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:29:43 +03:00
<img width="80%" 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
2022-06-09 16:27:45 +03:00
<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>
## Getting Started
2022-06-09 15:58:10 +03:00
### Production environment
For production setup check [PRODUCTION.md](PRODUCTION.md).
### Hobby environment
2022-06-09 15:49:14 +03:00
Download docker-compose.yaml:
```bash
2022-06-09 15:49:14 +03:00
curl https://github.com/... -o docker-compose.yaml
```
2022-06-09 15:49:14 +03:00
Set environment:
```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
export COMPOSE_PROFILES=with_grafana
export GRAFANA_USER=admin
export GRAFANA_PASSWORD=admin
```
2022-06-09 15:58:10 +03:00
Launch services:
```bash
2022-06-09 15:49:14 +03:00
docker-compose -f docker-compose.yml up --build -d
```
2022-06-09 15:58:10 +03:00
Issue invite token and get further instructions:
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
```
## 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)