Merge branch 'main' into bugifx/posthog

.github/workflows/test-pr.yml

@@ -4,10 +4,26 @@ on: [push, pull_request]
 env:
   PYTHON_VERSION: 3.11
   STORAGE_MANAGER_DIRECTORY: /tmp/storage-manager
+  MYSQL_ROOT_PASSWORD: keep
+  MYSQL_DATABASE: keep
 
 jobs:
   tests:
     runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ROOT_PASSWORD: ${{ env.MYSQL_ROOT_PASSWORD }}
+          MYSQL_DATABASE: ${{ env.MYSQL_DATABASE }}
+        ports:
+          - 3306:3306
+        options: >-
+          --health-cmd="mysqladmin ping"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=3
+
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -31,8 +47,17 @@ jobs:
           key: pydeps-${{ hashFiles('**/poetry.lock') }}
       - name: Install dependencies using poetry
         run: poetry install --no-interaction --no-root
+
       - name: Run unit tests and report coverage
-        run: poetry run coverage run --branch -m pytest
+        run: |
+          # Add a step to wait for MySQL to be fully up and running
+          until nc -z 127.0.0.1 3306; do
+            echo "waiting for MySQL..."
+            sleep 1
+          done
+          echo "MySQL is up and running!"
+          poetry run coverage run --branch -m pytest
+
       - name: Convert coverage results to JSON (for CodeCov support)
         run: poetry run coverage json --omit="keep/providers/*"
       - name: Upload coverage reports to Codecov

docs/mint.json

@@ -29,6 +29,7 @@
         "overview/introduction",
         "overview/keyconcepts",
         "overview/usecases",
+        "overview/ruleengine",
         "overview/examples",
         "overview/alternatives"
       ]

docs/overview/keyconcepts.mdx

@@ -3,7 +3,7 @@ title: "Key concepts"
 ---
 ## Alert
 Alert is an event that triggered when something bad happens or going to happen.
-The term "alert" can sometimes be interchanged with "alarm" (in CloudWatch) or "monitor" (in Datadog).
+The term "alert" can sometimes be interchanged with "alarm" (e.g. in CloudWatch) or "monitor" (e.g. in Datadog).
 
 You can easily initiate a [Workflow](#workflow) when an alert is triggered.
 

docs/overview/ruleengine.mdx

@@ -0,0 +1,27 @@
+---
+title: "Alert grouping"
+---
+
+The Keep Rule Engine is a versatile tool for grouping and consolidating alerts.
+This guide explains the core concepts, usage, and best practices for effectively utilizing the rule engine.
+
+<Note>Access the Rule Engine UI through the Keep platform by navigating to the Rule Builder section.</Note>
+
+## Core Concepts
+- **Rule definition**: A rule in Keep is a set of conditions that, when met, creates an alert group.
+- **Alert attributes**: These are characteristics or data points of an alert, such as source, severity, or any attribute an alert might have.
+- **Conditions and logic**: Rules are built by defining conditions based on alert attributes, using logical operators (like AND/OR) to combine multiple conditions.
+
+## Creating Rules
+Creating a rule involves defining the conditions under which an alert should be categorized or actions should be grouped.
+
+1. **Accessing the Rule Engine**: Navigate to the Rule Engine section in the Keep platform.
+2. **Defining rule criteria**:
+ - **Name the rule**: Assign a descriptive name that reflects its purpose.
+ - **Set conditions**: Use alert attributes to create conditions. For example, a rule might specify that an alert with a severity of 'critical' and a source of 'Prometheus' should be categorized as 'High Priority'.
+ - **Logical grouping**: Combine conditions using logical operators to form comprehensive rules.
+
+## Examples
+- **Metric-based alerts**: Construct a rule to pinpoint alerts associated with specific metrics, such as high CPU usage on servers. This can be achieved by grouping alerts that share a common attribute, like a 'CPU usage' tag, ensuring you quickly identify and address performance issues.
+- **Feature-related alerts**: Establish rules to organize alerts by specific features or services. For instance, you can group alerts based on a 'service' or 'URL' tag. This approach is particularly useful for tracking and managing alerts related to distinct functionalities or components within your application.
+- **Team-based alert management**: Implement rules to categorize alerts according to team responsibilities. This might involve grouping alerts based on the systems or services a particular team oversees. Such a strategy ensures that alerts are promptly directed to the appropriate team, enhancing response times and efficiency.

examples/workflows/elastic_enrich_example.yml

@@ -0,0 +1,78 @@
+# if no acknowledgement has been recieved (updated in index) for x (from config index) time, i want to escalate it to next level of people
+workflow:
+  id: elastic-enrich
+  description: escalate-if-needed
+  triggers:
+    # run every minute
+    - type: interval
+      value: 1m
+  steps:
+    # first, query the ack index to check if there are any alerts that have not been acknowledged
+    - name: query-ack-index
+      type: elastic
+      config: " {{ providers.elastic }} "
+      with:
+        index: your_ack_index
+        query: |
+          {
+            "query": {
+              "bool": {
+                "must": [
+                  {
+                    "match": {
+                      "acknowledged": false
+                    }
+                  }
+                ]
+              }
+            }
+          }
+    - name: query-config-index
+      type: elastic
+      config: " {{ providers.elastic }} "
+      with:
+        index: your_config_index
+        query: |
+          {
+            "query": {
+              "bool": {
+                "must": [
+                  {
+                    "match": {
+                      "config": true
+                    }
+                  }
+                ]
+              }
+            }
+          }
+    - name: query-people-index
+      type: elastic
+      config: " {{ providers.elastic }} "
+      with:
+        index: your_people_index
+        query: |
+          {
+            "query": {
+              "bool": {
+                "must": [
+                  {
+                    "match": {
+                      "people": true
+                    }
+                  }
+                ]
+              }
+            }
+          }
+  # now, we have the results from the ack index, config index, and people index
+  actions:
+    - name: escalate-if-needed
+      # if there are any alerts that have not been acknowledged
+      if: "{{ query-ack-index.hits.total.value }} > 0"
+      provider:
+        type: slack # or email or whatever you want
+        config: " {{ providers.slack }} "
+        with:
+          message: |
+           "A unacknowledged alert has been found: {{ query-ack-index.hits.hits }} {{ query-config-index.hits.hits }} {{ query-people-index.hits.hits }}"

keep-ui/app/alerts/alerts.tsx

@@ -177,9 +177,11 @@ export default function Alerts({
           combinedAlerts.forEach((alert) => {
             let alertKey = "";
             try {
-              alertKey = `${alert.id}-${alert.lastReceived.toISOString()}`;
+              alertKey = `${
+                alert.fingerprint
+              }-${alert.lastReceived.toISOString()}`;
             } catch {
-              alertKey = alert.id;
+              alertKey = alert.fingerprint;
             }
             uniqueObjectsMap.set(alertKey, alert);
           });

keep-ui/app/command-menu.tsx

@@ -15,6 +15,10 @@ import {
   KeyIcon,
   BriefcaseIcon,
 } from "@heroicons/react/24/outline";
+import { VscDebugDisconnect } from "react-icons/vsc";
+import { LuWorkflow } from "react-icons/lu";
+import { AiOutlineAlert } from "react-icons/ai";
+import { MdOutlineEngineering } from "react-icons/md";
 
 import "../styles/linear.scss";
 
@@ -95,19 +99,25 @@ export function CMDK() {
 
 const navigationItems = [
   {
-    icon: <ConnectIntegrationIcon />,
+    icon: <VscDebugDisconnect />,
     label: "Go to the providers page",
     shortcut: ["p"],
     navigate: "/providers",
   },
   {
-    icon: <GoToConsoleIcon />,
+    icon: <AiOutlineAlert />,
     label: "Go to alert console",
     shortcut: ["g"],
     navigate: "/alerts",
   },
   {
-    icon: <BriefcaseIcon />,
+    icon: <MdOutlineEngineering />,
+    label: "Go to alert groups",
+    shortcut: ["g"],
+    navigate: "/rules",
+  },
+  {
+    icon: <LuWorkflow />,
     label: "Go to the workflows page",
     shortcut: ["wf"],
     navigate: "/workflows",

keep-ui/app/globals.css

@@ -7,3 +7,7 @@
     display: none;
 }
 */
+.rules-tooltip [role="tooltip"] {
+    @apply w-72; /* This sets the width to 16rem. Adjust the number as needed. */
+    @apply break-words; /* This will wrap long words if needed. */
+  }

keep-ui/app/navbar-inner.tsx

@@ -5,12 +5,15 @@ import { signOut } from "next-auth/react";
 import { Fragment, useState } from "react";
 import {
   Bars3Icon,
-  BellAlertIcon,
-  BriefcaseIcon,
   DocumentTextIcon,
-  PuzzlePieceIcon,
   XMarkIcon,
 } from "@heroicons/react/24/outline";
+import { VscDebugDisconnect } from "react-icons/vsc";
+import { LuWorkflow } from "react-icons/lu";
+import { AiOutlineAlert } from "react-icons/ai";
+import { MdOutlineEngineering } from "react-icons/md";
+
+
 import Link from "next/link";
 import { Icon } from "@tremor/react";
 import { AuthenticationType } from "utils/authenticationType";
@@ -21,9 +24,10 @@ import { InternalConfig } from "types/internal-config";
 import { NameInitialsAvatar } from "react-name-initials-avatar";
 
 const navigation = [
-  { name: "Providers", href: "/providers", icon: PuzzlePieceIcon },
-  { name: "Alerts", href: "/alerts", icon: BellAlertIcon },
-  { name: "Workflows", href: "/workflows", icon: BriefcaseIcon },
+  { name: "Providers", href: "/providers", icon: VscDebugDisconnect },
+  { name: "Alerts", href: "/alerts", icon: AiOutlineAlert },
+  { name: "Alert Groups", href: "/rules", icon: MdOutlineEngineering},
+  { name: "Workflows", href: "/workflows", icon: LuWorkflow }
   // {
   //   name: "Notifications Hub",
   //   href: "/notifications-hub",

keep-ui/app/rules/layout.tsx

@@ -0,0 +1,15 @@
+import { Title, Subtitle } from "@tremor/react";
+
+export default function Layout({ children }: { children: any }) {
+  return (
+    <>
+      <main className="p-4 md:p-10 mx-auto max-w-full">
+        <Title>Alert Groups</Title>
+        <Subtitle>
+            Group multiple alerts into single alert
+        </Subtitle>
+        {children}
+      </main>
+    </>
+  );
+}

keep-ui/app/rules/page.tsx

@@ -0,0 +1,11 @@
+import RulesPage from "./rules.client";
+
+
+export default function Page() {
+  return <RulesPage />;
+}
+
+export const metadata = {
+  title: "Keep - Rules",
+  description: "Create Keep Rules.",
+};