Skip to content

keephq/keep

Repository files navigation

Alerting. By developers, for developers.


Simple Alerting tool, Builtin providers (e.g. sentry/datadog or slack/pagerduty), 100% open sourced, free forever.

Manage your alerts by code, write better more actionable and accurate alerts with Keep scoring system (coming soon).


Get started »

Providers · Docs · Website · Add Providers · Report Bug · Slack Community

🗼 A glance of Keep

Keep is a simple CLI tool that contains everything you need to start creating Alerts.

  • 10s of providers ready to use with your own data
  • simple CLI tool to configure, trigger and test your alerts
  • easily deployable via docker, vercel, github actions, etc.

Brought to you by developers, EASY to use and managable by code.

🚀 Quickstart

Run locally

Try your first (mock) alert up and get it running in <5 minutes - Ready? Let's Go! ⏰

First, clone Keep repository:
git clone https://github.com/keephq/keep.git && cd keep
Install Keep CLI
pip install .

or

poetry install
From now on, Keep should be installed locally and accessible from your CLI, test it by executing:
keep version
Get a Slack Incoming Webhook using [this tutorial](https://api.slack.com/messaging/webhooks) and use use Keep to configure it
keep config provider --provider-type slack --provider-id slack-demo

Paste the Slack Incoming Webhook URL (e.g. https://hooks.slack.com/services/...) and you're good to go 👌

Let's now execute our example "Paper DB has insufficient disk space" alert
keep run --alerts-file examples/alerts/db_disk_space.yml
Congrats 🥳 You should have received your first "Dunder Mifflin Paper Company" alert in Slack by now.

Wanna have your alerts up and running in production? Go through our more detailed Getting Started Guide.

🚨 Out of the box support for common providers

We tried our best to cover all common providers, missing any?, providers include:

  • Cloud: AWS, GCP, Azure, etc.
  • Monitoring: Sentry, New Relic, Datadog, etc.
  • Incident Management: PagerDuty, OpsGenie, etc.
  • Communication: Email, Slack, Console, etc.
  • and more...

🔍 Learn more

💪 Contributors

Thank you for contributing and continuously making Keep better, you're awesome 🫶