Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: remake repo main README #2015

Closed
wants to merge 2 commits into from
Closed

feat: remake repo main README #2015

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5727e9
readme.md changes
4F24L Sep 28, 2024
14e9d0f
readme.md changes 2
4F24L Sep 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 59 additions & 55 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,99 +2,103 @@
<img src="/assets/keep.png?raw=true" width="86">
</div>

<h1 align="center">The open-source alert management and AIOps platform</h1>
<h1 align="center">Open-Source Alert Management and AIOps Platform</h1>

<div align="center">Single pane of glass, filtering, bi-directional integrations, alert correlation, workflows, enrichment, dashboards.
</br>AI correlation and AI summarization are under the limited preview (<a href="https://www.keephq.dev/meet-keep">Book a Demo</a>)</div>
</br>
<p align="center">
Centralized platform for managing alerts, workflows, integrations, dashboards, and AIOps features.
<br>AI Correlation and Summarization features available in <strong>limited preview</strong>
(<a href="https://www.keephq.dev/meet-keep">Book a Demo</a>).
</p>

<div align="center">
<a href="https://slack.keephq.dev">
<img src="https://img.shields.io/badge/Join-important.svg?color=4A154B&label=Slack&logo=slack&labelColor=334155&logoColor=f5f5f5" alt="Join Slack" /></a>
<a href="https://codecov.io/gh/keephq/keep" >
<img src="https://img.shields.io/badge/Join-Slack-important.svg?color=4A154B&logo=slack&labelColor=334155&logoColor=f5f5f5" alt="Join Slack" />
</a>
<a href="https://codecov.io/gh/keephq/keep">
<img src="https://codecov.io/gh/keephq/keep/branch/main/graph/badge.svg?token=2VT6XYMRGS"/>
</a>
</div>
<p align="center">
<a href="#why-keep">Why Keep?</a>
·
<a href="#getting-started">Getting started</a>
·
<a href="#supported-providers">Supported tools and integrations</a>
·
<a href="https://docs.keephq.dev">Docs</a>
·
<a href="https://platform.keephq.dev">Try it out</a>
·
<a href="https://keephq.dev">Website</a>
·
<a href="https://github.com/keephq/keep/issues/new?assignees=&labels=bug&template=bug_report.md&title=">Report Bug</a>
·
<a href="https://slack.keephq.dev">Slack Community</a>
</p>


## How does it work?
1. **Connect your tools**: Connect everything from monitoring platforms to databases and ticketing systems.
<div align="center">
<a href="#why-keep">Why Keep?</a> ·
<a href="#getting-started">Getting Started</a> ·
<a href="#supported-providers">Supported Providers</a> ·
<a href="https://docs.keephq.dev">Docs</a> ·
<a href="https://platform.keephq.dev">Try it out</a> ·
<a href="https://keephq.dev">Website</a> ·
<a href="https://github.com/keephq/keep/issues/new?assignees=&labels=bug&template=bug_report.md&title=">Report Bug</a> ·
<a href="https://slack.keephq.dev">Slack Community</a>
</div>

## How It Works

| Connect providers | Receive alerts |
|----------|----------|
| <img src="/assets/connect_providers.gif" /> | <img src="/assets/view_alerts.gif" /> |
### 1. Connect Your Tools
Integrate everything from monitoring platforms to databases and ticketing systems to receive and manage alerts.

<div align="center">
<table>
<tr>
<th>Connect Providers</th>
<th>Receive Alerts</th>
</tr>
<tr>
<td><img src="/assets/connect_providers.gif" /></td>
<td><img src="/assets/view_alerts.gif" /></td>
</tr>
</table>
</div>

2. **Set up Workflows**: Initiate automated workflows in response to alerts or based on custom intervals.
### 2. Set Up Workflows
Define automated workflows that trigger responses to alerts or operate on custom intervals.

<div align="center">
<p>Create and Upload Workflows</p>
<img src="/assets/upload_workflow.gif" />
</div>

### 3. Enhance Operational Efficiency
Automate alert management to reduce manual handling, allowing teams to focus on high-priority issues.

| Create and upload workflows |
|----------|
| <img src="/assets/upload_workflow.gif" /> |
---

</div>
## Why Choose Keep?

3. **Operational efficiency**: Automate your alert handling to focus your team's efforts on what really matters.
- **Centralized Dashboard**: Manage all alerts from multiple platforms through one unified interface.
- **Noise Reduction**: Deduplicate and correlate alerts to minimize alert fatigue.
- **Automation**: Trigger workflows to enrich alerts and automatically respond to incidents.
- **Developer-First Approach**: API-first design that supports managing workflows as code.
- **Integrations**: Seamless integration with numerous platforms and tools (see below).

---

## Why Keep?
1. **Centralized dashboard**: Manage all your alerts across different platforms in a single interface.
2. **Noise reduction**: Deduplicate and correlate alerts to reduce alert fatigue.
3. **Automation**: Trigger workflows for alert enrichment and response.
4. **Developer-first**: Keep is API-first and lets you manage your workflows as code.
5. **Works with every tool**: Plenty of [supported providers](#supported-providers) and more to come.
## Workflows

Workflows in Keep are similar to GitHub Actions. They are declarative YAML files composed of triggers, steps, and actions that help automate and respond to alerts. Below is an example of a basic workflow:

## 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:
```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
id: basic-slack-alert-workflow
description: Send a Slack message when a CloudWatch alarm is triggered.
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
- name: enrich-alert
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
query: "SELECT customer_id FROM `customers_prod` LIMIT 1"
actions:
- name: trigger-slack
- name: send-slack-message
provider:
type: slack
config: " {{ providers.slack-prod }} "
config: "{{ providers.slack-prod }}"
with:
message: "Got alarm from aws cloudwatch! {{ alert.name }}"
message: "CloudWatch alarm triggered: {{ 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](https://github.com/keephq/keep/tree/main/examples/workflows).

Expand Down Expand Up @@ -268,8 +272,8 @@ You can also start Keep within your favorite IDE, e.g. [VSCode](https://docs.kee
### Top Contributors
A special thanks to our top contributors who help us make Keep great. You are more than awesome!

- [Furkan](https://github.com/pehlicd)
- [Asharon](https://github.com/asharonbaltazar)
- [Tal](https://github.com/talboren)
- [Shahar Glazner](https://github.com/shahargl)

Want to become a top contributor? Join our Slack and DM Tal, Shahar, or Furkan.

Expand Down
Loading