detectkit 0.16.0__tar.gz → 0.16.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: detectkit
-Version: 0.16.0
+Version: 0.16.2
 Summary: Metric monitoring with automatic anomaly detection
 Author: detectkit team
 License: MIT

{detectkit-0.16.0 → detectkit-0.16.2}/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.0"
+__version__ = "0.16.2"
 
 from detectkit.core.interval import Interval
 from detectkit.core.models import ColumnDefinition, TableModel

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

@@ -293,20 +293,21 @@ class WebhookChannel(BaseAlertChannel):
             err = f"{ctx['error_type']}: {ctx['error_message']}".strip(": ")
             full("Error", code(err))
 
-        # Optional links block (dashboard_url is already the clickable title;
-        # surface bare URLs here too so they're visible/linkified on both).
-        link_lines = []
+        # Links block — kept as its own flexible field, but every entry is a
+        # compact clickable label, never a raw URL string. A Grafana dashboard
+        # URL can be a paragraph long once it carries variables; nobody should
+        # read that in an alert, so we hide it behind the label and render in the
+        # platform's link syntax. Holds dashboard + any extra links + the "how to
+        # read this alert" guide, joined by " · ".
+        link_parts = []
         if alert_data.dashboard_url:
-            link_lines.append(f"Dashboard: {alert_data.dashboard_url}")
+            link_parts.append(self._link_markup(alert_data.dashboard_url, "Dashboard"))
         for label, url in alert_data.links.items():
-            link_lines.append(f"{label}: {url}")
-        if link_lines:
-            full("Links", "\n".join(link_lines))
-
-        # "How to read this alert" — the last field, a bare URL (auto-linkified on
-        # both Slack and Mattermost) pointing readers at the interpretation guide.
+            link_parts.append(self._link_markup(url, label))
         if ctx["help_url"]:
-            full(ctx["help_label"], ctx["help_url"])
+            link_parts.append(self._link_markup(ctx["help_url"], ctx["help_label"]))
+        if link_parts:
+            full("Links", " · ".join(link_parts))
 
         # A plain-text one-liner for notification previews / unsupported clients.
         if kind == "no_data":
@@ -328,6 +329,19 @@ class WebhookChannel(BaseAlertChannel):
             "mrkdwn_in": ["text", "fields"],
         }
 
+    def _link_markup(self, url: str, label: str) -> str:
+        """Render *label* as a clickable link in the target platform's syntax.
+
+        Slack incoming webhooks (``hooks.slack.com``) use ``<url|label>``;
+        Mattermost and other webhooks use markdown ``[label](url)``. This keeps a
+        link a short clickable phrase instead of a raw URL — important because a
+        real dashboard URL (e.g. Grafana with many variables) can be extremely
+        long, and no one should have to read it inside an alert.
+        """
+        if "hooks.slack.com" in self.webhook_url:
+            return f"<{url}|{label}>"
+        return f"[{label}]({url})"
+
     @staticmethod
     def _unix_ts(ts: Any) -> int | None:
         """Epoch seconds (UTC) for a naive-UTC timestamp, or None on failure."""

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

@@ -167,9 +167,11 @@ config needed. Control it project-wide with `alert_help_url` in
 Per-channel rendering (defaults only; resolved by
 `ProjectConfig.resolve_alert_help_url`):
 
-- **Slack / Mattermost / generic webhook** — a bottom full-width attachment field
-  titled `How to read this alert` whose value is the bare URL (auto-linkified on
-  both platforms).
+- **Slack / Mattermost / generic webhook** — a clickable `How to read this alert`
+  label in the compact `Links` field (alongside `Dashboard` + any extra links),
+  never a raw URL. Rendered in the platform's link syntax (Slack `<url|label>`,
+  Mattermost/generic markdown links) so a long dashboard URL stays hidden behind
+  its label.
 - **Telegram** — appended to the links line (after the optional "Open dashboard"
   link) as an `<a>` link reading `How to read this alert`.
 - **Email** — in the footer, after `Sent by detectkit · <project>` (and any CC),

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

@@ -55,8 +55,9 @@ dtk run --select <sel> [--steps load,detect,alert] [--from DATE] [--to DATE] \
 
 Sends a mock alert (fake value/CI/severity) through the metric's configured
 channels, using that alert config's own rule (`min_detectors` / `direction` /
-`consecutive_anomalies`), so the preview matches a real firing. Use it to
-verify webhook URLs, channel permissions, and custom templates.
+`consecutive_anomalies`) and the project-name `[name]` prefix, so the preview
+matches a real firing. Use it to verify webhook URLs, channel permissions, and
+custom templates.
 
 ## `dtk unlock --select <sel>`
 

{detectkit-0.16.0 → detectkit-0.16.2}/detectkit/cli/commands/test_alert.py

@@ -23,6 +23,7 @@ def create_mock_alert_data(
     alerting_config,
     timezone_display: str = "UTC",
     help_url: str | None = None,
+    project_name: str | None = None,
 ) -> AlertData:
     """
     Create realistic mock AlertData for testing.
@@ -36,6 +37,10 @@ def create_mock_alert_data(
         timezone_display: Timezone for display
         help_url: Resolved "how to read this alert" link to preview (the
             project's ``alert_help_url``); ``None`` renders no help link.
+        project_name: Project name from ``detectkit_project.yml`` — stamped so
+            the preview carries the same ``[name]`` prefix a real ``dtk run``
+            renders (the run pipeline sets it in ``_alert_step.py``); ``None``
+            renders no prefix.
 
     Returns:
         AlertData with mock anomaly data
@@ -90,6 +95,7 @@ def create_mock_alert_data(
         },
         consecutive_count=consecutive_required,
         mentions=mentions,
+        project_name=project_name,
         dashboard_url=getattr(alerting_config, "dashboard_url", None),
         links=dict(getattr(alerting_config, "links", {}) or {}),
         help_url=help_url,
@@ -123,7 +129,13 @@ def run_test_alert(metric_name: str, profile: str | None = None):
     with open(project_config_path) as f:
         project_data = yaml.safe_load(f)
 
-    metrics_dir_name = project_data.get("metrics_path", "metrics")
+    # Project name drives the [name] prefix a real `dtk run` stamps on every
+    # alert (see _alert_step.py); thread it so the preview matches a real firing.
+    project_name = project_data.get("name")
+
+    # Metrics dir lives under `paths.metrics` (default "metrics"); the old
+    # top-level `metrics_path` key is deprecated and ignored by ProjectConfig.
+    metrics_dir_name = (project_data.get("paths") or {}).get("metrics", "metrics")
 
     # Resolve the "how to read this alert" link so the preview matches what real
     # alerts would carry (brand default, a custom URL, or hidden via false).
@@ -187,7 +199,11 @@ def run_test_alert(metric_name: str, profile: str | None = None):
         print(f"   Channels: {', '.join(alerting_config.channels)}\n")
 
         alert_data = create_mock_alert_data(
-            metric_config, alerting_config, timezone_display, help_url=help_url
+            metric_config,
+            alerting_config,
+            timezone_display,
+            help_url=help_url,
+            project_name=project_name,
         )
 
         success_count = 0

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: detectkit
-Version: 0.16.0
+Version: 0.16.2
 Summary: Metric monitoring with automatic anomaly detection
 Author: detectkit team
 License: MIT