Grafana OnCall engine fork — self-hosted on-call scheduler and alert router
Find a file
2024-04-25 18:33:35 +00:00
.github Configure cross plugin e2e tests (#4222) 2024-04-25 06:25:59 +00:00
dev Bump aiohttp from 3.9.2 to 3.9.4 in /dev/scripts/generate-fake-data (#4253) 2024-04-22 11:58:38 +00:00
docs GCal autogenerated shift swap requests - don't recreate if one was previously created and deleted (#4281) 2024-04-25 18:16:42 +00:00
engine GCal autogenerated shift swap requests - don't recreate if one was previously created and deleted (#4281) 2024-04-25 18:16:42 +00:00
grafana-plugin Configure cross plugin e2e tests (#4222) 2024-04-25 06:25:59 +00:00
helm Release oncall Helm chart 1.4.4 2024-04-25 18:33:35 +00:00
terraform
tools
.dockerignore
.drone.yml Fix path for plugin release publish (#3967) 2024-02-28 00:41:14 +00:00
.gitignore
.markdownlint.json
.markdownlintignore
.pre-commit-config.yaml SNOW minor wording & docs URL updates (#4229) 2024-04-16 12:16:35 +00:00
.prettierignore
.prettierrc.js
.yamllint.yml
CHANGELOG.md Update CHANGELOG.md (#4041) 2024-03-12 07:47:08 +00:00
CODE_OF_CONDUCT.md
docker-compose-developer.yml Fix daily e2e tests GitHub Actions cron job (#3923) 2024-02-27 09:21:53 -05:00
docker-compose-mysql-rabbitmq.yml
docker-compose.yml
LICENSE
LICENSING.md
Makefile Use pip-tools to handle Python deps (#3892) 2024-02-20 17:44:15 +00:00
README.md Update readme (#4012) 2024-03-05 16:12:54 +00:00
screenshot.png
screenshot_mobile.png
Tiltfile Configure cross plugin e2e tests (#4222) 2024-04-25 06:25:59 +00:00

Grafana OnCall

Latest Release License Docker Pulls Slack Discussion Build Status

Developer-friendly incident response with brilliant Slack integration.

  • Collect and analyze alerts from multiple monitoring systems
  • On-call rotations based on schedules
  • Automatic escalations
  • Phone calls, SMS, Slack, Telegram notifications

Getting Started

We prepared multiple environments:

  1. Download docker-compose.yml:

    curl -fsSL https://raw.githubusercontent.com/grafana/oncall/dev/docker-compose.yml -o docker-compose.yml
    
  2. Set variables:

    echo "DOMAIN=http://localhost:8080
    # Remove 'with_grafana' below if you want to use existing grafana
    # Add 'with_prometheus' below to optionally enable a local prometheus for oncall metrics
    # e.g. COMPOSE_PROFILES=with_grafana,with_prometheus
    COMPOSE_PROFILES=with_grafana
    # to setup an auth token for prometheus exporter metrics:
    # PROMETHEUS_EXPORTER_SECRET=my_random_prometheus_secret
    # also, make sure to enable the /metrics endpoint:
    # FEATURE_PROMETHEUS_EXPORTER_ENABLED=True
    SECRET_KEY=my_random_secret_must_be_more_than_32_characters_long" > .env
    
  3. (Optional) If you want to enable/setup the prometheus metrics exporter (besides the changes above), create a prometheus.yml file (replacing my_random_prometheus_secret accordingly), next to your docker-compose.yml:

    echo "global:
      scrape_interval:     15s
      evaluation_interval: 15s
    
    scrape_configs:
      - job_name: prometheus
        metrics_path: /metrics/
        authorization:
          credentials: my_random_prometheus_secret
        static_configs:
          - targets: [\"host.docker.internal:8080\"]" > prometheus.yml
    

    NOTE: you will need to setup a Prometheus datasource using http://prometheus:9090 as the URL in the Grafana UI.

  4. Launch services:

    docker-compose pull && docker-compose up -d
    
  5. Go to OnCall Plugin Configuration, using log in credentials as defined above: admin/admin (or find OnCall plugin in configuration->plugins) and connect OnCall plugin with OnCall backend:

    OnCall backend URL: http://engine:8080
    
  6. Enjoy! Check our OSS docs if you want to set up Slack, Telegram, Twilio or SMS/calls through Grafana Cloud.

Update version

To update your Grafana OnCall hobby environment:

# Update Docker image
docker-compose pull engine

# Re-deploy
docker-compose up -d

After updating the engine, you'll also need to click the "Update" button on the plugin version page. See Grafana docs for more info on updating Grafana plugins.

Join community

Have a question, comment or feedback? Don't be afraid to open an issue!

Stargazers over time

Stargazers over time

Further Reading