Skip to content

Latest commit

 

History

History
141 lines (106 loc) · 4.5 KB

README.md

File metadata and controls

141 lines (106 loc) · 4.5 KB
Raw
+ Missing a specific use case? no worries, hit us up and we will implement it for you! just open an issue.

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 »

Examples · 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.
  • Alerts are managed by simple yaml files that are human-readable

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

🚨 Providers

Providers are Keep's way of interacting with 3rd party products; Keep uses them either to query data or to send notifications.

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...

🚀 Quickstart

Run locally

Try our first mock alert and get it up and 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 shell
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 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
Voilà 🥳

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 Deployment Guide

🔍 Learn more

🫵 Keepers

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