Package: keephq
The open-source alerts management and automation platformWhy Keep?·Getting started·Supported tools and integrations·Docs·Try it out·Website·Report Bug·Slack CommunityKeep makes it easy to consolidate all your alerts into a single pane of glass and to orchestrate workflows to automate your end-to-end processes.Enrich any tool withDatadog Workflow Automationlike capabilities.How does it work?Connect your tools: Connect everything from monitoring platforms to databases and ticketing systems.Connect providersReceive alertsSet up Workflows: Initiate automated workflows in response to alerts or based on custom intervals.Create and upload workflowsOperational efficiency: Automate your alert handling to focus your team's efforts on what really matters.Why Keep?Centralized dashboard: Manage all your alerts across different platforms in a single interface.Noise reduction: Deduplicate and correlate alerts to reduce alert fatigue.Automation: Trigger workflows for alert enrichment and response.Developer-first: Keep is API-first and lets you manage your workflows as code.Works with every tool: Plenty ofsupported providersand more to come.WorkflowsThe 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-workflowdescription:send a slack message when a cloudwatch alarm is triggered# workflow triggers - supports alerts, interval, and manual triggerstriggers:-type:alertfilters:-key:sourcevalue:cloudwatch-type:manual# list of steps that can add context to your alertsteps:-name:enrich-alert-with-more-data-from-a-databaseprovider:type:bigqueryconfig:"{{providers.bigquery-prod}}"with:query:"SELECTcustomer_id,customer_typeasdateFROM`customers_prod`LIMIT1"# list of actions that can automate response and do things with your alertactions:-name:trigger-slackprovider:type:slackconfig:"{{providers.slack-prod}}"with:message:"Gotalarmfromawscloudwatch!{{alert.name}}"Workflow triggers can either be executed manually when an alert is activated or run at predefined intervals. More examples can be foundhere.Supported ProvidersMissing any? Just submit anew provider issueand we will add it in the blink of an eye.Observability toolsDatabases and data warehousesCommunication platformsIncident Management toolsTicketing toolsGetting StartedOverviewKeep composed of three main components:Keep UI- A NextJS app to connect your providers, centralize alerts and create the workflows.Keep Backend- A FastAPI server that implements the business logic behind Keep, including integrating with the tools, working with alerts and scheduling and running the workflows.Keep CLI- A CLI that lets you control and manage Keep via CLI.Disclaimer: we usePostHogto collect anonymous telemetries to better learn how users use Keep (masked screen recordings for CLI commands)
To turn PostHog off, set theDISABLE_POSTHOG=trueenvironment variable and remove theNEXT_PUBLIC_POSTHOG_KEYenvironment variable.QuickstartSpinning up Keep with docker-composeThe easiest way to start with Keep is to run it via docker-compose:wget-Odocker-compose.ymlhttps://raw.githubusercontent.com/keephq/keep/main/docker-compose.yml
docker-compose-fdocker-compose.ymlupThe UI is now available athttp://localhost:3000and the backend is available athttp://localhost:8080.Local developmentYou can also start Keep within your favorite IDE, e.g.VSCodeWanna get Keep up and running in production? Go through our detaileddevelopment guide🫵 KeepersThank you for contributing and continuously makingKeepbetter,you're awesome🫶