Merge branch 'main' into feat-dashboards-re

35C4n0r · Oct 29, 2024 · 4adf359 · 4adf359
2 parents 797f248 + 0dbcd98
commit 4adf359
Show file tree

Hide file tree

Showing 94 changed files with 4,443 additions and 1,226 deletions.
diff --git a/README.md b/README.md
@@ -115,6 +115,8 @@ Workflow triggers can either be executed manually when an alert is activated or
     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
     <img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/grafana-icon.png?raw=true"/>
     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+    <img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/graylog-icon.png?raw=true"/>
+    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
     <img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/prometheus-icon.png?raw=true"/>
     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
     <img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/sumologic-icon.png?raw=true"/>
@@ -209,6 +211,8 @@ Workflow triggers can either be executed manually when an alert is activated or
     <img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/grafana_incident-icon.png?raw=true"/>
     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
     <img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/webhook-icon.png?raw=true"/>
+    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+    <img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/checkmk-icon.png?raw=true"/>
 </p>
 <h3 align="center">Ticketing tools</h2>
 <p align="center">

diff --git a/docs/api-ref/alerts/get-alert-quality.mdx b/docs/api-ref/alerts/get-alert-quality.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /alerts/quality/metrics
+---
diff --git a/docs/api-ref/incidents/add-comment.mdx b/docs/api-ref/incidents/add-comment.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /incidents/{incident_id}/comment
+---
diff --git a/docs/api-ref/incidents/get-future-incidents-for-an-incident.mdx b/docs/api-ref/incidents/get-future-incidents-for-an-incident.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /incidents/{incident_id}/future_incidents
+---
diff --git a/docs/api-ref/incidents/get-incident-workflows.mdx b/docs/api-ref/incidents/get-incident-workflows.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /incidents/{incident_id}/workflows
+---
diff --git a/docs/api-ref/incidents/get-incidents-meta.mdx b/docs/api-ref/incidents/get-incidents-meta.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /incidents/meta
+---
diff --git a/docs/api-ref/incidents/merge-incidents.mdx b/docs/api-ref/incidents/merge-incidents.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /incidents/merge
+---
diff --git a/docs/deployment/authentication/keycloak-auth.mdx b/docs/deployment/authentication/keycloak-auth.mdx
@@ -32,6 +32,7 @@ To start Keep with Keycloak authentication, set the following environment variab
 | AUTH_TYPE | Set to 'KEYCLOAK' for Keycloak authentication | Yes | - |
 | KEYCLOAK_ID | Your Keycloak client ID (e.g. keep) | Yes | - |
 | KEYCLOAK_ISSUER | Full URL to Your Keycloak issuer URL e.g. http://localhost:8181/auth/realms/keep | Yes | - |
+| KEYCLOAK_SECRET | Your Keycloak client secret | Yes | keep-keycloak-secret |
 
 #### Backend Environment Variables
 
@@ -50,5 +51,5 @@ To start Keep with Keycloak authentication, set the following environment variab
 ### Example configuration
 
 To get a better understanding on how to use Keep together with Keycloak, you can:
-- See [Keycloak](https://github.com/keephq/keep/tree/main/tests) directory for configuration, realm.json, etc
-- See Keep + Keycloak [docker-compose example](https://github.com/keephq/keep/blob/main/keycloak/docker-compose.yml)
+- See [Keycloak](https://github.com/keephq/keep/tree/main/keycloak) directory for configuration, realm.json, etc
+- See Keep + Keycloak [docker-compose example](https://github.com/keephq/keep/blob/main/keycloak/docker-compose.yaml)
diff --git a/docs/images/checkmk-provider_1.png b/docs/images/checkmk-provider_1.png
diff --git a/docs/images/checkmk-provider_2.png b/docs/images/checkmk-provider_2.png
diff --git a/docs/images/checkmk-provider_3.png b/docs/images/checkmk-provider_3.png
diff --git a/docs/images/checkmk-provider_4.png b/docs/images/checkmk-provider_4.png
diff --git a/docs/mint.json b/docs/mint.json
@@ -122,6 +122,7 @@
             "providers/documentation/bash-provider",
             "providers/documentation/bigquery-provider",
             "providers/documentation/centreon-provider",
+            "providers/documentation/checkmk-provider",
             "providers/documentation/clickhouse-provider",
             "providers/documentation/cloudwatch-provider",
             "providers/documentation/console-provider",
@@ -140,6 +141,7 @@
             "providers/documentation/grafana-provider",
             "providers/documentation/grafana_incident-provider",
             "providers/documentation/grafana_oncall-provider",
+            "providers/documentation/graylog-provider",
             "providers/documentation/http-provider",
             "providers/documentation/ilert-provider",
             "providers/documentation/incidentio-provider",
@@ -330,7 +332,8 @@
             "api-ref/alerts/unenrich-alert",
             "api-ref/alerts/search-alerts",
             "api-ref/alerts/get-alert-audit",
-            "api-ref/alerts/get-alerts"
+            "api-ref/alerts/get-alerts",
+            "api-ref/alerts/get-alert-quality"
           ]
         },
         {
@@ -365,7 +368,12 @@
             "api-ref/incidents/get-incident-alerts",
             "api-ref/incidents/add-alerts-to-incident",
             "api-ref/incidents/delete-alerts-from-incident",
-            "api-ref/incidents/confirm-incident"
+            "api-ref/incidents/confirm-incident",
+            "api-ref/incidents/add-comment",
+            "api-ref/incidents/get-future-incidents-for-an-incident",
+            "api-ref/incidents/get-incident-workflows",
+            "api-ref/incidents/get-incidents-meta",
+            "api-ref/incidents/merge-incidents"
           ]
         },
         {

diff --git a/docs/openapi.json b/docs/openapi.json
diff --git a/docs/providers/documentation/checkmk-provider.mdx b/docs/providers/documentation/checkmk-provider.mdx
@@ -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/)
diff --git a/docs/providers/documentation/graylog-provider.mdx b/docs/providers/documentation/graylog-provider.mdx
@@ -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)
diff --git a/docs/providers/overview.mdx b/docs/providers/overview.mdx
@@ -172,6 +172,14 @@ By leveraging Keep Providers, users are able to deeply integrate Keep with the t
   }
 ></Card>
 
+<Card
+  title="Checkmk"
+  href="/providers/documentation/checkmk-provider"
+  icon={
+    <img src="https://img.logo.dev/checkmk.com?token=pk_dfXfZBoKQMGDTIgqu7LvYg" />
+  }
+></Card>
+
 <Card
   title="Coralogix"
   href="/providers/documentation/coralogix-provider"
@@ -268,6 +276,14 @@ By leveraging Keep Providers, users are able to deeply integrate Keep with the t
   }
 ></Card>
 
+<Card
+  title="Graylog"
+  href="/providers/documentation/graylog-provider"
+  icon={
+    <img src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/graylog-icon.png?raw=true" />
+  }
+></Card>
+
 <Card
   title="HTTP"
   href="/providers/documentation/http-provider"

diff --git a/ee/identitymanager/identity_managers/keycloak/keycloak_authverifier.py b/ee/identitymanager/identity_managers/keycloak/keycloak_authverifier.py
@@ -1,4 +1,5 @@
 import os
+import logging
 
 from fastapi import Depends, HTTPException
 
@@ -8,6 +9,8 @@
 from keycloak.keycloak_uma import KeycloakUMA
 from keycloak.uma_permissions import UMAPermission
 
+logger = logging.getLogger(__name__)
+
 
 class KeycloakAuthVerifier(AuthVerifierBase):
     """Handles authentication and authorization for Keycloak"""
@@ -55,6 +58,10 @@ def _verify_bearer_token(
         email = payload.get("preferred_username")
         org_id = payload.get("active_organization", {}).get("id")
         org_realm = payload.get("active_organization", {}).get("name")
+        if org_id is None or org_realm is None:
+            logger.warning(
+                "Invalid Keycloak configuration - no org information for user. Check organization mapper: https://github.com/keephq/keep/blob/main/keycloak/keep-realm.json#L93"
+            )
         role = (
             payload.get("resource_access", {})
             .get(self.keycloak_client_id, {})

diff --git a/keep-ui/.gitignore b/keep-ui/.gitignore
@@ -8,6 +8,8 @@ pids
 *.pid
 *.seed
 
+!lib
+
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,8 @@ pids @@
     *.pid
     *.seed
+    !lib
     # Directory for instrumented libs generated by jscoverage/JSCover
     lib-cov
@@ Expand Down @@