forked from keephq/keep
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into bug-2025-workflow-execution
- Loading branch information
Showing
87 changed files
with
4,304 additions
and
1,175 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
openapi: get /alerts/quality/metrics | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
openapi: post /incidents/{incident_id}/comment | ||
--- |
3 changes: 3 additions & 0 deletions
3
docs/api-ref/incidents/get-future-incidents-for-an-incident.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
openapi: get /incidents/{incident_id}/future_incidents | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
openapi: get /incidents/{incident_id}/workflows | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
openapi: get /incidents/meta | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
openapi: post /incidents/merge | ||
--- |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
--- | ||
title: 'Checkmk' | ||
sidebarTitle: 'Checkmk Provider' | ||
description: 'Checkmk provider allows you to get alerts from Checkmk via webhooks.' | ||
--- | ||
|
||
## Overview | ||
|
||
The Checkmk provider enables seamless integration between Keep and Checkmk. It allows you to get alerts from Checkmk to Keep via webhooks making it easier to manage your infrastructure and applications in one place. | ||
|
||
## Connecting Checkmk to Keep | ||
|
||
To connect Checkmk to Keep, you need to configure it as a webhook from Checkmk. Follow the steps below to set up the integration: | ||
|
||
1. Keep webhook script need to installed on the Checkmk server. | ||
|
||
2. You can download the Keep webhook script using the following command: | ||
|
||
```bash | ||
wget -O webhook-keep.py https://github.com/keephq/keep/blob/main/keep/providers/checkmk_provider/webhook-keep.py?raw=true | ||
``` | ||
|
||
3. Copy the downloaded script to the following path on the Checkmk server: | ||
|
||
If you are using Checkmk Docker container, then copy it to the following path according to your docker volume mapping: | ||
|
||
```bash | ||
cp webhook-keep.py /omd/sites/<site_name>/local/share/check_mk/notifications/webhook-keep.py | ||
cd /omd/sites/<site_name>/local/share/check_mk/notifications | ||
``` | ||
|
||
If you are using Checkmk installed on the server, then copy it to the following path: | ||
|
||
```bash | ||
cp webhook-keep.py ~/local/share/check_mk/notifications/webhook-keep.py | ||
cd ~/local/share/check_mk/notifications | ||
``` | ||
|
||
4. Make the script executable: | ||
|
||
```bash | ||
chmod +x webhook-keep.py | ||
``` | ||
|
||
5. Now go to the Checkmk web interface and navigate to Setup | ||
|
||
<Frame | ||
width="100" | ||
height="200"> | ||
<img height="10" src="/images/checkmk-provider_1.png" /> | ||
</Frame> | ||
|
||
6. Click on Notifications under Events | ||
|
||
<Frame | ||
width="100" | ||
height="200"> | ||
<img height="10" src="/images/checkmk-provider_2.png" /> | ||
</Frame> | ||
|
||
6. Click on Add rule | ||
|
||
<Frame | ||
width="100" | ||
height="200"> | ||
<img height="10" src="/images/checkmk-provider_3.png" /> | ||
</Frame> | ||
|
||
7. In the Notifications method method, select "webhook-keep" as the notification method. | ||
|
||
<Frame | ||
width="100" | ||
height="200"> | ||
<img height="10" src="/images/checkmk-provider_4.png" /> | ||
</Frame> | ||
|
||
8. Configure the Rule properties, Contact selections, and Conditions according to your requirements. | ||
|
||
9. The first parameter is the Webhook URL of Keep which is `https://api.keephq.dev/alerts/event/checkmk`. | ||
|
||
10. The second parameter is the API Key of Keep which you can generate in the [Keep settings](https://platform.keephq.dev/settings?selectedTab=users&userSubTab=api-keys). | ||
|
||
11. Click on Save to save the configuration. | ||
|
||
12. Now you will start receiving alerts from Checkmk to Keep via webhooks when the configured conditions are met. | ||
|
||
## Useful Links | ||
|
||
- [Checkmk](https://checkmk.com/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
title: "Graylog Provider" | ||
sidebarTitle: "Graylog Provider" | ||
description: "The Graylog provider enables webhook installations for receiving alerts in Keep" | ||
--- | ||
|
||
## Overview | ||
|
||
The **Graylog Provider** facilitates receiving alerts from Graylog by setting up Webhook connections. It allows seamless integration with Graylog to receive notifications about events and alerts through Keep. | ||
|
||
## Authentication Parameters | ||
|
||
- **Username** (required): Username for authenticating with Graylog's API. | ||
- **Graylog Access Token** (required): Access token for authenticating with Graylog's API. | ||
- **Deployment Url** (required): Deployment URL for connecting to the Graylog instance (e.g., `http://localhost:9000`). | ||
|
||
## Scopes | ||
|
||
- **authenticated**: Mandatory for all operations, ensures the user is authenticated. | ||
- **authorized**: Mandatory for querying incidents and managing resources, ensures the user has `Admin` privileges. | ||
|
||
## Connecting with the Provider | ||
|
||
1. Obtain the **username** and **access token** from your Graylog instance by following [Graylog's API Access Documentation](https://go2docs.graylog.org/current/setting_up_graylog/rest_api_access_tokens.htm?tocpath=Set%20up%20Graylog%7CGet%20Started%20with%20Graylog%7CREST%C2%A0API%7C_____3#CreateanAccessToken). | ||
2. Set the **deployment URL** to your Graylog instance's base URL (e.g., `http://127.0.0.1:9000`). | ||
3. Ensure the user has the **Admin** role in Graylog. | ||
|
||
## Features | ||
|
||
The **Graylog Provider** supports the following key features: | ||
|
||
- **Webhook Setup**: Configures webhooks to send alerts to Keep. | ||
- **Alerts Retrieval**: Fetches and formats alerts from Graylog based on specified search parameters (only a maximum of 10000 most recent alerts) | ||
|
||
## Inputs for Query | ||
- **events_search_parameters**: Takes in a python dict | ||
Example: | ||
``` | ||
{ | ||
"filter": {"alerts": "only"}, | ||
"page": 1, | ||
"per_page": 1000, | ||
"query": "", | ||
"timerange": {"range": 86400, "type": "relative"}, | ||
} | ||
``` | ||
- You can modify this to fetch either alerts, events or both. | ||
|
||
--- | ||
|
||
**Note**: Ensure that the product of `page` and `per_page` does not exceed 10,000. | ||
|
||
--- | ||
|
||
## Useful Links | ||
|
||
- [Graylog API Documentation](https://go2docs.graylog.org/current/what_is_graylog/what_is_graylog.htm?tocpath=What%20Is%20Graylog%253F%7C_____0) | ||
- [Graylog Access Token](https://go2docs.graylog.org/current/setting_up_graylog/rest_api_access_tokens.htm?tocpath=Set%20up%20Graylog%7CGet%20Started%20with%20Graylog%7CREST%C2%A0API%7C_____3#CreateanAccessToken) | ||
- [Quick Setup for Graylog & Integration with Keep](https://github.com/keephq/keep/keep/providers/graylog_provider/README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,8 @@ pids | |
*.pid | ||
*.seed | ||
|
||
!lib | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
|
Oops, something went wrong.