Notifications
Why Keep? · Getting started · Supported tools and integrations · Docs · Try it out · Website · Report Bug · Slack Community
Connect providers | Receive alerts |
---|---|
Create and upload workflows |
---|
The easiest way of thinking about Workflow in Keep is GitHub Actions. At its core, a Workflow in Keep is a declarative YAML file, composed of triggers, steps, and actions and serves to manage, enrich, and automate responses to alerts:
workflow:
id: most-basic-keep-workflow
description: send a slack message when a cloudwatch alarm is triggered
# workflow triggers - supports alerts, interval, and manual triggers
triggers:
- type: alert
filters:
- key: source
value: cloudwatch
- type: manual
# list of steps that can add context to your alert
steps:
- name: enrich-alert-with-more-data-from-a-database
provider:
type: bigquery
config: "{{ providers.bigquery-prod }}"
with:
query: "SELECT customer_id, customer_type as date FROM `customers_prod` LIMIT 1"
# list of actions that can automate response and do things with your alert
actions:
- name: trigger-slack
provider:
type: slack
config: " {{ providers.slack-prod }} "
with:
message: "Got alarm from aws cloudwatch! {{ alert.name }}"
Workflow triggers can either be executed manually when an alert is activated or run at predefined intervals. More examples can be found here.
Missing any? Just submit a new provider issue and we will add it in the blink of an eye.
Keep composed of three main components:
Disclaimer: we use PostHog to collect anonymous telemetries to better learn how users use Keep (masked screen recordings for CLI commands) To turn PostHog off, set the
DISABLE_POSTHOG=true
environment variable and remove theNEXT_PUBLIC_POSTHOG_KEY
environment variable.
The easiest way to start with Keep is to run it via docker-compose:
curl https://raw.githubusercontent.com/keephq/keep/main/start.sh | sh
The UI is now available at http://localhost:3000 and the backend is available at http://localhost:8080.
To install Keep to your Kubernetes ease free with Helm, run the following commands:
helm repo add keephq https://keephq.github.io/helm-charts
helm pull keephq/keep
helm install keep keephq/keep
More information about the Helm chart can be found here.
You can also start Keep within your favorite IDE, e.g. VSCode
A special thanks to our top contributors who help us make Keep great. You are more than awesome!
Want to become a top contributor? Join our Slack and DM Tal, Shahar, or Furkan.
Thank you for contributing and continuously making Keep better, you're awesome 🫶