detectkit 0.16.2__tar.gz → 0.16.4__tar.gz

{detectkit-0.16.2/detectkit.egg-info → detectkit-0.16.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: detectkit
-Version: 0.16.2
+Version: 0.16.4
 Summary: Metric monitoring with automatic anomaly detection
 Author: detectkit team
 License: MIT
@@ -185,6 +185,7 @@ for r in results:
 - [Configuration Guide](docs/guides/configuration.md) — all config options
 - [Detectors Guide](docs/guides/detectors.md) — choosing the right detector
 - [Alerting Guide](docs/guides/alerting.md) — channels, mentions, cooldown, recovery
+- [Reading Alerts](docs/guides/reading-alerts.md) — what a received alert means (for stakeholders)
 - [CLI Reference](docs/reference/cli.md) — command-line documentation
 - [Examples](docs/examples/) — real-world monitoring scenarios
 - [Changelog](CHANGELOG.md) — version history

{detectkit-0.16.2 → detectkit-0.16.4}/README.md

@@ -117,6 +117,7 @@ for r in results:
 - [Configuration Guide](docs/guides/configuration.md) — all config options
 - [Detectors Guide](docs/guides/detectors.md) — choosing the right detector
 - [Alerting Guide](docs/guides/alerting.md) — channels, mentions, cooldown, recovery
+- [Reading Alerts](docs/guides/reading-alerts.md) — what a received alert means (for stakeholders)
 - [CLI Reference](docs/reference/cli.md) — command-line documentation
 - [Examples](docs/examples/) — real-world monitoring scenarios
 - [Changelog](CHANGELOG.md) — version history

{detectkit-0.16.2 → detectkit-0.16.4}/detectkit/__init__.py

@@ -4,7 +4,7 @@ detectk - Anomaly Detection for Time-Series Metrics
 A Python library for data analysts and engineers to monitor metrics with automatic anomaly detection.
 """
 
-__version__ = "0.16.2"
+__version__ = "0.16.4"
 
 from detectkit.core.interval import Interval
 from detectkit.core.models import ColumnDefinition, TableModel

{detectkit-0.16.2 → detectkit-0.16.4}/detectkit/alerting/channels/email.py

@@ -315,13 +315,13 @@ class EmailChannel(BaseAlertChannel):
             parts.append(self._lead_html(ctx["description"]))
 
         if kind == "anomaly":
-            lead = (
-                f"Fired because the latest {ctx['consecutive_count']}/"
-                f"{ctx['consecutive_required']} consecutive points each met the quorum "
-                f"(min_detectors={ctx['min_detectors']}, direction "
-                f"{html.escape(str(ctx['direction_policy']))})."
+            parts.append(self._rule_html(ctx))
+            parts.append(
+                self._lead_html(
+                    f"Latest {ctx['consecutive_count']}/{ctx['consecutive_required']} "
+                    "consecutive points met the quorum."
+                )
             )
-            parts.append(self._lead_html(lead))
             parts.append(
                 self._stat_grid(
                     [
@@ -340,6 +340,7 @@ class EmailChannel(BaseAlertChannel):
                 "expected bounds."
             )
             parts.append(self._lead_html(lead))
+            parts.append(self._rule_html(ctx))
             parts.append(
                 self._stat_grid(
                     [
@@ -380,6 +381,26 @@ class EmailChannel(BaseAlertChannel):
             f"{html.escape(text)}</td></tr>"
         )
 
+    def _rule_html(self, ctx: dict[str, Any]) -> str:
+        """The configured firing rule: a bold ``Rule`` label + a monospace chip.
+
+        Mirrors the inline-code "Rule chip" the webhook/Telegram channels render,
+        so the same firing rule reads the same way in every channel.
+        """
+        expr = (
+            f"min_detectors={ctx['min_detectors']} &middot; "
+            f"direction={html.escape(str(ctx['direction_policy']))} &middot; "
+            f"consecutive={ctx['consecutive_required']}"
+        )
+        return (
+            f'<tr><td style="padding:0 24px 14px 24px;font-family:{_SANS};font-size:13px;'
+            f'color:{_MUTED};mso-line-height-rule:exactly;line-height:22px;">'
+            f'<strong style="color:{_INK};">Rule</strong>&nbsp;'
+            f'<code style="font-family:{_MONO};font-size:12px;background-color:{_PAPER};'
+            f'border:1px solid {_BORDER};border-radius:4px;padding:2px 6px;color:{_INK};">'
+            f"{expr}</code></td></tr>"
+        )
+
     def _stat_grid(self, pairs: list[tuple[str, str]]) -> str:
         """A 2-column grid of (label, value) cells (table-based)."""
         cells = ""

{detectkit-0.16.2 → detectkit-0.16.4}/detectkit/alerting/channels/telegram.py

@@ -167,9 +167,9 @@ class TelegramChannel(BaseAlertChannel):
                 f"<b>{ctx['consecutive_count']}/{ctx['consecutive_required']}</b> consecutive"
             )
             lines.append(
-                f"<i>Rule: min_detectors={ctx['min_detectors']} · "
+                f"<b>Rule</b> <code>min_detectors={ctx['min_detectors']} · "
                 f"direction={esc(ctx['direction_policy'])} · "
-                f"consecutive={ctx['consecutive_required']}</i>"
+                f"consecutive={ctx['consecutive_required']}</code>"
             )
             lines.append("")
             lines.append(
@@ -188,9 +188,9 @@ class TelegramChannel(BaseAlertChannel):
                 "expected bounds."
             )
             lines.append(
-                f"<i>Rule: min_detectors={ctx['min_detectors']} · "
+                f"<b>Rule</b> <code>min_detectors={ctx['min_detectors']} · "
                 f"direction={esc(ctx['direction_policy'])} · "
-                f"consecutive={ctx['consecutive_required']}</i>"
+                f"consecutive={ctx['consecutive_required']}</code>"
             )
             lines.append("")
             lines.append(

{detectkit-0.16.2 → detectkit-0.16.4}/detectkit/alerting/channels/webhook.py

@@ -256,11 +256,19 @@ class WebhookChannel(BaseAlertChannel):
         def code(s: str) -> str:
             return f"`{s}`" if s else ""
 
+        # The configured firing rule, set apart as a bold "Rule" label + an
+        # inline-code chip so it reads as "this is the config that fired" at a
+        # glance. Backticks render identically on Slack and Mattermost; the bold
+        # label is platform-aware (see ``_bold``).
+        rule_chip = f"{self._bold('Rule')} " + code(
+            f"min_detectors={ctx['min_detectors']} · "
+            f"direction={ctx['direction_policy']} · "
+            f"consecutive={ctx['consecutive_required']}"
+        )
+
         if kind == "anomaly":
             lead = (
-                f"Rule: min_detectors={ctx['min_detectors']} · "
-                f"direction={ctx['direction_policy']} · "
-                f"consecutive={ctx['consecutive_required']}. "
+                f"{rule_chip}\n"
                 f"Latest {ctx['consecutive_count']}/{ctx['consecutive_required']} "
                 "consecutive points met the quorum."
             )
@@ -275,9 +283,7 @@ class WebhookChannel(BaseAlertChannel):
         elif kind == "recovery":
             lead = (
                 "The alert condition no longer holds — the metric is back within "
-                f"expected bounds. Rule: min_detectors={ctx['min_detectors']} · "
-                f"direction={ctx['direction_policy']} · "
-                f"consecutive={ctx['consecutive_required']}."
+                f"expected bounds.\n{rule_chip}"
             )
             short("Value", code(ctx["value_display"]))
             short("Expected", code(ctx["expected_range"]))
@@ -329,6 +335,20 @@ class WebhookChannel(BaseAlertChannel):
             "mrkdwn_in": ["text", "fields"],
         }
 
+    def _bold(self, text: str) -> str:
+        """Render *text* bold in the target platform's markdown.
+
+        Slack mrkdwn uses ``*bold*``; Mattermost and generic webhooks use
+        CommonMark ``**bold**`` (where ``*x*`` would render as italic). Mirrors
+        the platform branch in :meth:`_link_markup`, detecting Slack from the
+        webhook host.
+        """
+        if not text:
+            return ""
+        if "hooks.slack.com" in self.webhook_url:
+            return f"*{text}*"
+        return f"**{text}**"
+
     def _link_markup(self, url: str, label: str) -> str:
         """Render *label* as a clickable link in the target platform's syntax.
 

{detectkit-0.16.2 → detectkit-0.16.4}/detectkit/cli/assets/claude/rules/alerting.md

@@ -213,6 +213,15 @@ leads with a colored **status circle** — 🔴 anomaly, 🟢 recovery, 🟡 no-
   table, a monospace params box, an optional "Open dashboard" button, and a
   footer. The plain-text body remains the multipart fallback.
 
+On anomaly **and** recovery alerts the **firing rule is set apart uniformly** in
+every default-rendered channel: a bold **Rule** label + an inline-code chip
+(`min_detectors=… · direction=… · consecutive=…`), with the quorum explanation
+on its own line, so the rule reads as "this is the config that fired" at a
+glance. Bold is platform-aware (`*Rule*` on Slack, `**Rule**` on
+Mattermost/generic; `<b>Rule</b>` on Telegram; `<strong>` in email), while the
+code chip is identical everywhere. Custom templates and the plain-text fallbacks
+are unchanged.
+
 ## Project label (multi-project channels)
 
 The bot keeps the **detectkit brand** name + avatar by default (so users rarely

{detectkit-0.16.2 → detectkit-0.16.4/detectkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: detectkit
-Version: 0.16.2
+Version: 0.16.4
 Summary: Metric monitoring with automatic anomaly detection
 Author: detectkit team
 License: MIT
@@ -185,6 +185,7 @@ for r in results:
 - [Configuration Guide](docs/guides/configuration.md) — all config options
 - [Detectors Guide](docs/guides/detectors.md) — choosing the right detector
 - [Alerting Guide](docs/guides/alerting.md) — channels, mentions, cooldown, recovery
+- [Reading Alerts](docs/guides/reading-alerts.md) — what a received alert means (for stakeholders)
 - [CLI Reference](docs/reference/cli.md) — command-line documentation
 - [Examples](docs/examples/) — real-world monitoring scenarios
 - [Changelog](CHANGELOG.md) — version history