Skip to content

yuanzhongqiao/keep-AI

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

开源警报管理和自动化平台


为什么要保留? · 入门 · 支持的工具和集成 · 文档 · 试用 · 网站 · 报告错误 · Slack 社区

Keep 可以轻松地将所有警报整合到单一管理平台中,并编排工作流程以实现端到端流程的自动化。使用Datadog 工作流自动化

等功能丰富任何工具。

它是如何工作的?

  1. 连接您的工具:连接从监控平台到数据库和票务系统的所有内容。
连接提供商 接收提醒
  1. 设置工作流程:响应警报或根据自定义时间间隔启动自动化工作流程。
创建并上传工作流程
  1. 运营效率:自动化警报处理,将团队的精力集中在真正重要的事情上。

为什么要保留?

  1. 集中式仪表板:在单个界面中管理不同平台上的所有警报。
  2. 降噪:对警报进行重复数据删除和关联,以减少警报疲劳。
  3. 自动化:触发工作流程以丰富警报和响应。
  4. 开发人员优先:Keep 是 API 优先,可让您以代码形式管理工作流程。
  5. 适用于所有工具:大量受支持的提供商以及更多即将推出的提供商。

工作流程

考虑 Keep 中的工作流程的最简单方法是 GitHub Actions。 Keep 中的工作流的核心是一个声明性 YAML 文件,由触发器、步骤和操作组成,用于管理、丰富和自动化对警报的响应:

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 }}"

工作流触发器可以在警报激活时手动执行,也可以按预定义的时间间隔运行。更多示例可以在这里找到。

支持的提供商

还缺什么吗?只需提交一个新的提供商问题,我们就会立即添加它。

可观察性工具

                                                                            

                                                                 

数据库和数据仓库

                                

通讯平台

                                                                                       

事件管理工具

                                                                                       

票务工具

                                           

容器编排平台

          

入门

概述

Keep 由三个主要组件组成:

  1. Keep UI - 一个 NextJS 应用程序,用于连接您的提供商、集中警报并创建工作流程。
  2. Keep 后端- 一个 FastAPI 服务器,用于实现 Keep 背后的业务逻辑,包括与工具集成、处理警报以及调度和运行工作流程。
  3. Keep CLI - 可让您通过 CLI 控制和管理 Keep 的 CLI。

免责声明:我们使用PostHog收集匿名遥测数据,以更好地了解用户如何使用 Keep(CLI 命令的屏蔽屏幕记录)来关闭 PostHog,设置DISABLE_POSTHOG=true环境变量并删除NEXT_PUBLIC_POSTHOG_KEY环境变量。

快速开始

使用 docker-compose 启动 Keep

开始使用 Keep 的最简单方法是通过 docker-compose 运行它:

curl https://raw.githubusercontent.com/keephq/keep/main/start.sh | sh

UI 现在可在http://localhost:3000上使用,后端可在http://localhost:8080上使用。

在 Kubernetes/Openshift 上使用 Helm 启动 Keep

要使用 Helm 将 Keep 安装到 Kubernetes 中,请运行以下命令:

helm repo add keephq https://keephq.github.io/helm-charts
helm pull keephq/keep
helm install keep keephq/keep

有关 Helm 图表的更多信息可以在此处找到。

当地发展

您还可以在您最喜欢的 IDE(例如VSCode)中启动 Keep

想要在生产环境中保持正常运行吗?阅读我们详细的开发指南

🫵 守护者

杰出贡献者

特别感谢我们的杰出贡献者,他们帮助我们使 Keep 变得伟大。你太棒了!

想成为顶级贡献者吗?加入我们的 Slack 和 DM Tal、Shahar 或 Furkan。

贡献者

感谢您的贡献并不断让Keep变得更好,您太棒了🫶

About

开源警报管理和 AIOps 平台

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 71.2%
  • TypeScript 27.8%
  • Other 1.0%