Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

feat(dashboards): add a metrics table widget with one row per label value (#122790)

Daniel Visca3a16bc48893d
diff --git a/frontend/snapshots.yml b/frontend/snapshots.yml
index 20c8c31ac191..a889747be73c 100644
--- a/frontend/snapshots.yml
+++ b/frontend/snapshots.yml
@@ -6933,9 +6933,9 @@ snapshots:
products-dashboards-add-insight-to-dashboard-modal--with-more-insight-types--light:
hash: v1.k794b7964.6c001db5555f48832f11ae8d9dcc535dff4e22044bb6dfce15db3a2a522f1fa9.GQCxp64JkEqDCNEeSD6gPtc5rwlzjHFJ-QnZu4lRips
products-dashboards-dashboard-widgets-overview--all-widget-types--dark:
- hash: v1.k794b7964.c8ccf56e7a97ed764ef1b9feff1fbefb1e3b8677fbf34e950adb91fb8ad0c65a.SP6nwmHbLhfX64P11e8X6ceeDvQynhdRrSCHXsblts8
+ hash: v1.k794b7964.3b3689c002c42da7502405c35d4ebe2285aeaeda2015418d9e700bfe9dc47205.ByGuHj3aUBKZNgl5AzGDwbuMXT-HGQhG-Vcab7mz4Yw
products-dashboards-dashboard-widgets-overview--all-widget-types--light:
- hash: v1.k794b7964.76d3914773ce95c73661a095c09cd13d3886fc71ed8619b405b52d03af75309e.7h4Yavt5bAp86IDjoyzG4duYQRyU4pDb5kMndOnOut0
+ hash: v1.k794b7964.5e698b6d14402a5cec101c50a753e278e4df1ee6b6716173f979dd5fc1ca4ed8.lU9zONwMvT_2B6JdB4yli0CxsyWPoQZyPrag6_qyNv4
products-dashboards-dashboard-widgets-widget-types-activity-recent-events--default--dark:
hash: v1.k794b7964.c69d28ef03335511de9b7dd75d5ad1c0458272d5d8f340083cdb86acc3b3c888.KB3MNhE9xEjVSl9hmVpz2jLC0IAmOTvaVZBmrl3pNKs
products-dashboards-dashboard-widgets-widget-types-activity-recent-events--default--light:
@@ -7048,6 +7048,30 @@ snapshots:
hash: v1.k794b7964.4ae62d5f33b6c84c07ea4ba432e926a6932d8fce7032c5b97fa64aa7108b830e.YIiqojByDCspu7LkfSZvjalgZDPBtEgZ9Ik6VxowBPw
products-dashboards-dashboard-widgets-widget-types-logs-recent-logs-widget-settings--default--light:
hash: v1.k794b7964.6e8bbccc040e6efa945f7c581b7572d10b842114ce968c7a68534942e5a7bb5c.bFiSuo3krHeearnHMvK9Efsexc9ejeP4GqPsfkR2txw
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table--empty--dark:
+ hash: v1.k794b7964.4f059c7baaf27703213dd545b602a2895498f592d171381453d1f826542d02ea.Zglpsr767jz-_6zt0OahlYMiaVcXH9hCTinkPNAvUYA
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table--empty--light:
+ hash: v1.k794b7964.ca66faf69abd527fb52fc4d98ec6d0dd3a89a6486799ef5fb61f47081858e157.Wp0BoFLCuF6DxBtf8z7vVuJ0hK15cVaHlGtRiveBKto
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table--loading--dark:
+ hash: v1.k794b7964.03aca61bb0c8ea2f3d48e2addd43b5ba803fb83be6a2913468a8ff5335b0d9f2.eRvBnERxtmd3l9eyLLyCMaQhJHFM2-zTibHpnbCZZI8
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table--loading--light:
+ hash: v1.k794b7964.54abe4103afbd3d844f198b5935627f110110cb0504db7ce3c944195f804dc18.ac-70tksgF4sMOAMeeup0Tn1ec7JVashPi80RU7gNLo
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table--needs-configuration--dark:
+ hash: v1.k794b7964.73dcf83852546ff4b2a9ebd6344abc8f6775f301e9c3b36764e7a61a062b726f.Lc7N5LRfU4PcPc3iWvPaO7Hu4aZfHbEcwNBc4OKXhos
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table--needs-configuration--light:
+ hash: v1.k794b7964.2e0bac53ede71c768bb6ab108a721aecbdc049a0173a4b1c0a2193afd4e97771.RpTMNdHSzOxfHSEfGwcoACYPgV6xrT-dlk-2fyCuNrg
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table--populated--dark:
+ hash: v1.k794b7964.6cd7457cfdc85c6490992ef5183b8980f4f754fe56969e46753678607cb2034e.x1xmmJY_75Pofu1CIGj1F7jcG5vgT7UQviMC9FFkUnQ
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table--populated--light:
+ hash: v1.k794b7964.3c1d2490adb00af4bb4bc8511f44859314ae67af1ec35377185c9b64440b427c.ttT7T_9QP09WegASXIzXJ1Gl8FETEAr5snEq-BUSsp8
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table-widget-settings--default--dark:
+ hash: v1.k794b7964.beebe02f4c8beb3d2d0ebb2b48170612875433c65c51e62813ed213aaba4ce96.Dj5HdyBBSxNcb7P6b-l_NNcD3d8RK1-IUoUT3bQwc5w
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table-widget-settings--default--light:
+ hash: v1.k794b7964.7171961a60bd6a37343623923eb660ae317cc46a386eef36180f7e8463cdde11.21ZWnOQBA2U-pSWA70vFP9H6MKO8G7oPxkyAphEjzr4
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table-widget-settings--http-endpoints--dark:
+ hash: v1.k794b7964.107de478f533691402a10398806190f09e5a4bb40c5101ea57e8a0b912f90ca4.uYwHCrI1qLdkjFW9C7ifT2Z9QIogglIsL6f8h9m_VCM
+ products-dashboards-dashboard-widgets-widget-types-metrics-metrics-table-widget-settings--http-endpoints--light:
+ hash: v1.k794b7964.f3de9f26922943f2b0bb0653106553fa3f85156d0ca751a45ef2f602544b5f9e.KLSbgynV_Ybu8RAsSnGyHl99aJq3eQGyeLvzemOcIBY
products-dashboards-dashboard-widgets-widget-types-session-replay-recent-recordings--default--dark:
hash: v1.k794b7964.7177219f56d7df8c842229dc6fbf23a9bd463d51b97061640cf42f9752e0498d.mgZy3jf_6a54_CDi6PLHvryOAqzA_XPVc1tk_1mboBc
products-dashboards-dashboard-widgets-widget-types-session-replay-recent-recordings--default--light:
diff --git a/posthog/settings/web.py b/posthog/settings/web.py
index 39e96b7a7d0b..2cd8ae503637 100644
--- a/posthog/settings/web.py
+++ b/posthog/settings/web.py
@@ -849,6 +849,7 @@ SPECTACULAR_SETTINGS = {
"NotebookWidgetTypeEnum": ["notebook_widget"],
"ConversationsRecentTicketsWidgetTypeEnum": ["conversations_recent_tickets"],
"CanvasAppWidgetTypeEnum": ["canvas_app"],
+ "MetricsTableWidgetTypeEnum": ["metrics_table"],
}
),
}
diff --git a/products/dashboards/backend/api/dashboard.py b/products/dashboards/backend/api/dashboard.py
index a3f77699fcf7..e99120e7a25b 100644
--- a/products/dashboards/backend/api/dashboard.py
+++ b/products/dashboards/backend/api/dashboard.py
@@ -4,10 +4,12 @@ import re
import json
import uuid
import builtins
-from collections.abc import AsyncGenerator, Mapping
+import contextvars
+from collections.abc import AsyncGenerator, Callable, Mapping
from concurrent.futures import ThreadPoolExecutor, as_completed
from contextlib import nullcontext
from enum import StrEnum
+from functools import partial
from typing import Any, Optional, TypedDict, cast
from django.conf import settings
@@ -419,6 +421,10 @@ class _RunWidgetQueryWorkItem(TypedDict):
user: User | None
+def _run_in_context(context: contextvars.Context, work: Callable[[], dict[str, Any]]) -> dict[str, Any]:
+ return context.run(work)
+
+
def _run_widget_query(
team: Team,
work_item: _RunWidgetQueryWorkItem,
@@ -3979,13 +3985,19 @@ class DashboardsViewSet(
if query_work_items:
max_workers = min(RUN_WIDGETS_QUERY_CONCURRENCY, len(query_work_items))
with ThreadPoolExecutor(max_workers=max_workers) as executor:
+ # Each worker gets a copy of the request context, so the query tags (such as the API key
+ # access method that the metrics concurrency limits read) reach the widget query.
futures = {
executor.submit(
- _run_widget_query,
- self.team,
- work_item,
- dashboard_id=dashboard.id,
- distinct_id=distinct_id,
+ _run_in_context,
+ contextvars.copy_context(),
+ partial(
+ _run_widget_query,
+ self.team,
+ work_item,
+ dashboard_id=dashboard.id,
+ distinct_id=distinct_id,
+ ),
): work_item["tile_id"]
for work_item in query_work_items
}
diff --git a/products/dashboards/backend/api/test/test_metrics_table_widget.py b/products/dashboards/backend/api/test/test_metrics_table_widget.py
new file mode 100644
index 000000000000..4ee8d0719088
--- /dev/null
+++ b/products/dashboards/backend/api/test/test_metrics_table_widget.py
@@ -0,0 +1,253 @@
+import datetime as dt
+from typing import Any
+
+from posthog.test.base import APIBaseTest, ClickhouseTestMixin
+from unittest.mock import patch
+
+from django.test import SimpleTestCase
+from django.utils import timezone
+
+from parameterized import parameterized
+from rest_framework import status
+from rest_framework.exceptions import ValidationError
+
+from posthog.api.test.dashboards import DashboardAPI
+from posthog.clickhouse.query_tagging import get_query_tag_value
+from posthog.models.personal_api_key import PersonalAPIKey
+from posthog.models.utils import generate_random_token_personal, hash_key_value
+
+from products.dashboards.backend.constants import METRICS_TABLE_SPARKLINE_POINTS
+from products.dashboards.backend.widget_registry import METRICS_TABLE_WIDGET_TYPE, validate_widget_config
+from products.metrics.backend.facade.testing import seed_metric, truncate_metrics_tables
+
+QUEUE_COLUMN = {"label": "Queue depth", "metricName": "queue_depth", "aggregation": "avg"}
+ERRORS_COLUMN = {
+ "label": "Errors",
+ "metricName": "request_errors",
+ "aggregation": "sum",
+ "filters": [{"key": "status", "op": "eq", "value": "error"}],
+}
+
+
+class TestMetricsTableWidgetConfig(SimpleTestCase):
+ def test_config_defaults_to_unconfigured(self) -> None:
+ validated = validate_widget_config(METRICS_TABLE_WIDGET_TYPE, {})
+ assert validated.get("groupBy") is None
+ assert validated["columns"] == []
+ assert validated["limit"] == 25
+ assert validated["orderDirection"] == "DESC"
+
+ def test_accepts_a_histogram_quantile_column(self) -> None:
+ column = {
+ "label": "p95",
+ "metricName": "http_server_duration_seconds",
+ "aggregation": "histogram_quantile",
+ "quantile": 0.95,
+ }
+ validated = validate_widget_config(METRICS_TABLE_WIDGET_TYPE, {"groupBy": "http.route", "columns": [column]})
+ assert validated["columns"][0]["quantile"] == 0.95
+
+ def test_accepts_six_columns_and_a_point_spacing(self) -> None:
+ validated = validate_widget_config(
+ METRICS_TABLE_WIDGET_TYPE, {"columns": [QUEUE_COLUMN] * 6, "interval": "minute_5"}
+ )
+ assert len(validated["columns"]) == 6
+ assert validated["interval"] == "minute_5"
+
+ @parameterized.expand(
+ [
+ ("unknown_key", {"evil": True}),
+ ("too_many_columns", {"groupBy": "route", "columns": [QUEUE_COLUMN] * 7}),
+ ("unknown_interval", {"interval": "minute_7"}),
+ ("quantile_missing", {"columns": [{**QUEUE_COLUMN, "aggregation": "histogram_quantile"}]}),
+ ("quantile_without_histogram", {"columns": [{**QUEUE_COLUMN, "quantile": 0.5}]}),
+ (
+ "quantile_out_of_range",
+ {"columns": [{**QUEUE_COLUMN, "aggregation": "histogram_quantile", "quantile": 1}]},
+ ),
+ ("unknown_aggregation", {"columns": [{**QUEUE_COLUMN, "aggregation": "median"}]}),
+ (
+ "unknown_filter_op",
+ {"columns": [{**ERRORS_COLUMN, "filters": [{"key": "a", "op": "gt", "value": "1"}]}]},
+ ),
+ ("order_column_out_of_range", {"columns": [QUEUE_COLUMN], "orderByColumn": 1}),
+ ("limit_above_max", {"limit": 101}),
+ ("date_range_wider_than_metrics_queries_allow", {"dateRange": {"date_from": "-90d"}}),
+ ]
+ )
+ def test_rejects_invalid_config(self, _name: str, config: dict[str, Any]) -> None:
+ with self.assertRaises(ValidationError):
+ validate_widget_config(METRICS_TABLE_WIDGET_TYPE, config)
+
+
+class TestMetricsTableWidgetRun(ClickhouseTestMixin, APIBaseTest):
+ CLASS_DATA_LEVEL_SETUP = True
+ now: dt.datetime
+
+ @classmethod
+ def setUpTestData(cls) -> None:
+ super().setUpTestData()
+ truncate_metrics_tables()
+ cls.now = timezone.now().replace(second=0, microsecond=0)
+ minutes = range(2, 12)
+ for route, depth in (("/api/a", 5.0), ("/api/b", 10.0), ("/api/c", 1.0)):
+ seed_metric(
+ team_id=cls.team.id,
+ metric_name="queue_depth",
+ points=[(cls.now - dt.timedelta(minutes=m), depth) for m in minutes],
+ labels={"route": route},
+ )
+ # Only /api/b has errors, so the other rows have no value in the errors column.
+ for status_value, count in (("error", 3.0), ("ok", 50.0)):
+ seed_metric(
+ team_id=cls.team.id,
+ metric_name="request_errors",
+ points=[(cls.now - dt.timedelta(minutes=m), count) for m in minutes],
+ labels={"route": "/api/b", "status": status_value},
+ )
+
+ def setUp(self) -> None:
+ super().setUp()
+ self.dashboard_api = DashboardAPI(self.client, self.team, self.assertEqual)
+ self.metrics_flag_enabled = True
+ flag_patcher = patch(
+ "products.dashboards.backend.feature_flags.posthoganalytics.feature_enabled",
+ side_effect=lambda flag, *args, **kwargs: flag == "metrics" and self.metrics_flag_enabled,
+ )
+ flag_patcher.start()
+ self.addCleanup(flag_patcher.stop)
+
+ def _create_tile(self, config: dict[str, Any]) -> tuple[int, int]:
+ dashboard_id, _ = self.dashboard_api.create_dashboard({"name": "Endpoints"})
+ _, dashboard_json = self.dashboard_api.create_widget_tile(
+ dashboard_id, widget_type="metrics_table", config=config
+ )
+ return dashboard_id, dashboard_json["tiles"][0]["id"]
+
+ def _run_tile(self, dashboard_id: int, tile_id: int) -> dict[str, Any]:
+ response = self.client.get(
+ f"/api/projects/{self.team.id}/dashboards/{dashboard_id}/run_widgets/", {"tile_ids": str(tile_id)}
+ )
+ self.assertEqual(response.status_code, status.HTTP_200_OK, response.content)
+ return response.json()["results"][0]
+
+ def _run(self, config: dict[str, Any]) -> dict[str, Any]:
+ tile_result = self._run_tile(*self._create_tile(config))
+ self.assertIsNone(tile_result["error"])
+ return tile_result["result"]
+
+ def test_unconfigured_widget_asks_for_configuration(self) -> None:
+ result = self._run({})
+
+ assert result["needsConfiguration"] is True
+ assert result["rows"] == []
+
+ def test_returns_one_row_per_label_value_sorted_by_the_order_column(self) -> None:
+ result = self._run(
+ {"groupBy": "route", "columns": [QUEUE_COLUMN, ERRORS_COLUMN], "dateRange": {"date_from": "-1h"}}
+ )
+
+ assert result["needsConfiguration"] is False
+ assert [column["label"] for column in result["columns"]] == ["Queue depth", "Errors"]
+ assert [row["key"] for row in result["rows"]] == ["/api/b", "/api/a", "/api/c"]
+ assert [row["values"][0] for row in result["rows"]] == [10.0, 5.0, 1.0]
+ assert [row["values"][1] for row in result["rows"]] == [3.0, None, None]
+ assert result["totalCount"] == 3
+ assert result["hasMore"] is False
+ sparkline = result["rows"][0]["sparklines"][0]
+ assert len(sparkline) > 1
+ assert all(value == 10.0 for value in sparkline if value)
+
+ def test_limit_and_ascending_order_keep_the_lowest_rows(self) -> None:
+ result = self._run({"groupBy": "route", "columns": [QUEUE_COLUMN], "orderDirection": "ASC", "limit": 2})
+
+ assert [row["key"] for row in result["rows"]] == ["/api/c", "/api/a"]
+ assert result["totalCount"] == 3
+ assert result["hasMore"] is True
+
+ def test_existing_tile_stops_returning_metrics_when_the_metrics_flag_is_off(self) -> None:
+ dashboard_id, tile_id = self._create_tile({"groupBy": "route", "columns": [QUEUE_COLUMN]})
+ self.metrics_flag_enabled = False
+
+ tile_result = self._run_tile(dashboard_id, tile_id)
+
+ assert tile_result["result"] is None
+ assert tile_result["error"] is not None
+
+ def test_new_tile_is_rejected_when_the_metrics_flag_is_off(self) -> None:
+ self.metrics_flag_enabled = False
+ dashboard_id, _ = self.dashboard_api.create_dashboard({"name": "Endpoints"})
+
+ response = self.client.post(
+ f"/api/projects/{self.team.id}/dashboards/{dashboard_id}/widgets/batch/",
+ {"widgets": [{"widget_type": METRICS_TABLE_WIDGET_TYPE, "config": {}}]},
+ format="json",
+ )
+
+ assert response.status_code == status.HTTP_400_BAD_REQUEST, response.content
+
+ @patch("products.metrics.backend.metric_query_runner._ROW_LIMIT", 100)
+ def test_many_label_values_over_a_long_range_stay_within_the_row_budget(self) -> None:
+ # At the default 6-hour interval, 5 routes over 14 days make 280 bucket rows, above the patched budget.
+ for route in ("/a", "/b", "/c", "/d", "/e"):
+ seed_metric(
+ team_id=self.team.id,
+ metric_name="worker_load",
+ points=[(self.now - dt.timedelta(hours=6 * step), 1.0) for step in range(56)],
+ labels={"route": route},
+ )
+ column = {"label": "Load", "metricName": "worker_load", "aggregation": "avg"}
+
+ result = self._run({"groupBy": "route", "columns": [column], "dateRange": {"date_from": "-14d"}})
+
+ assert result["totalCount"] == 5
+ assert all(len(row["sparklines"][0]) <= METRICS_TABLE_SPARKLINE_POINTS for row in result["rows"])
+
+ def test_widget_query_keeps_the_api_key_access_method_of_the_request(self) -> None:
+ dashboard_id, tile_id = self._create_tile({"groupBy": "route", "columns": [QUEUE_COLUMN]})
+ token = generate_random_token_personal()
+ PersonalAPIKey.objects.create(
+ label="dashboard metrics",
+ user=self.user,
+ secure_value=hash_key_value(token),
+ scopes=["dashboard:read", "query:read", "metrics:read"],
+ )
+ seen_access_methods: list[str | None] = []
+
+ def record_access_method(**_kwargs: Any) -> list[Any]:
+ seen_access_methods.append(get_query_tag_value("access_method"))
+ return []
+
+ with patch(
+ "products.dashboards.backend.widgets.metrics_table.run_metric_query", side_effect=record_access_method
+ ):
+ response = self.client.get(
+ f"/api/projects/{self.team.id}/dashboards/{dashboard_id}/run_widgets/",
+ {"tile_ids": str(tile_id)},
+ HTTP_AUTHORIZATION=f"Bearer {token}",
+ )
+
+ assert response.status_code == status.HTTP_200_OK, response.content
+ assert seen_access_methods == ["personal_api_key"]
+
+ def test_a_column_average_skips_buckets_that_only_another_column_fills(self) -> None:
+ seed_metric(
+ team_id=self.team.id,
+ metric_name="pool_size",
+ points=[(self.now - dt.timedelta(minutes=10), 10.0)],
+ labels={"route": "/api/pool"},
+ )
+ seed_metric(
+ team_id=self.team.id,
+ metric_name="pool_waiters",
+ points=[(self.now - dt.timedelta(minutes=40), 4.0)],
+ labels={"route": "/api/pool"},
+ )
+ columns = [
+ {"label": "Pool size", "metricName": "pool_size", "aggregation": "avg"},
+ {"label": "Waiters", "metricName": "pool_waiters", "aggregation": "avg"},
+ ]
+
+ result = self._run({"groupBy": "route", "columns": columns, "dateRange": {"date_from": "-1h"}})
+
+ assert [row["values"] for row in result["rows"]] == [[10.0, 4.0]]
diff --git a/products/dashboards/backend/api/test/test_widget_access.py b/products/dashboards/backend/api/test/test_widget_access.py
index 43091464d4cf..af53f61bd213 100644
--- a/products/dashboards/backend/api/test/test_widget_access.py
+++ b/products/dashboards/backend/api/test/test_widget_access.py
@@ -1,6 +1,7 @@
from posthog.test.base import BaseTest
from unittest.mock import MagicMock, patch
+from parameterized import parameterized
from rest_framework.exceptions import PermissionDenied
from posthog.auth import IDJagAccessTokenAuthentication, PersonalAPIKeyAuthentication
@@ -35,26 +36,34 @@ class TestWidgetAccess(BaseTest):
self.assertIsNone(get_widget_product_access_error(entry, UserAccessControl(self.user, self.team)))
- def test_registry_entry_denies_without_product_access(self) -> None:
- entry = get_widget_registry_entry("error_tracking_list")
+ @parameterized.expand(
+ [
+ ("error_tracking_list", "error_tracking", "You do not have access to error tracking."),
+ ("metrics_table", "metrics", "You do not have access to metrics."),
+ ]
+ )
+ def test_registry_entry_denies_without_product_access(
+ self, widget_type: str, denied_resource: str, expected_message: str
+ ) -> None:
+ entry = get_widget_registry_entry(widget_type)
assert entry is not None
user_access_control = UserAccessControl(self.user, self.team)
real_check = UserAccessControl.check_access_level_for_resource
- def deny_error_tracking_only(resource: APIScopeObject, required_level: AccessControlLevel = "viewer") -> bool:
- if resource == "error_tracking":
+ def deny_one_resource(resource: APIScopeObject, required_level: AccessControlLevel = "viewer") -> bool:
+ if resource == denied_resource:
return False
return real_check(user_access_control, resource, required_level)
with patch.object(
user_access_control,
"check_access_level_for_resource",
- side_effect=deny_error_tracking_only,
+ side_effect=deny_one_resource,
):
self.assertEqual(
get_widget_product_access_error(entry, user_access_control),
- "You do not have access to error tracking.",
+ expected_message,
)
def test_check_widget_tile_product_access_denies_unknown_widget_type(self) -> None:
@@ -74,17 +83,25 @@ class TestWidgetAccess(BaseTest):
self.assertIsNone(get_widget_api_scope_error(entry, request))
- def test_get_widget_api_scope_error_denies_missing_scope_on_pat(self) -> None:
- entry = get_widget_registry_entry("error_tracking_list")
+ @parameterized.expand(
+ [
+ ("error_tracking_list", ["dashboard:read"], "error_tracking:read"),
+ ("metrics_table", ["dashboard:read", "query:read"], "metrics:read"),
+ ]
+ )
+ def test_get_widget_api_scope_error_denies_missing_scope_on_pat(
+ self, widget_type: str, key_scopes: list[str], missing_scope: str
+ ) -> None:
+ entry = get_widget_registry_entry(widget_type)
assert entry is not None
authenticator = PersonalAPIKeyAuthentication()
- authenticator.personal_api_key = PersonalAPIKey(scopes=["dashboard:read"])
+ authenticator.personal_api_key = PersonalAPIKey(scopes=key_scopes)
request = MagicMock()
request.successful_authenticator = authenticator
self.assertEqual(
get_widget_api_scope_error(entry, request),
- "API key missing required scope 'error_tracking:read'",
+ f"API key missing required scope '{missing_scope}'",
)
def test_get_widget_api_scope_error_allows_write_scope_for_read_requirement(self) -> None:
diff --git a/products/dashboards/backend/api/test/test_widget_config_schema_parity.py b/products/dashboards/backend/api/test/test_widget_config_schema_parity.py
index beb266e98b58..6cef81ef9a7f 100644
--- a/products/dashboards/backend/api/test/test_widget_config_schema_parity.py
+++ b/products/dashboards/backend/api/test/test_widget_config_schema_parity.py
@@ -7,15 +7,22 @@ from products.dashboards.backend.constants import (
LOGS_LIST_DEFAULT_LIMIT,
LOGS_LIST_MAX_LIMIT,
MAX_WIDGET_RESULT_LIMIT,
+ METRICS_TABLE_DEFAULT_LIMIT,
+ METRICS_TABLE_MAX_LIMIT,
)
from products.dashboards.backend.widget_catalog import WIDGET_CATALOG
-from products.dashboards.backend.widget_specs.configs import ACTIVITY_EVENTS_LIST_WIDGET_TYPE, LOGS_LIST_WIDGET_TYPE
+from products.dashboards.backend.widget_specs.configs import (
+ ACTIVITY_EVENTS_LIST_WIDGET_TYPE,
+ LOGS_LIST_WIDGET_TYPE,
+ METRICS_TABLE_WIDGET_TYPE,
+)
from products.dashboards.backend.widget_specs.registry import WIDGET_SPECS
-# Activity events and logs allow a larger page than other list widgets; other types share the default bounds.
+# Activity events, logs and the metrics table allow a larger page than other list widgets; other types share the default bounds.
WIDGET_LIMIT_BOUNDS = {
ACTIVITY_EVENTS_LIST_WIDGET_TYPE: (ACTIVITY_EVENTS_MAX_LIMIT, ACTIVITY_EVENTS_DEFAULT_LIMIT),
LOGS_LIST_WIDGET_TYPE: (LOGS_LIST_MAX_LIMIT, LOGS_LIST_DEFAULT_LIMIT),
+ METRICS_TABLE_WIDGET_TYPE: (METRICS_TABLE_MAX_LIMIT, METRICS_TABLE_DEFAULT_LIMIT),
}
diff --git a/products/dashboards/backend/constants.py b/products/dashboards/backend/constants.py
index fba194870d3b..4ac8176385ad 100644
--- a/products/dashboards/backend/constants.py
+++ b/products/dashboards/backend/constants.py
@@ -20,6 +20,19 @@ ACTIVITY_EVENTS_MAX_PROPERTY_VALUE_LENGTH = 4000
LOGS_LIST_MAX_LIMIT = 100
LOGS_LIST_DEFAULT_LIMIT = 50
+# Metrics table: one metrics query clause per column, and one row per value of the group-by label.
+# The metrics query keeps at most 100 series per clause, so the row limit cannot go higher.
+# Six columns fit rate, errors and three percentiles side by side.
+METRICS_TABLE_MAX_COLUMNS = 6
+METRICS_TABLE_MAX_FILTERS = 5
+METRICS_TABLE_MAX_LIMIT = 100
+METRICS_TABLE_DEFAULT_LIMIT = 25
+# Points per sparkline, and also the bucket count of the query. A query returns one row per bucket and label
+# value, and the metrics query fails above its row budget, so fewer buckets leave room for more label values.
+METRICS_TABLE_SPARKLINE_POINTS = 30
+# Metrics queries span at most 31 days, so the longer widget presets are not allowed.
+METRICS_TABLE_UNSUPPORTED_DATE_FROM_VALUES = frozenset({"-90d"})
+
# Cap widgets per batch create / run-widgets request.
MAX_WIDGETS_BATCH_SIZE = 10
diff --git a/products/dashboards/backend/test/test_widget_layouts.py b/products/dashboards/backend/test/test_widget_layouts.py
index 32abd492506a..b077c4c84ca2 100644
--- a/products/dashboards/backend/test/test_widget_layouts.py
+++ b/products/dashboards/backend/test/test_widget_layouts.py
@@ -97,3 +97,11 @@ class TestWidgetLayouts:
assert first["sm"] == {"x": 0, "y": 0, "w": 6, "h": 5}
assert second["sm"] == {"x": 0, "y": 5, "w": 6, "h": 5}
+
+ def test_stack_widget_layout_at_bottom_places_metrics_table_full_width(self) -> None:
+ layout = stack_widget_layout_at_bottom(
+ widget_type="metrics_table",
+ existing_sm_layouts=[{"x": 0, "y": 0, "w": 6, "h": 4}, {"x": 6, "y": 0, "w": 6, "h": 11}],
+ )
+
+ assert layout["sm"] == {"x": 0, "y": 11, "w": 12, "h": 6}
diff --git a/products/dashboards/backend/widget_catalog.py b/products/dashboards/backend/widget_catalog.py
index 0f9acd64e04d..a82e6520729d 100644
--- a/products/dashboards/backend/widget_catalog.py
+++ b/products/dashboards/backend/widget_catalog.py
@@ -73,8 +73,9 @@ def get_widget_product_access_denied_message(required_product_access: str) -> st
def get_default_widget_layouts(widget_type: str) -> dict[str, dict[str, int]]:
- width = 6
- height = 5
+ spec = WIDGET_SPECS.get(widget_type)
+ width = spec.default_width if spec else 6
+ height = spec.default_height if spec else 5
return {
"sm": {"x": 0, "y": 0, "w": width, "h": height},
"xs": {"x": 0, "y": 0, "w": width, "h": height},
diff --git a/products/dashboards/backend/widget_registry.py b/products/dashboards/backend/widget_registry.py
index 7d353273f93f..a6ded6ae9958 100644
--- a/products/dashboards/backend/widget_registry.py
+++ b/products/dashboards/backend/widget_registry.py
@@ -12,6 +12,7 @@ from products.dashboards.backend.widget_specs.configs import (
ERROR_TRACKING_LIST_WIDGET_TYPE,
EXPERIMENT_RESULTS_WIDGET_TYPE,
EXPERIMENTS_LIST_WIDGET_TYPE,
+ METRICS_TABLE_WIDGET_TYPE,
SESSION_REPLAY_LIST_WIDGET_TYPE,
SURVEY_RESULTS_WIDGET_TYPE,
)
@@ -38,6 +39,7 @@ __all__ = [
"ERROR_TRACKING_LIST_WIDGET_TYPE",
"EXPERIMENT_RESULTS_WIDGET_TYPE",
"EXPERIMENTS_LIST_WIDGET_TYPE",
+ "METRICS_TABLE_WIDGET_TYPE",
"SESSION_REPLAY_LIST_WIDGET_TYPE",
"SURVEY_RESULTS_WIDGET_TYPE",
"EXPECTED_WIDGET_TYPES",
diff --git a/products/dashboards/backend/widget_specs/common.py b/products/dashboards/backend/widget_specs/common.py
index ae7874a110f7..6f1bd0c1b17f 100644
--- a/products/dashboards/backend/widget_specs/common.py
+++ b/products/dashboards/backend/widget_specs/common.py
@@ -10,6 +10,7 @@ from products.dashboards.backend.constants import (
ACTIVITY_EVENTS_MAX_LIMIT,
LOGS_LIST_MAX_LIMIT,
MAX_WIDGET_RESULT_LIMIT,
+ METRICS_TABLE_MAX_LIMIT,
WIDGET_DATE_FROM_VALUES_ORDERED,
)
@@ -98,3 +99,4 @@ class WidgetListConfigBase(WidgetDateRangeConfigBase):
WidgetLimit = Annotated[int, Field(ge=1, le=MAX_WIDGET_RESULT_LIMIT)]
ActivityWidgetLimit = Annotated[int, Field(ge=1, le=ACTIVITY_EVENTS_MAX_LIMIT)]
LogsWidgetLimit = Annotated[int, Field(ge=1, le=LOGS_LIST_MAX_LIMIT)]
+MetricsTableWidgetLimit = Annotated[int, Field(ge=1, le=METRICS_TABLE_MAX_LIMIT)]
diff --git a/products/dashboards/backend/widget_specs/configs.py b/products/dashboards/backend/widget_specs/configs.py
index 9781a2d4d0e2..2c356b80b99f 100644
--- a/products/dashboards/backend/widget_specs/configs.py
+++ b/products/dashboards/backend/widget_specs/configs.py
@@ -17,10 +17,15 @@ from products.dashboards.backend.constants import (
ACTIVITY_EVENTS_MAX_PROPERTY_VALUE_LENGTH,
DEFAULT_WIDGET_LIST_LIMIT,
LOGS_LIST_DEFAULT_LIMIT,
+ METRICS_TABLE_DEFAULT_LIMIT,
+ METRICS_TABLE_MAX_COLUMNS,
+ METRICS_TABLE_MAX_FILTERS,
+ METRICS_TABLE_UNSUPPORTED_DATE_FROM_VALUES,
)
from products.dashboards.backend.widget_specs.common import (
ActivityWidgetLimit,
LogsWidgetLimit,
+ MetricsTableWidgetLimit,
WidgetDateRange,
WidgetDateRangeConfigBase,
WidgetLimit,
@@ -38,6 +43,7 @@ LOGS_LIST_WIDGET_TYPE = "logs_list"
CONVERSATIONS_RECENT_TICKETS_WIDGET_TYPE = "conversations_recent_tickets"
NOTEBOOK_WIDGET_TYPE = "notebook_widget"
CANVAS_APP_WIDGET_TYPE = "canvas_app"
+METRICS_TABLE_WIDGET_TYPE = "metrics_table"
class CanvasAppWidgetConfig(BaseModel):
@@ -368,3 +374,81 @@ class ConversationsRecentTicketsWidgetConfig(BaseModel):
if not isinstance(value, str):
raise ValueError("savedViewId must be a string.")
return value
+
+
+# `rate` and `increase` sum the per-series change of a counter, so a row shows the total for its label value.
+MetricsTableAggregation = Literal["rate", "increase", "sum", "avg", "min", "max", "histogram_quantile"]
+MetricsTableFilterOp = Literal["eq", "neq", "regex", "not_regex"]
+MetricsTableInterval = Literal["minute", "minute_5", "minute_15", "hour", "day"]
+
+
+class MetricsTableFilter(BaseModel):
+ model_config = ConfigDict(extra="forbid")
+
+ key: str = Field(
+ min_length=1, max_length=200, description="Label key to filter on, e.g. `http.response.status_code`."
+ )
+ op: MetricsTableFilterOp = Field(default="eq", description="How the label value is compared.")
+ value: str = Field(max_length=400, description="Label value, or a regular expression for `regex` and `not_regex`.")
+
+
+class MetricsTableColumn(BaseModel):
+ model_config = ConfigDict(extra="forbid")
+
+ label: str = Field(min_length=1, max_length=40, description="Column header, e.g. `Requests/s`.")
+ metricName: str = Field(min_length=1, max_length=200, description="Name of the metric this column reads.")
+ aggregation: MetricsTableAggregation = Field(
+ description="How each time bucket of a row is computed. `rate` and `increase` read counters."
+ )
+ quantile: float | None = Field(
+ default=None, gt=0, lt=1, description="Required for `histogram_quantile`, e.g. 0.95 for p95."
+ )
+ filters: list[MetricsTableFilter] = Field(
+ default_factory=list,
+ max_length=METRICS_TABLE_MAX_FILTERS,
+ description="Label filters for this column only, e.g. 5xx status codes for an errors column.",
+ )
+
+ @model_validator(mode="after")
+ def validate_quantile(self) -> Self:
+ if (self.aggregation == "histogram_quantile") != (self.quantile is not None):
+ raise ValueError("Set quantile only, and always, for the histogram_quantile aggregation.")
+ return self
+
+
+class MetricsTableWidgetConfig(WidgetDateRangeConfigBase):
+ groupBy: str | None = Field(
+ default=None,
+ min_length=1,
+ max_length=200,
+ description="Label that makes one row per value, e.g. `http.route`. Null until the user sets it.",
+ )
+ columns: list[MetricsTableColumn] = Field(
+ default_factory=list,
+ max_length=METRICS_TABLE_MAX_COLUMNS,
+ description="One metric per column. Each row shows the column's average over the date range and a sparkline.",
+ )
+ interval: MetricsTableInterval | None = Field(
+ default=None,
+ description=(
+ "Time between the points of the full charts that open from a row. Null picks one from the date range. "
+ "The table sparklines always use at most 30 points."
+ ),
+ )
+ orderByColumn: int = Field(default=0, ge=0, description="Index of the column that sorts the rows.")
+ orderDirection: WidgetOrderDirection = Field(default="DESC", description="Sort direction for orderByColumn.")
+ limit: MetricsTableWidgetLimit = Field(
+ default=METRICS_TABLE_DEFAULT_LIMIT, description="Maximum number of rows to show."
+ )
+
+ @model_validator(mode="after")
+ def validate_order_by_column(self) -> Self:
+ if self.columns and self.orderByColumn >= len(self.columns):
+ raise ValueError("orderByColumn must point to a column.")
+ return self
+
+ @model_validator(mode="after")
+ def validate_metrics_query_span(self) -> Self:
+ if self.dateRange is not None and self.dateRange.date_from in METRICS_TABLE_UNSUPPORTED_DATE_FROM_VALUES:
+ raise ValueError("Metrics queries cover at most 30 days. Pick a shorter date range.")
+ return self
diff --git a/products/dashboards/backend/widget_specs/openapi.py b/products/dashboards/backend/widget_specs/openapi.py
index 8aebd3fc692d..ccdc5f0210ec 100644
--- a/products/dashboards/backend/widget_specs/openapi.py
+++ b/products/dashboards/backend/widget_specs/openapi.py
@@ -86,6 +86,7 @@ class DashboardWidgetType(models.TextChoices):
EXPERIMENT_RESULTS = "experiment_results"
EXPERIMENTS_LIST = "experiments_list"
LOGS_LIST = "logs_list"
+ METRICS_TABLE = "metrics_table"
NOTEBOOK_WIDGET = "notebook_widget"
SESSION_REPLAY_LIST = "session_replay_list"
SURVEY_RESULTS = "survey_results"
diff --git a/products/dashboards/backend/widget_specs/registry.py b/products/dashboards/backend/widget_specs/registry.py
index 859c6abb68eb..65d9bdc86be5 100644
--- a/products/dashboards/backend/widget_specs/registry.py
+++ b/products/dashboards/backend/widget_specs/registry.py
@@ -7,6 +7,7 @@ from typing import Any, Literal, NotRequired, TypedDict
from pydantic import BaseModel, ValidationError
from rest_framework.exceptions import ValidationError as DRFValidationError
+from products.dashboards.backend.constants import DASHBOARD_GRID_COLUMN_COUNT
from products.dashboards.backend.widget_specs.configs import (
ACTIVITY_EVENTS_LIST_WIDGET_TYPE,
CANVAS_APP_WIDGET_TYPE,
@@ -15,6 +16,7 @@ from products.dashboards.backend.widget_specs.configs import (
EXPERIMENT_RESULTS_WIDGET_TYPE,
EXPERIMENTS_LIST_WIDGET_TYPE,
LOGS_LIST_WIDGET_TYPE,
+ METRICS_TABLE_WIDGET_TYPE,
NOTEBOOK_WIDGET_TYPE,
SESSION_REPLAY_LIST_WIDGET_TYPE,
SURVEY_RESULTS_WIDGET_TYPE,
@@ -25,10 +27,12 @@ from products.dashboards.backend.widget_specs.configs import (
ExperimentResultsWidgetConfig,
ExperimentsListWidgetConfig,
LogsListWidgetConfig,
+ MetricsTableWidgetConfig,
NotebookWidgetConfig,
SessionReplayListWidgetConfig,
SurveyResultsWidgetConfig,
)
+from products.metrics.backend.facade.contracts import METRICS_FEATURE_FLAG
DashboardWidgetType = Literal[
"notebook_widget",
@@ -41,6 +45,7 @@ DashboardWidgetType = Literal[
"logs_list",
"conversations_recent_tickets",
"canvas_app",
+ "metrics_table",
]
__all__ = [
@@ -83,6 +88,9 @@ class WidgetSpec:
# Adds-only rollout gate: creating a tile of this type requires this feature flag (resolved via
# feature_flags.widget_flag_enabled in widget_create). Existing tiles keep rendering when it's off.
creation_flag: str | None = None
+ # Grid size of a new tile, in columns (of 12) and rows. The frontend catalog `defaultLayout` must match.
+ default_width: int = 6
+ default_height: int = 5
def __post_init__(self) -> None:
if self.is_live:
@@ -126,6 +134,7 @@ def _load_widget_specs() -> dict[str, WidgetSpec]:
from products.dashboards.backend.widgets.experiment_results import run_experiment_results_widget # noqa: PLC0415
from products.dashboards.backend.widgets.experiments_list import run_experiments_list_widget # noqa: PLC0415
from products.dashboards.backend.widgets.logs_list import run_logs_list_widget # noqa: PLC0415
+ from products.dashboards.backend.widgets.metrics_table import run_metrics_table_widget # noqa: PLC0415
from products.dashboards.backend.widgets.notebook_widget import run_notebook_widget # noqa: PLC0415
from products.dashboards.backend.widgets.session_replay_list import run_session_replay_list_widget # noqa: PLC0415
from products.dashboards.backend.widgets.survey_results import run_survey_results_widget # noqa: PLC0415
@@ -286,6 +295,25 @@ def _load_widget_specs() -> dict[str, WidgetSpec]:
filter_fields=(),
creation_flag="small-software-apps",
),
+ METRICS_TABLE_WIDGET_TYPE: WidgetSpec(
+ widget_type=METRICS_TABLE_WIDGET_TYPE,
+ config_model=MetricsTableWidgetConfig,
+ query_fn=run_metrics_table_widget,
+ required_scopes=("query:read", "metrics:read"),
+ group_id="metrics",
+ group_label="Metrics",
+ label="Metrics table",
+ description="One row per label value, such as each endpoint, with a sparkline for each metric.",
+ required_product_access="metrics",
+ product_access_denied_message="You do not have access to metrics.",
+ availability_requirements=(),
+ form_fields=("limit", "dateRange"),
+ filter_fields=("dateRange",),
+ # Full width, like a Grafana row: each row is one label value, and the columns need the room.
+ default_width=DASHBOARD_GRID_COLUMN_COUNT,
+ default_height=6,
+ creation_flag=METRICS_FEATURE_FLAG,
+ ),
}
diff --git a/products/dashboards/backend/widgets/metrics_table.py b/products/dashboards/backend/widgets/metrics_table.py
new file mode 100644
index 000000000000..8907a010d09b
--- /dev/null
+++ b/products/dashboards/backend/widgets/metrics_table.py
@@ -0,0 +1,148 @@
+from __future__ import annotations
+
+import math
+from typing import Any
+
+from django.utils import timezone
+
+from rest_framework import exceptions
+
+from posthog.clickhouse.query_tagging import Feature, Product, tags_context
+from posthog.models.team import Team
+from posthog.models.user import User
+from posthog.utils import relative_date_parse
+
+from products.dashboards.backend.constants import METRICS_TABLE_SPARKLINE_POINTS
+from products.dashboards.backend.feature_flags import widget_flag_enabled
+from products.dashboards.backend.widget_specs.configs import METRICS_TABLE_WIDGET_TYPE
+from products.dashboards.backend.widget_specs.registry import validate_widget_config
+from products.metrics.backend.facade.api import (
+ metric_query_concurrency_slots,
+ pick_metric_query_interval,
+ run_metric_query,
+)
+from products.metrics.backend.facade.contracts import (
+ METRICS_FEATURE_FLAG,
+ MetricFilter,
+ MetricGroupBy,
+ MetricQueryClause,
+ MetricQueryRequest,
+ MetricSeries,
+)
+from products.metrics.backend.facade.enums import FilterOp, MetricAggregation, MetricRangeFunction
+
+DEFAULT_METRICS_TABLE_DATE_FROM = "-1h"
+
+# A counter column sums the per-series change, so each row is the total for its label value.
+_COUNTER_FUNCTIONS = {"rate": MetricRangeFunction.RATE, "increase": MetricRangeFunction.INCREASE}
+
+
+def _clause(index: int, column: dict[str, Any], group_by: str) -> MetricQueryClause:
+ aggregation = column["aggregation"]
+ range_function = _COUNTER_FUNCTIONS.get(aggregation)
+ return MetricQueryClause(
+ name=f"c{index}",
+ metric_name=column["metricName"],
+ aggregation=MetricAggregation.SUM if range_function else MetricAggregation(aggregation),
+ range_function=range_function,
+ quantile=column.get("quantile"),
+ filters=tuple(
+ MetricFilter(key=item["key"], op=FilterOp(item["op"]), value=item["value"])
+ for item in column.get("filters", [])
+ ),
+ group_by=(MetricGroupBy(key=group_by),),
+ )
+
+
+def _mean(values: list[float]) -> float | None:
+ finite = [value for value in values if math.isfinite(value)]
+ return sum(finite) / len(finite) if finite else None
+
+
+def _sparkline(series: MetricSeries) -> list[float | None]:
+ values = [point.value for point in series.points]
+ if len(values) <= METRICS_TABLE_SPARKLINE_POINTS:
+ return values
+ size = math.ceil(len(values) / METRICS_TABLE_SPARKLINE_POINTS)
+ return [
+ _mean([value for value in values[start : start + size] if value is not None])
+ for start in range(0, len(values), size)
+ ]
+
+
+def _order_rows(rows: list[dict[str, Any]], column: int, descending: bool) -> list[dict[str, Any]]:
+ # Python sorts are stable, so ties keep the key order. Rows without a value go last in both directions.
+ by_key = sorted(rows, key=lambda row: row["key"])
+ with_value = sorted(
+ (row for row in by_key if row["values"][column] is not None),
+ key=lambda row: row["values"][column],
+ reverse=descending,
+ )
+ return with_value + [row for row in by_key if row["values"][column] is None]
+
+
+def run_metrics_table_widget(
+ team: Team,
+ config: dict[str, Any],
+ user: User | None = None,
+ *,
+ include_total_count: bool = True,
+) -> dict[str, Any]:
+ # The creation flag only blocks new tiles. Metrics is in private alpha, so every run checks the flag too.
+ if not widget_flag_enabled(METRICS_FEATURE_FLAG, team=team, user=user):
+ raise exceptions.PermissionDenied("Metrics are not enabled for this project.")
+ typed_config = validate_widget_config(METRICS_TABLE_WIDGET_TYPE, config)
+ group_by = typed_config.get("groupBy")
+ columns: list[dict[str, Any]] = typed_config["columns"]
+ if not group_by or not columns:
+ return {"needsConfiguration": True, "groupBy": group_by, "columns": [], "rows": [], "totalCount": 0}
+
+ date_from_value = (typed_config.get("dateRange") or {}).get("date_from") or DEFAULT_METRICS_TABLE_DATE_FROM
+ date_from = relative_date_parse(date_from_value, team.timezone_info)
+ date_to = timezone.now()
+ request = MetricQueryRequest(
+ clauses=tuple(_clause(index, column, group_by) for index, column in enumerate(columns)),
+ date_from=date_from,
+ date_to=date_to,
+ interval=pick_metric_query_interval(
+ date_from=date_from, date_to=date_to, max_buckets=METRICS_TABLE_SPARKLINE_POINTS
+ ),
+ # Columns share one bucket grid, so a zero fill would pull a column's average down with the
+ # buckets that only another column has data in.
+ zero_fill=False,
+ )
+ with (
+ tags_context(product=Product.METRICS, feature=Feature.QUERY, team_id=team.pk),
+ metric_query_concurrency_slots(team),
+ ):
+ series = run_metric_query(team=team, request=request)
+
+ rows_by_key: dict[str, dict[str, Any]] = {}
+ units: list[str | None] = [None] * len(columns)
+ for item in series:
+ key = item.labels.get(group_by)
+ if key is None or item.clause is None:
+ continue
+ index = int(item.clause.removeprefix("c"))
+ units[index] = units[index] or item.unit
+ row = rows_by_key.setdefault(
+ key, {"key": key, "values": [None] * len(columns), "sparklines": [[] for _ in columns]}
+ )
+ row["values"][index] = _mean([point.value for point in item.points if point.value is not None])
+ row["sparklines"][index] = _sparkline(item)
+
+ ordered = _order_rows(
+ list(rows_by_key.values()), typed_config["orderByColumn"], typed_config["orderDirection"] == "DESC"
+ )
+ limit = typed_config["limit"]
+ return {
+ "needsConfiguration": False,
+ "groupBy": group_by,
+ "columns": [
+ {"label": column["label"], "aggregation": column["aggregation"], "unit": unit}
+ for column, unit in zip(columns, units)
+ ],
+ "rows": ordered[:limit],
+ "totalCount": len(ordered),
+ "hasMore": len(ordered) > limit,
+ }
diff --git a/products/dashboards/frontend/components/WidgetCard/widgetOverviewStoryFixtures.ts b/products/dashboards/frontend/components/WidgetCard/widgetOverviewStoryFixtures.ts
index 635e87e88600..0f8349a9ddc0 100644
--- a/products/dashboards/frontend/components/WidgetCard/widgetOverviewStoryFixtures.ts
+++ b/products/dashboards/frontend/components/WidgetCard/widgetOverviewStoryFixtures.ts
@@ -3,6 +3,7 @@ import { getDashboardWidgetCatalogEntry } from '../../widget_types/catalog'
import { activityEventsSampleEvents } from '../../widgets/activity/activityEventsSampleData'
import type { ConversationsWidgetTicket } from '../../widgets/conversations/conversationsWidgetUtils'
import { logsWidgetSampleLogLines } from '../../widgets/logs/logsWidgetSampleData'
+import { metricsTableWidgetSampleResult } from '../../widgets/metrics/metricsTableWidgetSampleData'
export type WidgetOverviewDemoState = {
title?: string
@@ -536,6 +537,15 @@ export function getWidgetOverviewDemoState(catalogKey: DashboardWidgetCatalogKey
totalCountCapped: true,
},
}
+ case 'metrics_table':
+ return {
+ title: defaultTitle,
+ description: catalogEntry.description,
+ showDescription: true,
+ config: { ...defaultConfig, groupBy: 'http.route' },
+ loading: false,
+ result: metricsTableWidgetSampleResult,
+ }
case 'conversations_recent_tickets':
return {
title: defaultTitle,
diff --git a/products/dashboards/frontend/generated/api.schemas.ts b/products/dashboards/frontend/generated/api.schemas.ts
index 7ebb09b2d71a..86030a340db8 100644
--- a/products/dashboards/frontend/generated/api.schemas.ts
+++ b/products/dashboards/frontend/generated/api.schemas.ts
@@ -635,6 +635,7 @@ export const DashboardTileBadgeEnumApi = {
* * `experiment_results` - Experiment Results
* * `experiments_list` - Experiments List
* * `logs_list` - Logs List
+ * * `metrics_table` - Metrics Table
* * `notebook_widget` - Notebook Widget
* * `session_replay_list` - Session Replay List
* * `survey_results` - Survey Results
@@ -649,6 +650,7 @@ export const DashboardWidgetTypeEnumApi = {
ExperimentResults: 'experiment_results',
ExperimentsList: 'experiments_list',
LogsList: 'logs_list',
+ MetricsTable: 'metrics_table',
NotebookWidget: 'notebook_widget',
SessionReplayList: 'session_replay_list',
SurveyResults: 'survey_results',
@@ -1094,6 +1096,126 @@ export interface CanvasAppWidgetConfigApi {
canvasId?: string | null
}
+/**
+ * How each time bucket of a row is computed. `rate` and `increase` read counters.
+ */
+export type MetricsTableColumnApiAggregation =
+ (typeof MetricsTableColumnApiAggregation)[keyof typeof MetricsTableColumnApiAggregation]
+
+export const MetricsTableColumnApiAggregation = {
+ Rate: 'rate',
+ Increase: 'increase',
+ Sum: 'sum',
+ Avg: 'avg',
+ Min: 'min',
+ Max: 'max',
+ HistogramQuantile: 'histogram_quantile',
+} as const
+
+/**
+ * How the label value is compared.
+ */
+export type MetricsTableFilterApiOp = (typeof MetricsTableFilterApiOp)[keyof typeof MetricsTableFilterApiOp]
+
+export const MetricsTableFilterApiOp = {
+ Eq: 'eq',
+ Neq: 'neq',
+ Regex: 'regex',
+ NotRegex: 'not_regex',
+} as const
+
+export interface MetricsTableFilterApi {
+ /**
+ * Label key to filter on, e.g. `http.response.status_code`.
+ * @minLength 1
+ * @maxLength 200
+ */
+ key: string
+ /** How the label value is compared. */
+ op?: MetricsTableFilterApiOp
+ /**
+ * Label value, or a regular expression for `regex` and `not_regex`.
+ * @maxLength 400
+ */
+ value: string
+}
+
+export interface MetricsTableColumnApi {
+ /**
+ * Column header, e.g. `Requests/s`.
+ * @minLength 1
+ * @maxLength 40
+ */
+ label: string
+ /**
+ * Name of the metric this column reads.
+ * @minLength 1
+ * @maxLength 200
+ */
+ metricName: string
+ /** How each time bucket of a row is computed. `rate` and `increase` read counters. */
+ aggregation: MetricsTableColumnApiAggregation
+ /** Required for `histogram_quantile`, e.g. 0.95 for p95. */
+ quantile?: number | null
+ /**
+ * Label filters for this column only, e.g. 5xx status codes for an errors column.
+ * @maxItems 5
+ */
+ filters?: MetricsTableFilterApi[]
+}
+
+/**
+ * Time between the points of the full charts that open from a row. Null picks one from the date range. The table sparklines always use at most 30 points.
+ */
+export type MetricsTableWidgetConfigApiInterval =
+ | (typeof MetricsTableWidgetConfigApiInterval)[keyof typeof MetricsTableWidgetConfigApiInterval]
+ | null
+
+export const MetricsTableWidgetConfigApiInterval = {
+ Minute: 'minute',
+ Minute5: 'minute_5',
+ Minute15: 'minute_15',
+ Hour: 'hour',
+ Day: 'day',
+} as const
+
+/**
+ * Sort direction for orderByColumn.
+ */
+export type MetricsTableWidgetConfigApiOrderDirection =
+ (typeof MetricsTableWidgetConfigApiOrderDirection)[keyof typeof MetricsTableWidgetConfigApiOrderDirection]
+
+export const MetricsTableWidgetConfigApiOrderDirection = {
+ Asc: 'ASC',
+ Desc: 'DESC',
+} as const
+
+export interface MetricsTableWidgetConfigApi {
+ dateRange?: WidgetDateRangeApi | null
+ /** Label that makes one row per value, e.g. `http.route`. Null until the user sets it. */
+ groupBy?: string | null
+ /**
+ * One metric per column. Each row shows the column's average over the date range and a sparkline.
+ * @maxItems 6
+ */
+ columns?: MetricsTableColumnApi[]
+ /** Time between the points of the full charts that open from a row. Null picks one from the date range. The table sparklines always use at most 30 points. */
+ interval?: MetricsTableWidgetConfigApiInterval
+ /**
+ * Index of the column that sorts the rows.
+ * @minimum 0
+ */
+ orderByColumn?: number
+ /** Sort direction for orderByColumn. */
+ orderDirection?: MetricsTableWidgetConfigApiOrderDirection
+ /**
+ * Maximum number of rows to show.
+ * @minimum 1
+ * @maximum 100
+ */
+ limit?: number
+}
+
export type DashboardWidgetConfigApi =
| NotebookWidgetConfigApi
| ActivityEventsListWidgetConfigApi
@@ -1105,6 +1227,7 @@ export type DashboardWidgetConfigApi =
| LogsListWidgetConfigApi
| ConversationsRecentTicketsWidgetConfigApi
| CanvasAppWidgetConfigApi
+ | MetricsTableWidgetConfigApi
export interface DashboardPatchWidgetOpenApiApi {
/** Existing widget row ID when updating a widget tile via dashboard PATCH. */
@@ -1118,6 +1241,7 @@ export interface DashboardPatchWidgetOpenApiApi {
* * `experiment_results` - Experiment Results
* * `experiments_list` - Experiments List
* * `logs_list` - Logs List
+ * * `metrics_table` - Metrics Table
* * `notebook_widget` - Notebook Widget
* * `session_replay_list` - Session Replay List
* * `survey_results` - Survey Results */
@@ -10128,6 +10252,7 @@ export interface AddDashboardWidgetRequestApi {
* * `experiment_results` - Experiment Results
* * `experiments_list` - Experiments List
* * `logs_list` - Logs List
+ * * `metrics_table` - Metrics Table
* * `notebook_widget` - Notebook Widget
* * `session_replay_list` - Session Replay List
* * `survey_results` - Survey Results */
@@ -10141,7 +10266,7 @@ export interface AddDashboardWidgetRequestApi {
*/
export interface AddDashboardWidgetsBatchRequestOpenApiApi {
/**
- * Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).
+ * Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, metrics_table, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).
* @minItems 1
* @maxItems 10
*/
@@ -10178,6 +10303,7 @@ export interface UpdateDashboardWidgetRequestApi {
* * `experiment_results` - Experiment Results
* * `experiments_list` - Experiments List
* * `logs_list` - Logs List
+ * * `metrics_table` - Metrics Table
* * `notebook_widget` - Notebook Widget
* * `session_replay_list` - Session Replay List
* * `survey_results` - Survey Results */
@@ -10486,6 +10612,27 @@ export interface CanvasAppWidgetCatalogEntryOpenApiApi {
live: boolean
}
+export type MetricsTableWidgetCatalogEntryOpenApiApiWidgetType =
+ (typeof MetricsTableWidgetCatalogEntryOpenApiApiWidgetType)[keyof typeof MetricsTableWidgetCatalogEntryOpenApiApiWidgetType]
+
+export const MetricsTableWidgetCatalogEntryOpenApiApiWidgetType = {
+ MetricsTable: 'metrics_table',
+} as const
+
+export interface MetricsTableWidgetCatalogEntryOpenApiApi {
+ widget_type: MetricsTableWidgetCatalogEntryOpenApiApiWidgetType
+ group_id: string
+ group_label: string
+ label: string
+ description: string
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
+ readonly config_schema: MetricsTableWidgetConfigApi
+ /** @nullable */
+ required_product_access?: string | null
+ /** Whether tiles of this type self-update in real time after load. Live tiles show a fixed real-time window and cannot apply test-account filtering to the stream, so their config takes neither dateRange nor filterTestAccounts. */
+ live: boolean
+}
+
export type WidgetCatalogEntryApi =
| NotebookWidgetCatalogEntryOpenApiApi
| ActivityEventsListWidgetCatalogEntryOpenApiApi
@@ -10497,6 +10644,7 @@ export type WidgetCatalogEntryApi =
| LogsListWidgetCatalogEntryOpenApiApi
| ConversationsRecentTicketsWidgetCatalogEntryOpenApiApi
| CanvasAppWidgetCatalogEntryOpenApiApi
+ | MetricsTableWidgetCatalogEntryOpenApiApi
export interface WidgetCatalogResponseApi {
/** Registered dashboard widget types. */
@@ -10631,6 +10779,16 @@ export const CanvasAppWidgetTypeEnumApi = {
CanvasApp: 'canvas_app',
} as const
+/**
+ * * `metrics_table` - metrics_table
+ */
+export type MetricsTableWidgetTypeEnumApi =
+ (typeof MetricsTableWidgetTypeEnumApi)[keyof typeof MetricsTableWidgetTypeEnumApi]
+
+export const MetricsTableWidgetTypeEnumApi = {
+ MetricsTable: 'metrics_table',
+} as const
+
export type DashboardTemplatesListParams = {
/**
* Omit for all templates. When set, filter by featured flag; parsed with str_to_bool (same as other API query booleans).
@@ -11079,6 +11237,7 @@ export const DashboardsWidgetCatalogRetrieveWidgetTypeItem = {
ExperimentResults: 'experiment_results',
ExperimentsList: 'experiments_list',
LogsList: 'logs_list',
+ MetricsTable: 'metrics_table',
NotebookWidget: 'notebook_widget',
SessionReplayList: 'session_replay_list',
SurveyResults: 'survey_results',
diff --git a/products/dashboards/frontend/generated/api.zod.ts b/products/dashboards/frontend/generated/api.zod.ts
index aa3df256911d..14a5c3593c2d 100644
--- a/products/dashboards/frontend/generated/api.zod.ts
+++ b/products/dashboards/frontend/generated/api.zod.ts
@@ -474,6 +474,31 @@ export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneNineSearchMax
export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneNineSavedViewIdOneMax = 12
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneGroupByOneMax = 200
+
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemLabelMax = 40
+
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemMetricNameMax = 200
+
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemQuantileOneExclusiveMin = 0
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemQuantileOneExclusiveMax = 1
+
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemFiltersItemKeyMax = 200
+
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemFiltersItemOpDefault = `eq`
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemFiltersItemValueMax = 400
+
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemFiltersMax = 5
+
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsMax = 6
+
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneOrderByColumnDefault = 0
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneOrderByColumnMin = 0
+
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneOrderDirectionDefault = `DESC`
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneLimitDefault = 25
+export const dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneLimitMax = 100
+
export const dashboardsPartialUpdateBodyTilesItemWidgetOneNameMax = 400
export const dashboardsPartialUpdateBodyDeleteInsightsDefault = false
@@ -708,16 +733,17 @@ export const DashboardsPartialUpdateBody = /* @__PURE__ */ zod
'experiment_results',
'experiments_list',
'logs_list',
+ 'metrics_table',
'notebook_widget',
'session_replay_list',
'survey_results',
])
.describe(
- '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `metrics_table` - Metrics Table\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
)
.optional()
.describe(
- 'Widget type identifier (cannot be changed on update).\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ 'Widget type identifier (cannot be changed on update).\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `metrics_table` - Metrics Table\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
),
config: zod
.union([
@@ -1420,6 +1446,165 @@ export const DashboardsPartialUpdateBody = /* @__PURE__ */ zod
'Canvas to render in the tile. Null until the user picks one in the widget settings.'
),
}),
+ zod.object({
+ dateRange: zod
+ .union([
+ zod.object({
+ date_from: zod
+ .union([
+ zod.enum([
+ '-1M',
+ '-30M',
+ '-1h',
+ '-3h',
+ '-24h',
+ '-7d',
+ '-14d',
+ '-30d',
+ '-90d',
+ ]),
+ zod.null(),
+ ])
+ .optional(),
+ }),
+ zod.null(),
+ ])
+ .optional(),
+ groupBy: zod
+ .union([
+ zod
+ .string()
+ .min(1)
+ .max(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneGroupByOneMax
+ ),
+ zod.null(),
+ ])
+ .optional()
+ .describe(
+ 'Label that makes one row per value, e.g. `http.route`. Null until the user sets it.'
+ ),
+ columns: zod
+ .array(
+ zod.object({
+ label: zod
+ .string()
+ .min(1)
+ .max(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemLabelMax
+ )
+ .describe('Column header, e.g. `Requests\/s`.'),
+ metricName: zod
+ .string()
+ .min(1)
+ .max(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemMetricNameMax
+ )
+ .describe('Name of the metric this column reads.'),
+ aggregation: zod
+ .enum([
+ 'rate',
+ 'increase',
+ 'sum',
+ 'avg',
+ 'min',
+ 'max',
+ 'histogram_quantile',
+ ])
+ .describe(
+ 'How each time bucket of a row is computed. `rate` and `increase` read counters.'
+ ),
+ quantile: zod
+ .union([
+ zod
+ .number()
+ .gt(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemQuantileOneExclusiveMin
+ )
+ .lt(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemQuantileOneExclusiveMax
+ ),
+ zod.null(),
+ ])
+ .optional()
+ .describe(
+ 'Required for `histogram_quantile`, e.g. 0.95 for p95.'
+ ),
+ filters: zod
+ .array(
+ zod.object({
+ key: zod
+ .string()
+ .min(1)
+ .max(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemFiltersItemKeyMax
+ )
+ .describe(
+ 'Label key to filter on, e.g. `http.response.status_code`.'
+ ),
+ op: zod
+ .enum(['eq', 'neq', 'regex', 'not_regex'])
+ .default(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemFiltersItemOpDefault
+ )
+ .describe('How the label value is compared.'),
+ value: zod
+ .string()
+ .max(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemFiltersItemValueMax
+ )
+ .describe(
+ 'Label value, or a regular expression for `regex` and `not_regex`.'
+ ),
+ })
+ )
+ .max(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsItemFiltersMax
+ )
+ .optional()
+ .describe(
+ 'Label filters for this column only, e.g. 5xx status codes for an errors column.'
+ ),
+ })
+ )
+ .max(dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneColumnsMax)
+ .optional()
+ .describe(
+ "One metric per column. Each row shows the column's average over the date range and a sparkline."
+ ),
+ interval: zod
+ .union([
+ zod.enum(['minute', 'minute_5', 'minute_15', 'hour', 'day']),
+ zod.null(),
+ ])
+ .optional()
+ .describe(
+ 'Time between the points of the full charts that open from a row. Null picks one from the date range. The table sparklines always use at most 30 points.'
+ ),
+ orderByColumn: zod
+ .number()
+ .min(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneOrderByColumnMin
+ )
+ .default(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneOrderByColumnDefault
+ )
+ .describe('Index of the column that sorts the rows.'),
+ orderDirection: zod
+ .enum(['ASC', 'DESC'])
+ .default(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneOrderDirectionDefault
+ )
+ .describe('Sort direction for orderByColumn.'),
+ limit: zod
+ .number()
+ .min(1)
+ .max(dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneLimitMax)
+ .default(
+ dashboardsPartialUpdateBodyTilesItemWidgetOneConfigOneOneoneLimitDefault
+ )
+ .describe('Maximum number of rows to show.'),
+ }),
])
.optional()
.describe("Widget-specific configuration. Shape depends on the tile's widget_type."),
@@ -1709,15 +1894,16 @@ export const DashboardsWidgetsBatchCreateBody = /* @__PURE__ */ zod
'experiment_results',
'experiments_list',
'logs_list',
+ 'metrics_table',
'notebook_widget',
'session_replay_list',
'survey_results',
])
.describe(
- '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `metrics_table` - Metrics Table\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
)
.describe(
- 'Widget type to add. Use dashboard-widget-catalog-list to pick one.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ 'Widget type to add. Use dashboard-widget-catalog-list to pick one.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `metrics_table` - Metrics Table\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
),
config: zod
.record(zod.string(), zod.unknown())
@@ -1729,7 +1915,7 @@ export const DashboardsWidgetsBatchCreateBody = /* @__PURE__ */ zod
.min(1)
.max(dashboardsWidgetsBatchCreateBodyWidgetsMax)
.describe(
- 'Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).'
+ 'Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, metrics_table, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).'
),
})
.describe('OpenAPI-only batch-add schema with widget_type-discriminated config shapes for agents.')
@@ -1775,16 +1961,17 @@ export const DashboardsUpdateWidgetsBatchBody = /* @__PURE__ */ zod
'experiment_results',
'experiments_list',
'logs_list',
+ 'metrics_table',
'notebook_widget',
'session_replay_list',
'survey_results',
])
.describe(
- '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `metrics_table` - Metrics Table\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
)
.optional()
.describe(
- "The tile's widget type. It cannot be changed, so omit it or pass the current type.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results"
+ "The tile's widget type. It cannot be changed, so omit it or pass the current type.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `metrics_table` - Metrics Table\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results"
),
config: zod
.record(zod.string(), zod.unknown())
diff --git a/products/dashboards/frontend/generated/widget-config-property-keys.json b/products/dashboards/frontend/generated/widget-config-property-keys.json
index ac90e12c272b..38337827801c 100644
--- a/products/dashboards/frontend/generated/widget-config-property-keys.json
+++ b/products/dashboards/frontend/generated/widget-config-property-keys.json
@@ -51,7 +51,8 @@
"search",
"status"
],
- "canvas_app": ["canvasId"]
+ "canvas_app": ["canvasId"],
+ "metrics_table": ["columns", "dateRange", "groupBy", "interval", "limit", "orderByColumn", "orderDirection"]
},
"configPropertyTrees": {
"notebook_widget": {
@@ -479,6 +480,57 @@
"canvasId": {
"$type": "string"
}
+ },
+ "metrics_table": {
+ "dateRange": {
+ "date_from": {
+ "$enum": ["-14d", "-1M", "-1h", "-24h", "-30M", "-30d", "-3h", "-7d", "-90d"]
+ }
+ },
+ "groupBy": {
+ "$type": "string"
+ },
+ "columns": {
+ "$array": {
+ "label": {
+ "$type": "string"
+ },
+ "metricName": {
+ "$type": "string"
+ },
+ "aggregation": {
+ "$enum": ["avg", "histogram_quantile", "increase", "max", "min", "rate", "sum"]
+ },
+ "quantile": {
+ "$type": "number"
+ },
+ "filters": {
+ "$array": {
+ "key": {
+ "$type": "string"
+ },
+ "op": {
+ "$enum": ["eq", "neq", "not_regex", "regex"]
+ },
+ "value": {
+ "$type": "string"
+ }
+ }
+ }
+ }
+ },
+ "interval": {
+ "$enum": ["day", "hour", "minute", "minute_15", "minute_5"]
+ },
+ "orderByColumn": {
+ "$type": "integer"
+ },
+ "orderDirection": {
+ "$enum": ["ASC", "DESC"]
+ },
+ "limit": {
+ "$type": "integer"
+ }
}
}
}
diff --git a/products/dashboards/frontend/generated/widget-config-schemas/metricsTableColumn.zod.ts b/products/dashboards/frontend/generated/widget-config-schemas/metricsTableColumn.zod.ts
new file mode 100644
index 000000000000..97050a24327e
--- /dev/null
+++ b/products/dashboards/frontend/generated/widget-config-schemas/metricsTableColumn.zod.ts
@@ -0,0 +1,45 @@
+/**
+ * Generated by orval v8.14.0 🍺
+ * Do not edit manually.
+ * PostHog API - 1 ops
+ * OpenAPI spec version: 1.0.0
+ */
+import { z as zod } from 'zod'
+
+import { MetricsTableFilter } from './metricsTableFilter.zod'
+
+export const metricsTableColumnLabelMax = 40
+
+export const metricsTableColumnMetricNameMax = 200
+
+export const metricsTableColumnQuantileOneExclusiveMin = 0
+export const metricsTableColumnQuantileOneExclusiveMax = 1
+
+export const metricsTableColumnFiltersMax = 5
+
+export const MetricsTableColumn = /* @__PURE__ */ zod.object({
+ label: zod.string().min(1).max(metricsTableColumnLabelMax).describe('Column header, e.g. `Requests\/s`.'),
+ metricName: zod
+ .string()
+ .min(1)
+ .max(metricsTableColumnMetricNameMax)
+ .describe('Name of the metric this column reads.'),
+ aggregation: zod
+ .enum(['rate', 'increase', 'sum', 'avg', 'min', 'max', 'histogram_quantile'])
+ .describe('How each time bucket of a row is computed. `rate` and `increase` read counters.'),
+ quantile: zod
+ .union([
+ zod.number().gt(metricsTableColumnQuantileOneExclusiveMin).lt(metricsTableColumnQuantileOneExclusiveMax),
+ zod.null(),
+ ])
+ .optional()
+ .describe('Required for `histogram_quantile`, e.g. 0.95 for p95.'),
+ filters: zod
+ .array(MetricsTableFilter)
+ .max(metricsTableColumnFiltersMax)
+ .optional()
+ .describe('Label filters for this column only, e.g. 5xx status codes for an errors column.'),
+})
+
+export type MetricsTableColumn = zod.input<typeof MetricsTableColumn>
+export type MetricsTableColumnOutput = zod.output<typeof MetricsTableColumn>
diff --git a/products/dashboards/frontend/generated/widget-config-schemas/metricsTableFilter.zod.ts b/products/dashboards/frontend/generated/widget-config-schemas/metricsTableFilter.zod.ts
new file mode 100644
index 000000000000..f698fb416a78
--- /dev/null
+++ b/products/dashboards/frontend/generated/widget-config-schemas/metricsTableFilter.zod.ts
@@ -0,0 +1,31 @@
+/**
+ * Generated by orval v8.14.0 🍺
+ * Do not edit manually.
+ * PostHog API - 1 ops
+ * OpenAPI spec version: 1.0.0
+ */
+import { z as zod } from 'zod'
+
+export const metricsTableFilterKeyMax = 200
+
+export const metricsTableFilterOpDefault = `eq`
+export const metricsTableFilterValueMax = 400
+
+export const MetricsTableFilter = /* @__PURE__ */ zod.object({
+ key: zod
+ .string()
+ .min(1)
+ .max(metricsTableFilterKeyMax)
+ .describe('Label key to filter on, e.g. `http.response.status_code`.'),
+ op: zod
+ .enum(['eq', 'neq', 'regex', 'not_regex'])
+ .default(metricsTableFilterOpDefault)
+ .describe('How the label value is compared.'),
+ value: zod
+ .string()
+ .max(metricsTableFilterValueMax)
+ .describe('Label value, or a regular expression for `regex` and `not_regex`.'),
+})
+
+export type MetricsTableFilter = zod.input<typeof MetricsTableFilter>
+export type MetricsTableFilterOutput = zod.output<typeof MetricsTableFilter>
diff --git a/products/dashboards/frontend/generated/widget-config-schemas/metricsTableWidgetConfig.zod.ts b/products/dashboards/frontend/generated/widget-config-schemas/metricsTableWidgetConfig.zod.ts
new file mode 100644
index 000000000000..69698339d7df
--- /dev/null
+++ b/products/dashboards/frontend/generated/widget-config-schemas/metricsTableWidgetConfig.zod.ts
@@ -0,0 +1,58 @@
+/**
+ * Generated by orval v8.14.0 🍺
+ * Do not edit manually.
+ * PostHog API - 1 ops
+ * OpenAPI spec version: 1.0.0
+ */
+import { z as zod } from 'zod'
+
+import { MetricsTableColumn } from './metricsTableColumn.zod'
+import { WidgetDateRange } from './widgetDateRange.zod'
+
+export const metricsTableWidgetConfigGroupByOneMax = 200
+
+export const metricsTableWidgetConfigColumnsMax = 6
+
+export const metricsTableWidgetConfigOrderByColumnDefault = 0
+export const metricsTableWidgetConfigOrderByColumnMin = 0
+
+export const metricsTableWidgetConfigOrderDirectionDefault = `DESC`
+export const metricsTableWidgetConfigLimitDefault = 25
+export const metricsTableWidgetConfigLimitMax = 100
+
+export const MetricsTableWidgetConfig = /* @__PURE__ */ zod.object({
+ dateRange: zod.union([WidgetDateRange, zod.null()]).optional(),
+ groupBy: zod
+ .union([zod.string().min(1).max(metricsTableWidgetConfigGroupByOneMax), zod.null()])
+ .optional()
+ .describe('Label that makes one row per value, e.g. `http.route`. Null until the user sets it.'),
+ columns: zod
+ .array(MetricsTableColumn)
+ .max(metricsTableWidgetConfigColumnsMax)
+ .optional()
+ .describe("One metric per column. Each row shows the column's average over the date range and a sparkline."),
+ interval: zod
+ .union([zod.enum(['minute', 'minute_5', 'minute_15', 'hour', 'day']), zod.null()])
+ .optional()
+ .describe(
+ 'Time between the points of the full charts that open from a row. Null picks one from the date range. The table sparklines always use at most 30 points.'
+ ),
+ orderByColumn: zod
+ .number()
+ .min(metricsTableWidgetConfigOrderByColumnMin)
+ .default(metricsTableWidgetConfigOrderByColumnDefault)
+ .describe('Index of the column that sorts the rows.'),
+ orderDirection: zod
+ .enum(['ASC', 'DESC'])
+ .default(metricsTableWidgetConfigOrderDirectionDefault)
+ .describe('Sort direction for orderByColumn.'),
+ limit: zod
+ .number()
+ .min(1)
+ .max(metricsTableWidgetConfigLimitMax)
+ .default(metricsTableWidgetConfigLimitDefault)
+ .describe('Maximum number of rows to show.'),
+})
+
+export type MetricsTableWidgetConfig = zod.input<typeof MetricsTableWidgetConfig>
+export type MetricsTableWidgetConfigOutput = zod.output<typeof MetricsTableWidgetConfig>
diff --git a/products/dashboards/frontend/generated/widget-configs.zod.ts b/products/dashboards/frontend/generated/widget-configs.zod.ts
index c0874a73c6e1..3d8fb067e083 100644
--- a/products/dashboards/frontend/generated/widget-configs.zod.ts
+++ b/products/dashboards/frontend/generated/widget-configs.zod.ts
@@ -10,6 +10,7 @@ import { ErrorTrackingListWidgetConfig } from './widget-config-schemas/errorTrac
import { ExperimentResultsWidgetConfig as ExperimentResultsWidgetConfigComponent } from './widget-config-schemas/experimentResultsWidgetConfig.zod'
import { ExperimentsListWidgetConfig } from './widget-config-schemas/experimentsListWidgetConfig.zod'
import { LogsListWidgetConfig } from './widget-config-schemas/logsListWidgetConfig.zod'
+import { MetricsTableWidgetConfig as MetricsTableWidgetConfigComponent } from './widget-config-schemas/metricsTableWidgetConfig.zod'
import { NotebookWidgetConfig as NotebookWidgetConfigComponent } from './widget-config-schemas/notebookWidgetConfig.zod'
import { SessionReplayListWidgetConfig } from './widget-config-schemas/sessionReplayListWidgetConfig.zod'
import { SurveyResultsWidgetConfig as SurveyResultsWidgetConfigComponent } from './widget-config-schemas/surveyResultsWidgetConfig.zod'
@@ -23,6 +24,7 @@ export const errorTrackingWidgetConfigSchema = /* @__PURE__ */ ErrorTrackingList
export const experimentResultsWidgetConfigSchema = /* @__PURE__ */ ExperimentResultsWidgetConfigComponent
export const experimentsWidgetConfigSchema = /* @__PURE__ */ ExperimentsListWidgetConfig
export const logsWidgetConfigSchema = /* @__PURE__ */ LogsListWidgetConfig
+export const metricsTableWidgetConfigSchema = /* @__PURE__ */ MetricsTableWidgetConfigComponent
export const notebookWidgetConfigSchema = /* @__PURE__ */ NotebookWidgetConfigComponent
export const sessionReplayWidgetConfigSchema = /* @__PURE__ */ SessionReplayListWidgetConfig
export const surveyResultsWidgetConfigSchema = /* @__PURE__ */ SurveyResultsWidgetConfigComponent
@@ -35,6 +37,7 @@ export type ErrorTrackingWidgetConfig = zod.infer<typeof errorTrackingWidgetConf
export type ExperimentResultsWidgetConfig = zod.infer<typeof experimentResultsWidgetConfigSchema>
export type ExperimentsWidgetConfig = zod.infer<typeof experimentsWidgetConfigSchema>
export type LogsWidgetConfig = zod.infer<typeof logsWidgetConfigSchema>
+export type MetricsTableWidgetConfig = zod.infer<typeof metricsTableWidgetConfigSchema>
export type NotebookWidgetConfig = zod.infer<typeof notebookWidgetConfigSchema>
export type SessionReplayWidgetConfig = zod.infer<typeof sessionReplayWidgetConfigSchema>
export type SurveyResultsWidgetConfig = zod.infer<typeof surveyResultsWidgetConfigSchema>
@@ -86,6 +89,11 @@ export const logsWidgetFormSchema = logsWidgetConfigSchema.pick({
timezone: true,
})
+export const metricsTableWidgetFormSchema = metricsTableWidgetConfigSchema.pick({
+ limit: true,
+ dateRange: true,
+})
+
export const notebookWidgetFormSchema = notebookWidgetConfigSchema.pick({})
export const sessionReplayWidgetFormSchema = sessionReplayWidgetConfigSchema.pick({
diff --git a/products/dashboards/frontend/generated/widget-form-fields.json b/products/dashboards/frontend/generated/widget-form-fields.json
index b6aebad1ad12..164fe83e2251 100644
--- a/products/dashboards/frontend/generated/widget-form-fields.json
+++ b/products/dashboards/frontend/generated/widget-form-fields.json
@@ -49,6 +49,13 @@
"formFields": ["limit", "dateRange", "wrapLines", "timezone"],
"live": false
},
+ "metrics_table": {
+ "configSchemaExport": "metricsTableWidgetConfigSchema",
+ "configTypeExport": "MetricsTableWidgetConfig",
+ "formSchemaExport": "metricsTableWidgetFormSchema",
+ "formFields": ["limit", "dateRange"],
+ "live": false
+ },
"notebook_widget": {
"configSchemaExport": "notebookWidgetConfigSchema",
"configTypeExport": "NotebookWidgetConfig",
diff --git a/products/dashboards/frontend/types.ts b/products/dashboards/frontend/types.ts
index 278d0a379759..3df9a027e050 100644
--- a/products/dashboards/frontend/types.ts
+++ b/products/dashboards/frontend/types.ts
@@ -7,4 +7,5 @@ export type DashboardWidgetProductAccess =
| 'experiment'
| 'survey'
| 'logs'
+ | 'metrics'
| 'ticket'
diff --git a/products/dashboards/frontend/widgetProductAccess.ts b/products/dashboards/frontend/widgetProductAccess.ts
index b38fa103985f..50c8ae797b7f 100644
--- a/products/dashboards/frontend/widgetProductAccess.ts
+++ b/products/dashboards/frontend/widgetProductAccess.ts
@@ -11,6 +11,7 @@ const WIDGET_PRODUCT_ACCESS_CHECKS = {
experiment: () => userHasAccess(AccessControlResourceType.Experiment, AccessControlLevel.Viewer),
survey: () => userHasAccess(AccessControlResourceType.Survey, AccessControlLevel.Viewer),
logs: () => userHasAccess(AccessControlResourceType.Logs, AccessControlLevel.Viewer),
+ metrics: () => userHasAccess(AccessControlResourceType.Metrics, AccessControlLevel.Viewer),
ticket: () => userHasAccess(AccessControlResourceType.Ticket, AccessControlLevel.Viewer),
} satisfies Record<DashboardWidgetProductAccess, () => boolean>
diff --git a/products/dashboards/frontend/widget_types/catalog.ts b/products/dashboards/frontend/widget_types/catalog.ts
index cd542d2174d3..edf8e4ff0417 100644
--- a/products/dashboards/frontend/widget_types/catalog.ts
+++ b/products/dashboards/frontend/widget_types/catalog.ts
@@ -8,9 +8,11 @@ import {
IconMessage,
IconNotebook,
IconRewindPlay,
+ IconTrending,
IconWarning,
} from '@posthog/icons'
+import { FEATURE_FLAGS, type FeatureFlagKey } from 'lib/constants'
import { urls } from 'scenes/urls'
import { ProductKey, QuickFilterContext } from '~/queries/schema/schema-general'
@@ -23,6 +25,7 @@ import {
experimentResultsWidgetConfigSchema,
experimentsWidgetConfigSchema,
logsWidgetConfigSchema,
+ metricsTableWidgetConfigSchema,
notebookWidgetConfigSchema,
sessionReplayWidgetConfigSchema,
surveyResultsWidgetConfigSchema,
@@ -91,6 +94,7 @@ export const DASHBOARD_WIDGET_GROUP_LABELS = {
logs: 'Logs',
conversations: 'Support',
canvas: 'Canvas',
+ metrics: 'Metrics',
} as const satisfies Record<string, string>
export function getDashboardWidgetGroupLabel(groupId: string): string {
@@ -108,6 +112,7 @@ export const DASHBOARD_WIDGET_GROUP_ICONS = {
logs: IconList,
conversations: IconMessage,
canvas: IconApps,
+ metrics: IconTrending,
} as const satisfies Record<keyof typeof DASHBOARD_WIDGET_GROUP_LABELS, ComponentType<{ className?: string }>>
export function getDashboardWidgetGroupIcon(groupId: string): ComponentType<{ className?: string }> | undefined {
@@ -164,6 +169,8 @@ export type DashboardWidgetCatalogEntry = {
description: string
defaultConfig: Record<string, unknown>
hideFromPicker?: boolean
+ /** Hides the widget from the Add widget picker while this flag is off. Tiles already placed keep rendering. */
+ featureFlag?: FeatureFlagKey
defaultLayout: { w: number; h: number; minW: number; minH?: number }
productAccess?: DashboardWidgetProductAccess
headerLayout?: DashboardWidgetHeaderLayout
@@ -347,6 +354,24 @@ export const DASHBOARD_WIDGET_CATALOG = {
message: 'Log in to PostHog to see the latest logs from this dashboard.',
},
},
+ metrics_table: {
+ groupId: 'metrics',
+ label: 'Metrics table',
+ description: 'One row per label value, such as each endpoint, with a sparkline for each metric.',
+ headerTitle: 'Metrics table',
+ productAccess: 'metrics',
+ featureFlag: FEATURE_FLAGS.METRICS,
+ defaultConfig: metricsTableWidgetConfigSchema.parse({
+ dateRange: { date_from: '-1h' },
+ }),
+ // Full width, like a Grafana row: each row is one label value, and the columns need the room.
+ defaultLayout: { w: 12, h: 6, minW: 12, minH: 4 },
+ titleHref: urls.metrics(),
+ sharedPlaceholder: {
+ title: 'Metrics table',
+ message: 'Log in to PostHog to see the metrics in this table.',
+ },
+ },
} as const satisfies Record<string, DashboardWidgetCatalogEntry>
export type DashboardWidgetCatalogKey = keyof typeof DASHBOARD_WIDGET_CATALOG
diff --git a/products/dashboards/frontend/widgets/AddWidgetModal.test.tsx b/products/dashboards/frontend/widgets/AddWidgetModal.test.tsx
index 1f90bb9b3106..add3adb34a69 100644
--- a/products/dashboards/frontend/widgets/AddWidgetModal.test.tsx
+++ b/products/dashboards/frontend/widgets/AddWidgetModal.test.tsx
@@ -6,6 +6,8 @@ import { cleanup, render, screen, within } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { BindLogic } from 'kea'
+import { FEATURE_FLAGS } from 'lib/constants'
+import { featureFlagLogic } from 'lib/logic/featureFlagLogic'
import { dashboardLogic } from 'scenes/dashboard/dashboardLogic'
import { initKeaTests } from '~/test/init'
@@ -80,19 +82,20 @@ describe('AddWidgetModal', () => {
expect(screen.queryByText('Notebook widget')).not.toBeInTheDocument()
})
- it('shows alphabetized badges for each widget product section', () => {
+ it.each([
+ [false, ['Activity', 'Error tracking', 'Experiments', 'Logs', 'Session replay', 'Support', 'Surveys']],
+ [
+ true,
+ ['Activity', 'Error tracking', 'Experiments', 'Logs', 'Metrics', 'Session replay', 'Support', 'Surveys'],
+ ],
+ ])('shows alphabetized product badges when the metrics flag is %s', (metricsEnabled, expectedBadges) => {
+ featureFlagLogic.mount()
+ featureFlagLogic.actions.setFeatureFlags([], { [FEATURE_FLAGS.METRICS]: metricsEnabled })
renderAddWidgetModal()
const badges = screen.getByTestId('dashboard-widget-product-badges')
- expect(Array.from(badges.children).map((badge) => badge.textContent)).toEqual([
- 'Activity',
- 'Error tracking',
- 'Experiments',
- 'Logs',
- 'Session replay',
- 'Support',
- 'Surveys',
- ])
+ expect(Array.from(badges.children).map((badge) => badge.textContent)).toEqual(expectedBadges)
+ expect(!!screen.queryByText('Metrics', { selector: 'h5' })).toEqual(metricsEnabled)
})
it('filters widget sections to the selected product badges', async () => {
@@ -111,7 +114,7 @@ describe('AddWidgetModal', () => {
await userEvent.click(within(badges).getByText('Logs'))
await userEvent.click(within(badges).getByText('Error tracking'))
- expect(sectionHeadings()).toHaveLength(7)
+ expect(sectionHeadings()).toHaveLength(8)
})
it('allows multi-select checkbox behavior within grouped layout', async () => {
diff --git a/products/dashboards/frontend/widgets/AddWidgetModal.tsx b/products/dashboards/frontend/widgets/AddWidgetModal.tsx
index cbce9dd8a858..4cddeefaac72 100644
--- a/products/dashboards/frontend/widgets/AddWidgetModal.tsx
+++ b/products/dashboards/frontend/widgets/AddWidgetModal.tsx
@@ -10,6 +10,7 @@ import { LemonDivider } from 'lib/lemon-ui/LemonDivider'
import { LemonModal } from 'lib/lemon-ui/LemonModal'
import { LemonTag } from 'lib/lemon-ui/LemonTag'
import { Link } from 'lib/lemon-ui/Link'
+import { featureFlagLogic } from 'lib/logic/featureFlagLogic'
import { dashboardLogic } from 'scenes/dashboard/dashboardLogic'
import { teamLogic } from 'scenes/teamLogic'
@@ -78,13 +79,16 @@ export function AddWidgetModal({ isOpen, onClose, loading, onAdd }: AddWidgetMod
const { toggleAddWidgetSelectedType, toggleAddWidgetCollapsedGroup, toggleAddWidgetFilteredGroup } =
useActions(dashboardLogic)
const { currentTeam } = useValues(teamLogic)
+ const { featureFlags } = useValues(featureFlagLogic)
+ const pickerGroups = DASHBOARD_WIDGET_CATALOG_GROUPS.map((group) => ({
+ ...group,
+ widgets: group.widgets.filter(({ entry }) => !entry.featureFlag || !!featureFlags[entry.featureFlag]),
+ })).filter((group) => group.widgets.length > 0)
const selectedTypes = new Set(addWidgetSelectedTypes)
const collapsedGroups = new Set(addWidgetCollapsedGroups)
const filteredGroups = new Set(addWidgetFilteredGroups)
const visibleGroups =
- filteredGroups.size > 0
- ? DASHBOARD_WIDGET_CATALOG_GROUPS.filter((group) => filteredGroups.has(group.groupId))
- : DASHBOARD_WIDGET_CATALOG_GROUPS
+ filteredGroups.size > 0 ? pickerGroups.filter((group) => filteredGroups.has(group.groupId)) : pickerGroups
const selectedCount = selectedTypes.size
@@ -114,7 +118,7 @@ export function AddWidgetModal({ isOpen, onClose, loading, onAdd }: AddWidgetMod
<>
<span>Bring context from your different PostHog products into one dashboard.</span>
<span className="mt-2 flex flex-wrap gap-2" data-attr="dashboard-widget-product-badges">
- {[...DASHBOARD_WIDGET_CATALOG_GROUPS]
+ {[...pickerGroups]
.sort((a, b) => a.groupLabel.localeCompare(b.groupLabel))
.map((group) => {
const GroupIcon = getDashboardWidgetGroupIcon(group.groupId)
diff --git a/products/dashboards/frontend/widgets/metrics/EditMetricsTableWidgetModal.stories.tsx b/products/dashboards/frontend/widgets/metrics/EditMetricsTableWidgetModal.stories.tsx
new file mode 100644
index 000000000000..ede83417c8d0
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/EditMetricsTableWidgetModal.stories.tsx
@@ -0,0 +1,49 @@
+import type { Meta, StoryObj } from '@storybook/react'
+
+import { widgetStorybookParameters } from '../../components/WidgetCard/widgetCardStoryFixtures'
+import { getDashboardWidgetCatalogEntry } from '../../widget_types/catalog'
+import { EditMetricsTableWidgetModal } from './EditMetricsTableWidgetModal'
+
+const CATALOG = getDashboardWidgetCatalogEntry('metrics_table')
+const meta: Meta<typeof EditMetricsTableWidgetModal> = {
+ title: 'Products/Dashboards/Dashboard Widgets/Widget types/Metrics/Metrics table/Widget settings',
+ component: EditMetricsTableWidgetModal,
+ parameters: { layout: 'fullscreen', ...widgetStorybookParameters },
+ args: {
+ isOpen: true,
+ onClose: () => undefined,
+ onSave: () => Promise.resolve(),
+ config: CATALOG.defaultConfig,
+ name: 'Metrics table',
+ defaultTitle: 'Metrics table',
+ description: CATALOG.description,
+ },
+}
+export default meta
+type Story = StoryObj<typeof EditMetricsTableWidgetModal>
+
+export const Default: Story = {}
+
+export const HttpEndpoints: Story = {
+ args: {
+ config: {
+ ...CATALOG.defaultConfig,
+ groupBy: 'http.route',
+ columns: [
+ { label: 'Requests/s', metricName: 'http_server_requests_total', aggregation: 'rate' },
+ {
+ label: 'Errors/s',
+ metricName: 'http_server_requests_total',
+ aggregation: 'rate',
+ filters: [{ key: 'http.response.status_code', op: 'regex', value: '5..' }],
+ },
+ {
+ label: 'p95 latency',
+ metricName: 'http_server_request_duration_seconds',
+ aggregation: 'histogram_quantile',
+ quantile: 0.95,
+ },
+ ],
+ },
+ },
+}
diff --git a/products/dashboards/frontend/widgets/metrics/EditMetricsTableWidgetModal.tsx b/products/dashboards/frontend/widgets/metrics/EditMetricsTableWidgetModal.tsx
new file mode 100644
index 000000000000..d6b909ac61ef
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/EditMetricsTableWidgetModal.tsx
@@ -0,0 +1,317 @@
+import { BindLogic, useActions, useValues } from 'kea'
+
+import { IconPlus, IconTrash } from '@posthog/icons'
+
+import { LemonButton } from 'lib/lemon-ui/LemonButton'
+import { LemonDivider } from 'lib/lemon-ui/LemonDivider'
+import { LemonField } from 'lib/lemon-ui/LemonField/LemonField'
+import { LemonInput } from 'lib/lemon-ui/LemonInput/LemonInput'
+import { LemonModal } from 'lib/lemon-ui/LemonModal'
+import { LemonSelect, type LemonSelectOptions } from 'lib/lemon-ui/LemonSelect'
+
+import { getDashboardWidgetGroupLabel } from '../../widget_types/catalog'
+import { EditWidgetModalTileDetailsSection } from '../EditWidgetModalTileDetailsSection'
+import type { DashboardWidgetEditModalProps } from '../registry'
+import {
+ METRICS_TABLE_MAX_COLUMNS,
+ type MetricsTableInterval,
+ type MetricsTableOrderDirection,
+ editMetricsTableWidgetModalLogic,
+} from './editMetricsTableWidgetModalLogic'
+import {
+ METRICS_TABLE_DATE_RANGE_OPTIONS,
+ type MetricsTableAggregation,
+ type MetricsTableColumn,
+} from './metricsTableWidgetConfigValidation'
+
+type MetricsTableFilter = NonNullable<MetricsTableColumn['filters']>[number]
+type MetricsTableFilterOp = NonNullable<MetricsTableFilter['op']>
+
+const AGGREGATION_OPTIONS: LemonSelectOptions<MetricsTableAggregation> = [
+ { value: 'rate', label: 'Rate per second (counter)' },
+ { value: 'increase', label: 'Increase (counter)' },
+ { value: 'histogram_quantile', label: 'Percentile (histogram)' },
+ { value: 'avg', label: 'Average' },
+ { value: 'sum', label: 'Sum' },
+ { value: 'min', label: 'Minimum' },
+ { value: 'max', label: 'Maximum' },
+]
+
+const FILTER_OP_OPTIONS: LemonSelectOptions<MetricsTableFilterOp> = [
+ { value: 'eq', label: '=' },
+ { value: 'neq', label: '≠' },
+ { value: 'regex', label: '=~' },
+ { value: 'not_regex', label: '!~' },
+]
+
+const INTERVAL_OPTIONS: LemonSelectOptions<MetricsTableInterval | null> = [
+ { value: null, label: 'Auto' },
+ { value: 'minute', label: '1 minute' },
+ { value: 'minute_5', label: '5 minutes' },
+ { value: 'minute_15', label: '15 minutes' },
+ { value: 'hour', label: '1 hour' },
+ { value: 'day', label: '1 day' },
+]
+
+const ORDER_DIRECTION_OPTIONS: LemonSelectOptions<MetricsTableOrderDirection> = [
+ { value: 'DESC', label: 'Highest first' },
+ { value: 'ASC', label: 'Lowest first' },
+]
+
+/** The modal edits the first filter of a column. Filters after it, set through the API, stay as they are. */
+function withFirstFilter(column: MetricsTableColumn, patch: Partial<MetricsTableFilter>): MetricsTableFilter[] {
+ const [first, ...rest] = column.filters ?? []
+ const next: MetricsTableFilter = { ...(first ?? { key: '', op: 'eq', value: '' }), ...patch }
+ return next.key.trim() ? [next, ...rest] : rest
+}
+
+function ColumnEditor({ column, index }: { column: MetricsTableColumn; index: number }): JSX.Element {
+ const { saving, columns } = useValues(editMetricsTableWidgetModalLogic)
+ const { updateColumn, removeColumn } = useActions(editMetricsTableWidgetModalLogic)
+ const filter = column.filters?.[0]
+
+ return (
+ <div className="flex flex-col gap-2 rounded border p-3" data-attr="metrics-table-widget-column">
+ <div className="flex items-end gap-2">
+ <LemonField.Pure label="Column name" className="w-32 shrink-0">
+ <LemonInput
+ value={column.label}
+ disabled={saving}
+ onChange={(label) => updateColumn(index, { label })}
+ />
+ </LemonField.Pure>
+ <LemonField.Pure label="Metric" className="flex-1 min-w-0">
+ <LemonInput
+ value={column.metricName}
+ placeholder="http_server_requests_total"
+ disabled={saving}
+ onChange={(metricName) => updateColumn(index, { metricName })}
+ />
+ </LemonField.Pure>
+ <LemonButton
+ icon={<IconTrash />}
+ size="small"
+ status="danger"
+ disabledReason={columns.length === 1 ? 'The table needs at least one column' : undefined}
+ onClick={() => removeColumn(index)}
+ tooltip="Remove column"
+ />
+ </div>
+ <div className="flex flex-wrap items-end gap-2">
+ <LemonField.Pure label="Calculation" className="w-56">
+ <LemonSelect
+ value={column.aggregation}
+ options={AGGREGATION_OPTIONS}
+ disabled={saving}
+ onChange={(aggregation) => aggregation && updateColumn(index, { aggregation })}
+ fullWidth
+ />
+ </LemonField.Pure>
+ {column.aggregation === 'histogram_quantile' ? (
+ <LemonField.Pure label="Percentile" className="w-24">
+ <LemonInput
+ type="number"
+ min={1}
+ max={99}
+ value={Math.round((column.quantile ?? 0.95) * 100)}
+ disabled={saving}
+ onChange={(value) => updateColumn(index, { quantile: Number(value) / 100 })}
+ />
+ </LemonField.Pure>
+ ) : null}
+ <LemonField.Pure label="Only where label" className="flex-1 min-w-40">
+ <div className="flex gap-1">
+ <LemonInput
+ value={filter?.key ?? ''}
+ placeholder="status"
+ disabled={saving}
+ onChange={(key) => updateColumn(index, { filters: withFirstFilter(column, { key }) })}
+ fullWidth
+ />
+ <LemonSelect
+ value={filter?.op ?? 'eq'}
+ options={FILTER_OP_OPTIONS}
+ disabled={saving || !filter}
+ onChange={(op) => op && updateColumn(index, { filters: withFirstFilter(column, { op }) })}
+ />
+ <LemonInput
+ value={filter?.value ?? ''}
+ placeholder="5.."
+ disabled={saving || !filter}
+ onChange={(value) => updateColumn(index, { filters: withFirstFilter(column, { value }) })}
+ fullWidth
+ />
+ </div>
+ </LemonField.Pure>
+ </div>
+ </div>
+ )
+}
+
+function EditMetricsTableWidgetModalContents(): JSX.Element {
+ const {
+ tileName,
+ tileDescription,
+ defaultTitle,
+ saving,
+ onClose,
+ saveDisabledReason,
+ groupBy,
+ columns,
+ dateFrom,
+ interval,
+ limit,
+ orderByColumn,
+ orderDirection,
+ } = useValues(editMetricsTableWidgetModalLogic)
+ const {
+ setTileName,
+ setTileDescription,
+ submit,
+ setGroupBy,
+ addColumn,
+ setDateFrom,
+ setInterval,
+ setLimit,
+ setOrderByColumn,
+ setOrderDirection,
+ } = useActions(editMetricsTableWidgetModalLogic)
+
+ return (
+ <LemonModal
+ isOpen
+ onClose={onClose}
+ title="Widget settings"
+ description="Show one row for each value of a label, with a column for each metric."
+ width={800}
+ footer={
+ <>
+ <div className="flex-1" />
+ <LemonButton type="secondary" onClick={onClose} disabled={saving}>
+ Cancel
+ </LemonButton>
+ <LemonButton
+ type="primary"
+ loading={saving}
+ disabledReason={saveDisabledReason}
+ onClick={() => submit()}
+ >
+ Save
+ </LemonButton>
+ </>
+ }
+ >
+ <div className="flex flex-col gap-4">
+ <EditWidgetModalTileDetailsSection
+ tileName={tileName}
+ tileDescription={tileDescription}
+ defaultTitle={defaultTitle}
+ saving={saving}
+ setTileName={setTileName}
+ setTileDescription={setTileDescription}
+ />
+ <LemonDivider className="my-0" />
+ <section className="flex flex-col gap-3">
+ <h5 className="text-sm font-semibold m-0">{getDashboardWidgetGroupLabel('metrics')}</h5>
+ <LemonField.Pure
+ label="One row for each value of"
+ help="A label on your metrics, such as http.route or service.name."
+ >
+ <LemonInput
+ value={groupBy}
+ placeholder="http.route"
+ disabled={saving}
+ onChange={setGroupBy}
+ fullWidth
+ />
+ </LemonField.Pure>
+ <div className="grid grid-cols-1 gap-4 sm:grid-cols-2">
+ <LemonField.Pure label="Date range" help="Each value is the average over this range.">
+ <LemonSelect
+ value={dateFrom}
+ disabled={saving}
+ options={METRICS_TABLE_DATE_RANGE_OPTIONS}
+ onChange={(value) => value && setDateFrom(value)}
+ fullWidth
+ />
+ </LemonField.Pure>
+ <LemonField.Pure
+ label="Point spacing"
+ help="Time between points on the full charts that open from a row. Sparklines show at most 30 points."
+ >
+ <LemonSelect
+ value={interval}
+ disabled={saving}
+ options={INTERVAL_OPTIONS}
+ onChange={setInterval}
+ fullWidth
+ />
+ </LemonField.Pure>
+ </div>
+ <div className="flex flex-col gap-2">
+ {columns.map((column, index) => (
+ <ColumnEditor key={index} column={column} index={index} />
+ ))}
+ <div>
+ <LemonButton
+ type="secondary"
+ size="small"
+ icon={<IconPlus />}
+ onClick={addColumn}
+ disabledReason={
+ columns.length >= METRICS_TABLE_MAX_COLUMNS
+ ? `A table has at most ${METRICS_TABLE_MAX_COLUMNS} columns`
+ : undefined
+ }
+ >
+ Add column
+ </LemonButton>
+ </div>
+ </div>
+ <div className="grid grid-cols-1 gap-4 sm:grid-cols-3">
+ <LemonField.Pure label="Sort by">
+ <LemonSelect
+ value={orderByColumn}
+ disabled={saving || columns.length === 0}
+ options={columns.map((column, index) => ({ value: index, label: column.label }))}
+ onChange={(value) => value != null && setOrderByColumn(value)}
+ fullWidth
+ />
+ </LemonField.Pure>
+ <LemonField.Pure label="Order">
+ <LemonSelect
+ value={orderDirection}
+ disabled={saving}
+ options={ORDER_DIRECTION_OPTIONS}
+ onChange={(value) => value && setOrderDirection(value)}
+ fullWidth
+ />
+ </LemonField.Pure>
+ <LemonField.Pure label="Number of rows" help="Show up to 100 rows.">
+ <LemonInput
+ type="number"
+ min={1}
+ max={100}
+ value={limit}
+ disabled={saving}
+ onChange={(value) => setLimit(Number(value))}
+ fullWidth
+ />
+ </LemonField.Pure>
+ </div>
+ </section>
+ </div>
+ </LemonModal>
+ )
+}
+
+export function EditMetricsTableWidgetModal({ isOpen, ...props }: DashboardWidgetEditModalProps): JSX.Element | null {
+ if (!isOpen) {
+ return null
+ }
+ return (
+ <BindLogic logic={editMetricsTableWidgetModalLogic} props={props}>
+ <EditMetricsTableWidgetModalContents />
+ </BindLogic>
+ )
+}
diff --git a/products/dashboards/frontend/widgets/metrics/MetricsTableDrilldownModal.tsx b/products/dashboards/frontend/widgets/metrics/MetricsTableDrilldownModal.tsx
new file mode 100644
index 000000000000..9205625c5469
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/MetricsTableDrilldownModal.tsx
@@ -0,0 +1,41 @@
+import { LemonModal } from '@posthog/lemon-ui'
+
+import { Query } from '~/queries/Query/Query'
+
+import type { MetricsTableWidgetConfig } from '../../generated/widget-configs.zod'
+import { buildMetricsTableDrilldownQueries } from './metricsTableDrilldown'
+
+export function MetricsTableDrilldownModal({
+ config,
+ keys,
+ onClose,
+}: {
+ config: MetricsTableWidgetConfig
+ keys: string[]
+ onClose: () => void
+}): JSX.Element | null {
+ if (keys.length === 0) {
+ return null
+ }
+ const charts = buildMetricsTableDrilldownQueries(config, keys)
+ return (
+ <LemonModal
+ isOpen
+ onClose={onClose}
+ width={1200}
+ title={keys.length === 1 ? keys[0] : `${keys.length} ${config.groupBy} values`}
+ description={keys.length === 1 ? undefined : keys.join(', ')}
+ >
+ <div className="flex flex-col gap-4" data-attr="metrics-table-widget-drilldown">
+ {charts.map((chart, index) => (
+ <section key={index} className="flex flex-col gap-1">
+ <h5 className="m-0 text-sm font-semibold">{chart.title}</h5>
+ <div className="flex h-72 flex-col">
+ <Query query={chart.query} readOnly embedded />
+ </div>
+ </section>
+ ))}
+ </div>
+ </LemonModal>
+ )
+}
diff --git a/products/dashboards/frontend/widgets/metrics/MetricsTableWidget.stories.tsx b/products/dashboards/frontend/widgets/metrics/MetricsTableWidget.stories.tsx
new file mode 100644
index 000000000000..6790bb9bd371
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/MetricsTableWidget.stories.tsx
@@ -0,0 +1,76 @@
+import type { Meta, StoryObj } from '@storybook/react'
+
+import { DashboardPlacement } from '~/types'
+
+import { WidgetCard } from '../../components/WidgetCard/WidgetCard'
+import { WidgetCardBody } from '../../components/WidgetCard/WidgetCardBody'
+import { WidgetCardHeader, widgetCardShouldHideMoreButton } from '../../components/WidgetCard/WidgetCardHeader'
+import {
+ mockMoreOverlay,
+ widgetStorybookParameters,
+ widgetTileFrameDecorator,
+} from '../../components/WidgetCard/widgetCardStoryFixtures'
+import { getDashboardWidgetCatalogEntry, getDashboardWidgetGroupLabel } from '../../widget_types/catalog'
+import type { DashboardWidgetComponentProps } from '../registry'
+import { MetricsTableWidget } from './MetricsTableWidget'
+import { metricsTableWidgetSampleResult } from './metricsTableWidgetSampleData'
+
+const CATALOG = getDashboardWidgetCatalogEntry('metrics_table')
+const CONFIGURED = { ...(CATALOG.defaultConfig as Record<string, unknown>), groupBy: 'http.route' }
+
+function StoryTile(props: DashboardWidgetComponentProps): JSX.Element {
+ return (
+ <WidgetCard className="h-full">
+ <WidgetCardHeader
+ layout={CATALOG.headerLayout}
+ title=""
+ defaultTitle={CATALOG.headerTitle ?? CATALOG.label}
+ titleHref={CATALOG.titleHref}
+ widgetTypeLabel={getDashboardWidgetGroupLabel(CATALOG.groupId)}
+ config={props.config}
+ headerMeta={CATALOG.headerMeta}
+ description={CATALOG.description}
+ showDescription
+ loading={props.loading}
+ shouldHideMoreButton={widgetCardShouldHideMoreButton(DashboardPlacement.Dashboard, false)}
+ moreButtonOverlay={mockMoreOverlay}
+ />
+ <WidgetCardBody>
+ <MetricsTableWidget {...props} />
+ </WidgetCardBody>
+ </WidgetCard>
+ )
+}
+
+const meta: Meta<typeof StoryTile> = {
+ title: 'Products/Dashboards/Dashboard Widgets/Widget types/Metrics/Metrics table',
+ component: StoryTile,
+ parameters: { layout: 'padded', ...widgetStorybookParameters },
+ decorators: [...widgetTileFrameDecorator],
+ args: {
+ tileId: 1,
+ config: CONFIGURED,
+ loading: false,
+ result: metricsTableWidgetSampleResult,
+ onRefresh: () => undefined,
+ },
+}
+export default meta
+type Story = StoryObj<typeof StoryTile>
+
+export const Populated: Story = {}
+
+export const Loading: Story = {
+ args: { loading: true, result: null },
+ parameters: {
+ testOptions: { waitForLoadersToDisappear: false },
+ },
+}
+
+export const Empty: Story = {
+ args: { result: { ...metricsTableWidgetSampleResult, rows: [], totalCount: 0, hasMore: false } },
+}
+
+export const NeedsConfiguration: Story = {
+ args: { config: CATALOG.defaultConfig as Record<string, unknown>, result: { needsConfiguration: true, rows: [] } },
+}
diff --git a/products/dashboards/frontend/widgets/metrics/MetricsTableWidget.tsx b/products/dashboards/frontend/widgets/metrics/MetricsTableWidget.tsx
new file mode 100644
index 000000000000..9f0970151950
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/MetricsTableWidget.tsx
@@ -0,0 +1,266 @@
+import posthog from 'posthog-js'
+import { useState } from 'react'
+
+import { LemonButton, LemonCheckbox, LemonTable, type LemonTableColumns } from '@posthog/lemon-ui'
+
+import {
+ WidgetCardBodyMessage,
+ WidgetCardContent,
+ WidgetContentFooter,
+ WidgetListCount,
+ WidgetLoadingState,
+} from '../../components/WidgetCard'
+import type { DashboardWidgetComponentProps } from '../registry'
+import {
+ type MetricsTableSparklineDomain,
+ metricsTableColumnFormatters,
+ metricsTableSparklineCoordinates,
+ metricsTableSparklineDomains,
+} from './metricsTableColumnScales'
+import { MetricsTableDrilldownModal } from './MetricsTableDrilldownModal'
+import { parseMetricsTableWidgetConfig } from './metricsTableWidgetConfigValidation'
+
+export type MetricsTableResultColumn = {
+ label: string
+ aggregation: string
+ unit?: string | null
+}
+
+export type MetricsTableResultRow = {
+ key: string
+ values: (number | null)[]
+ sparklines: (number | null)[][]
+}
+
+export type MetricsTableWidgetResult = {
+ needsConfiguration?: boolean
+ groupBy?: string | null
+ columns?: MetricsTableResultColumn[]
+ rows?: MetricsTableResultRow[]
+ totalCount?: number
+ hasMore?: boolean
+}
+
+const WIDGET_LIST_COUNT_ROWS = { singular: 'row', plural: 'rows' }
+const SPARKLINE_WIDTH = 72
+const SPARKLINE_HEIGHT = 24
+
+/** An SVG line instead of a chart instance, so a table with 100 rows stays cheap to render. */
+function MetricsTableSparkline({
+ points,
+ domain,
+}: {
+ points: (number | null)[]
+ domain: MetricsTableSparklineDomain
+}): JSX.Element | null {
+ if (points.length < 2) {
+ return null
+ }
+ const coordinates = metricsTableSparklineCoordinates(points, domain, {
+ width: SPARKLINE_WIDTH,
+ height: SPARKLINE_HEIGHT,
+ })
+ const line = coordinates.map(([x, y]) => `${x.toFixed(1)},${y.toFixed(1)}`).join(' ')
+ return (
+ <svg
+ width={SPARKLINE_WIDTH}
+ height={SPARKLINE_HEIGHT}
+ viewBox={`0 0 ${SPARKLINE_WIDTH} ${SPARKLINE_HEIGHT}`}
+ className="shrink-0 text-accent"
+ aria-hidden
+ >
+ <polyline
+ points={`0,${SPARKLINE_HEIGHT} ${line} ${SPARKLINE_WIDTH},${SPARKLINE_HEIGHT}`}
+ className="fill-current opacity-10"
+ />
+ <polyline points={line} fill="none" stroke="currentColor" strokeWidth={1.5} />
+ </svg>
+ )
+}
+
+export type MetricsTableSelection = {
+ selected: string[]
+ onToggle: (key: string) => void
+ onOpen: (keys: string[]) => void
+}
+
+export function MetricsTableView({
+ groupBy,
+ columns,
+ rows,
+ selection,
+}: {
+ groupBy: string
+ columns: MetricsTableResultColumn[]
+ rows: MetricsTableResultRow[]
+ /** Without it, the table is read-only, as in the add-widget preview. */
+ selection?: MetricsTableSelection
+}): JSX.Element {
+ const domains = metricsTableSparklineDomains(rows, columns.length)
+ const formatters = metricsTableColumnFormatters(rows, columns)
+ const tableColumns: LemonTableColumns<MetricsTableResultRow> = [
+ ...(selection
+ ? [
+ {
+ key: 'select',
+ width: 0,
+ render: (_: unknown, row: MetricsTableResultRow) => (
+ <LemonCheckbox
+ checked={selection.selected.includes(row.key)}
+ onChange={() => selection.onToggle(row.key)}
+ aria-label={`Select ${row.key}`}
+ />
+ ),
+ },
+ ]
+ : []),
+ {
+ key: 'key',
+ title: groupBy,
+ render: (_, row) =>
+ selection ? (
+ <LemonButton
+ size="xsmall"
+ className="font-mono max-w-[24rem]"
+ onClick={() => selection.onOpen([row.key])}
+ tooltip="Open full charts"
+ data-attr="metrics-table-widget-open-row"
+ >
+ <span className="truncate">{row.key}</span>
+ </LemonButton>
+ ) : (
+ <span className="font-mono text-xs truncate block max-w-[24rem]" title={row.key}>
+ {row.key}
+ </span>
+ ),
+ },
+ ...columns.map((column, index) => ({
+ key: `column-${index}`,
+ title: column.label,
+ align: 'right' as const,
+ render: (_: unknown, row: MetricsTableResultRow) => {
+ const value = row.values[index]
+ return (
+ <div className="flex items-center justify-end gap-2">
+ <MetricsTableSparkline points={row.sparklines[index] ?? []} domain={domains[index]} />
+ <span className="tabular-nums min-w-24 shrink-0 whitespace-nowrap text-right">
+ {value == null ? '–' : formatters[index](value)}
+ </span>
+ </div>
+ )
+ },
+ })),
+ ]
+ return (
+ <LemonTable
+ dataSource={rows}
+ columns={tableColumns}
+ rowKey="key"
+ size="small"
+ embedded
+ data-attr="metrics-table-widget-table"
+ />
+ )
+}
+
+export function MetricsTableWidget({ result, loading, config, tileId }: DashboardWidgetComponentProps): JSX.Element {
+ const payload = result as MetricsTableWidgetResult | null | undefined
+ const [selected, setSelected] = useState<string[]>([])
+ const [openKeys, setOpenKeys] = useState<string[]>([])
+
+ const openCharts = (keys: string[]): void => {
+ setOpenKeys(keys)
+ posthog.capture('dashboard widget open metrics charts clicked', {
+ widget_type: 'metrics_table',
+ tile_id: tileId,
+ row_count: keys.length,
+ })
+ }
+ const selection: MetricsTableSelection = {
+ selected,
+ onToggle: (key) =>
+ setSelected((current) =>
+ current.includes(key) ? current.filter((item) => item !== key) : [...current, key]
+ ),
+ onOpen: openCharts,
+ }
+
+ if (loading) {
+ return <WidgetLoadingState rowCount={6} />
+ }
+
+ if (!payload || payload.needsConfiguration) {
+ return (
+ <WidgetCardContent>
+ <WidgetCardBodyMessage>
+ <div className="flex max-w-sm flex-col items-center gap-1 px-2 text-balance">
+ <p className="m-0 text-base font-semibold text-primary">Pick a label and metrics</p>
+ <p className="m-0 text-sm text-muted">
+ Open the widget settings. Choose a label, such as http.route, and up to 4 metrics. The table
+ shows one row for each value of the label.
+ </p>
+ </div>
+ </WidgetCardBodyMessage>
+ </WidgetCardContent>
+ )
+ }
+
+ const rows = payload.rows ?? []
+ if (rows.length === 0) {
+ return (
+ <WidgetCardContent>
+ <WidgetCardBodyMessage>
+ <div className="flex max-w-sm flex-col items-center gap-1 px-2 text-balance">
+ <p className="m-0 text-base font-semibold text-primary">No metrics found</p>
+ <p className="m-0 text-sm text-muted">
+ No series had the {payload.groupBy} label in this date range. Check the metric names or try
+ a longer date range.
+ </p>
+ </div>
+ </WidgetCardBodyMessage>
+ </WidgetCardContent>
+ )
+ }
+
+ return (
+ <>
+ <WidgetCardContent>
+ <MetricsTableView
+ groupBy={payload.groupBy ?? ''}
+ columns={payload.columns ?? []}
+ rows={rows}
+ selection={selection}
+ />
+ </WidgetCardContent>
+ <WidgetContentFooter className="items-center gap-2">
+ {selected.length > 0 ? (
+ <>
+ <LemonButton
+ type="primary"
+ size="xsmall"
+ onClick={() => openCharts(selected)}
+ data-attr="metrics-table-widget-open-selected"
+ >
+ Open {selected.length} in full charts
+ </LemonButton>
+ <LemonButton size="xsmall" onClick={() => setSelected([])}>
+ Clear
+ </LemonButton>
+ </>
+ ) : null}
+ <WidgetListCount
+ shown={rows.length}
+ totalCount={payload.totalCount}
+ noun={WIDGET_LIST_COUNT_ROWS}
+ hasMore={payload.hasMore}
+ dataAttr="metrics-table-widget-count"
+ />
+ </WidgetContentFooter>
+ <MetricsTableDrilldownModal
+ config={parseMetricsTableWidgetConfig(config)}
+ keys={openKeys}
+ onClose={() => setOpenKeys([])}
+ />
+ </>
+ )
+}
diff --git a/products/dashboards/frontend/widgets/metrics/editMetricsTableWidgetModalLogic.test.ts b/products/dashboards/frontend/widgets/metrics/editMetricsTableWidgetModalLogic.test.ts
new file mode 100644
index 000000000000..b002e744c327
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/editMetricsTableWidgetModalLogic.test.ts
@@ -0,0 +1,88 @@
+import { expectLogic } from 'kea-test-utils'
+
+import { initKeaTests } from '~/test/init'
+
+import { editMetricsTableWidgetModalLogic } from './editMetricsTableWidgetModalLogic'
+
+const REQUESTS = { label: 'Requests/s', metricName: 'http_requests_total', aggregation: 'rate' as const }
+const LATENCY = {
+ label: 'p95',
+ metricName: 'http_request_duration_seconds',
+ aggregation: 'histogram_quantile' as const,
+ quantile: 0.95,
+}
+
+describe('editMetricsTableWidgetModalLogic', () => {
+ beforeEach(() => {
+ initKeaTests()
+ })
+
+ function mountLogic(config: Record<string, unknown>): {
+ logic: ReturnType<typeof editMetricsTableWidgetModalLogic.build>
+ onSave: jest.Mock
+ } {
+ const onSave = jest.fn().mockResolvedValue(undefined)
+ const logic = editMetricsTableWidgetModalLogic({
+ config,
+ onSave,
+ onClose: jest.fn(),
+ defaultTitle: 'Metrics table',
+ })
+ logic.mount()
+ return { logic, onSave }
+ }
+
+ it('saves the label and the columns that the user builds', async () => {
+ const { logic, onSave } = mountLogic({})
+
+ logic.actions.setGroupBy('http.route')
+ logic.actions.addColumn()
+ logic.actions.updateColumn(0, REQUESTS)
+ logic.actions.setInterval('minute_5')
+ await expectLogic(logic, () => logic.actions.submit()).toFinishAllListeners()
+
+ expect(onSave).toHaveBeenCalledTimes(1)
+ expect(onSave.mock.calls[0][0]).toMatchObject({
+ groupBy: 'http.route',
+ columns: [REQUESTS],
+ interval: 'minute_5',
+ })
+ })
+
+ it('blocks the save until every column has a metric', () => {
+ const { logic } = mountLogic({ groupBy: 'http.route' })
+
+ logic.actions.addColumn()
+ expect(logic.values.saveDisabledReason).toEqual('Pick a metric for every column')
+
+ logic.actions.updateColumn(0, { metricName: 'http_requests_total' })
+ expect(logic.values.saveDisabledReason).toBeUndefined()
+ })
+
+ it.each([2.5, 0])('blocks the save for a row limit of %s', (limit) => {
+ const { logic } = mountLogic({ groupBy: 'http.route', columns: [REQUESTS] })
+
+ logic.actions.setLimit(limit)
+
+ expect(logic.values.saveDisabledReason).toEqual('Enter a whole number of rows from 1 to 100')
+ })
+
+ it('adds a quantile only while the column reads a histogram', () => {
+ const { logic } = mountLogic({ groupBy: 'http.route', columns: [REQUESTS] })
+
+ logic.actions.updateColumn(0, { aggregation: 'histogram_quantile' })
+ expect(logic.values.columns[0].quantile).toEqual(0.95)
+
+ logic.actions.updateColumn(0, { aggregation: 'avg' })
+ expect(logic.values.columns[0].quantile).toBeUndefined()
+ })
+
+ it('keeps the sort column in range when the user removes a column', () => {
+ const { logic } = mountLogic({ groupBy: 'http.route', columns: [REQUESTS, LATENCY], orderByColumn: 1 })
+
+ logic.actions.removeColumn(1)
+
+ expect(logic.values.columns).toEqual([REQUESTS])
+ expect(logic.values.orderByColumn).toEqual(0)
+ })
+})
diff --git a/products/dashboards/frontend/widgets/metrics/editMetricsTableWidgetModalLogic.ts b/products/dashboards/frontend/widgets/metrics/editMetricsTableWidgetModalLogic.ts
new file mode 100644
index 000000000000..9f22c9d47873
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/editMetricsTableWidgetModalLogic.ts
@@ -0,0 +1,256 @@
+import { MakeLogicType, actions, afterMount, kea, listeners, path, props, reducers, selectors } from 'kea'
+
+import { lemonToast } from 'lib/lemon-ui/LemonToast'
+
+import type { MetricsTableWidgetConfig } from '../../generated/widget-configs.zod'
+import { metricsTableWidgetConfigSchema } from '../../generated/widget-configs.zod'
+import type { WidgetDateFromValue } from '../../widget_types/widgetConfigShared'
+import {
+ buildWidgetTileMetadataPatch,
+ getWidgetEditModalTileDefaults,
+ widgetEditModalTileActions,
+} from '../editWidgetModalBuilders'
+import type { DashboardWidgetEditModalProps } from '../registry'
+import {
+ METRICS_TABLE_MAX_LIMIT,
+ type MetricsTableColumn,
+ parseMetricsTableWidgetConfig,
+} from './metricsTableWidgetConfigValidation'
+
+export type EditMetricsTableWidgetModalLogicProps = Omit<DashboardWidgetEditModalProps, 'isOpen'>
+export type MetricsTableOrderDirection = 'ASC' | 'DESC'
+export type MetricsTableInterval = NonNullable<MetricsTableWidgetConfig['interval']>
+
+export const METRICS_TABLE_MAX_COLUMNS = 6
+const DEFAULT_QUANTILE = 0.95
+const NEW_COLUMN: MetricsTableColumn = { label: 'Value', metricName: '', aggregation: 'avg' }
+
+export interface editMetricsTableWidgetModalLogicValues {
+ columns: MetricsTableColumn[]
+ config: MetricsTableWidgetConfig
+ dateFrom: WidgetDateFromValue
+ defaultTitle: string
+ groupBy: string
+ interval: MetricsTableInterval | null
+ limit: number
+ onClose: () => void
+ orderByColumn: number
+ orderDirection: MetricsTableOrderDirection
+ saveDisabledReason: string | undefined
+ saving: boolean
+ tileDescription: string
+ tileName: string
+}
+
+export interface editMetricsTableWidgetModalLogicActions {
+ addColumn: () => { value: true }
+ loadConfig: (config: MetricsTableWidgetConfig) => { config: MetricsTableWidgetConfig }
+ removeColumn: (index: number) => { index: number }
+ setDateFrom: (dateFrom: WidgetDateFromValue) => { dateFrom: WidgetDateFromValue }
+ setGroupBy: (groupBy: string) => { groupBy: string }
+ setInterval: (interval: MetricsTableInterval | null) => { interval: MetricsTableInterval | null }
+ setLimit: (limit: number) => { limit: number }
+ setOrderByColumn: (orderByColumn: number) => { orderByColumn: number }
+ setOrderDirection: (orderDirection: MetricsTableOrderDirection) => {
+ orderDirection: MetricsTableOrderDirection
+ }
+ setTileDescription: (tileDescription: string) => { tileDescription: string }
+ setTileName: (tileName: string) => { tileName: string }
+ submit: () => { value: true }
+ submitFailure: () => { value: true }
+ submitSuccess: () => { value: true }
+ updateColumn: (
+ index: number,
+ patch: Partial<MetricsTableColumn>
+ ) => { index: number; patch: Partial<MetricsTableColumn> }
+}
+
+export type editMetricsTableWidgetModalLogicType = MakeLogicType<
+ editMetricsTableWidgetModalLogicValues,
+ editMetricsTableWidgetModalLogicActions,
+ EditMetricsTableWidgetModalLogicProps
+>
+
+/** A histogram quantile needs a quantile, and every other aggregation must not have one. */
+function withQuantileRule(column: MetricsTableColumn): MetricsTableColumn {
+ if (column.aggregation === 'histogram_quantile') {
+ return { ...column, quantile: column.quantile ?? DEFAULT_QUANTILE }
+ }
+ const { quantile: _quantile, ...rest } = column
+ return rest
+}
+
+export const editMetricsTableWidgetModalLogic = kea<editMetricsTableWidgetModalLogicType>([
+ path(['products', 'dashboards', 'widgets', 'metrics', 'editMetricsTableWidgetModalLogic']),
+ props({} as EditMetricsTableWidgetModalLogicProps),
+ actions({
+ ...widgetEditModalTileActions,
+ loadConfig: (config: MetricsTableWidgetConfig) => ({ config }),
+ setGroupBy: (groupBy: string) => ({ groupBy }),
+ setDateFrom: (dateFrom: WidgetDateFromValue) => ({ dateFrom }),
+ setInterval: (interval: MetricsTableInterval | null) => ({ interval }),
+ setLimit: (limit: number) => ({ limit }),
+ setOrderByColumn: (orderByColumn: number) => ({ orderByColumn }),
+ setOrderDirection: (orderDirection: MetricsTableOrderDirection) => ({ orderDirection }),
+ addColumn: true,
+ removeColumn: (index: number) => ({ index }),
+ updateColumn: (index: number, patch: Partial<MetricsTableColumn>) => ({ index, patch }),
+ submit: true,
+ submitSuccess: true,
+ submitFailure: true,
+ }),
+ reducers({
+ groupBy: [
+ '',
+ {
+ loadConfig: (_state: string, { config }: { config: MetricsTableWidgetConfig }) => config.groupBy ?? '',
+ setGroupBy: (_state: string, { groupBy }: { groupBy: string }) => groupBy,
+ },
+ ],
+ dateFrom: [
+ '-1h' as WidgetDateFromValue,
+ {
+ loadConfig: (_state: WidgetDateFromValue, { config }: { config: MetricsTableWidgetConfig }) =>
+ config.dateRange?.date_from ?? '-1h',
+ setDateFrom: (_state: WidgetDateFromValue, { dateFrom }: { dateFrom: WidgetDateFromValue }) => dateFrom,
+ },
+ ],
+ interval: [
+ null as MetricsTableInterval | null,
+ {
+ loadConfig: (_state: MetricsTableInterval | null, { config }: { config: MetricsTableWidgetConfig }) =>
+ config.interval ?? null,
+ setInterval: (
+ _state: MetricsTableInterval | null,
+ { interval }: { interval: MetricsTableInterval | null }
+ ) => interval,
+ },
+ ],
+ limit: [
+ 25,
+ {
+ loadConfig: (_state: number, { config }: { config: MetricsTableWidgetConfig }) => config.limit ?? 25,
+ setLimit: (_state: number, { limit }: { limit: number }) => limit,
+ },
+ ],
+ orderDirection: [
+ 'DESC' as MetricsTableOrderDirection,
+ {
+ loadConfig: (_state: MetricsTableOrderDirection, { config }: { config: MetricsTableWidgetConfig }) =>
+ config.orderDirection ?? 'DESC',
+ setOrderDirection: (
+ _state: MetricsTableOrderDirection,
+ { orderDirection }: { orderDirection: MetricsTableOrderDirection }
+ ) => orderDirection,
+ },
+ ],
+ orderByColumn: [
+ 0,
+ {
+ loadConfig: (_state: number, { config }: { config: MetricsTableWidgetConfig }) =>
+ config.orderByColumn ?? 0,
+ setOrderByColumn: (_state: number, { orderByColumn }: { orderByColumn: number }) => orderByColumn,
+ removeColumn: (state: number, { index }: { index: number }) =>
+ index < state ? state - 1 : index === state ? 0 : state,
+ },
+ ],
+ columns: [
+ [] as MetricsTableColumn[],
+ {
+ loadConfig: (_state: MetricsTableColumn[], { config }: { config: MetricsTableWidgetConfig }) =>
+ config.columns ?? [],
+ addColumn: (state: MetricsTableColumn[]) =>
+ state.length < METRICS_TABLE_MAX_COLUMNS ? [...state, NEW_COLUMN] : state,
+ removeColumn: (state: MetricsTableColumn[], { index }: { index: number }) =>
+ state.filter((_, columnIndex) => columnIndex !== index),
+ updateColumn: (
+ state: MetricsTableColumn[],
+ { index, patch }: { index: number; patch: Partial<MetricsTableColumn> }
+ ) =>
+ state.map((column, columnIndex) =>
+ columnIndex === index ? withQuantileRule({ ...column, ...patch }) : column
+ ),
+ },
+ ],
+ tileName: ['', { setTileName: (_state: string, { tileName }: { tileName: string }) => tileName }],
+ tileDescription: [
+ '',
+ {
+ setTileDescription: (_state: string, { tileDescription }: { tileDescription: string }) =>
+ tileDescription,
+ },
+ ],
+ saving: [false, { submit: () => true, submitSuccess: () => false, submitFailure: () => false }],
+ defaultTitle: ['Metrics table'],
+ }),
+ selectors({
+ config: [
+ (s) => [s.groupBy, s.columns, s.dateFrom, s.interval, s.limit, s.orderByColumn, s.orderDirection],
+ (
+ groupBy: string,
+ columns: MetricsTableColumn[],
+ dateFrom: WidgetDateFromValue,
+ interval: MetricsTableInterval | null,
+ limit: number,
+ orderByColumn: number,
+ orderDirection: MetricsTableOrderDirection
+ ): MetricsTableWidgetConfig => ({
+ groupBy: groupBy.trim() || null,
+ columns: columns.map((column) => ({ ...column, metricName: column.metricName.trim() })),
+ dateRange: { date_from: dateFrom },
+ interval,
+ limit,
+ orderByColumn,
+ orderDirection,
+ }),
+ ],
+ saveDisabledReason: [
+ (s) => [s.config],
+ (config: MetricsTableWidgetConfig): string | undefined => {
+ if (!config.groupBy) {
+ return 'Enter a label to make one row per value'
+ }
+ const columns: MetricsTableColumn[] = config.columns ?? []
+ if (!columns.length) {
+ return 'Add at least one column'
+ }
+ if (columns.some((column) => !column.metricName)) {
+ return 'Pick a metric for every column'
+ }
+ if (columns.some((column) => !column.label.trim())) {
+ return 'Name every column'
+ }
+ if (
+ !Number.isInteger(config.limit) ||
+ (config.limit ?? 0) < 1 ||
+ (config.limit ?? 0) > METRICS_TABLE_MAX_LIMIT
+ ) {
+ return `Enter a whole number of rows from 1 to ${METRICS_TABLE_MAX_LIMIT}`
+ }
+ return metricsTableWidgetConfigSchema.safeParse(config).success
+ ? undefined
+ : 'Check the column settings'
+ },
+ ],
+ onClose: [(_state, props) => [props.onClose], (onClose): (() => void) => onClose],
+ }),
+ listeners(({ actions, values, props }) => ({
+ submit: async () => {
+ try {
+ const config = metricsTableWidgetConfigSchema.parse(values.config)
+ await props.onSave(config, buildWidgetTileMetadataPatch(props, values.tileName, values.tileDescription))
+ actions.submitSuccess()
+ props.onClose()
+ } catch {
+ actions.submitFailure()
+ lemonToast.error('Could not save widget settings. Check your connection and try again.')
+ }
+ },
+ })),
+ afterMount(({ actions, props }) => {
+ const metadata = getWidgetEditModalTileDefaults(props)
+ actions.loadConfig(parseMetricsTableWidgetConfig(props.config))
+ actions.setTileName(metadata.tileName)
+ actions.setTileDescription(metadata.tileDescription)
+ }),
+])
diff --git a/products/dashboards/frontend/widgets/metrics/metricsTableColumnScales.test.ts b/products/dashboards/frontend/widgets/metrics/metricsTableColumnScales.test.ts
new file mode 100644
index 000000000000..2c7781f8eddc
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/metricsTableColumnScales.test.ts
@@ -0,0 +1,49 @@
+import {
+ metricsTableColumnFormatters,
+ metricsTableSparklineCoordinates,
+ metricsTableSparklineDomains,
+} from './metricsTableColumnScales'
+
+const HEIGHT = 24
+
+describe('metricsTableColumnScales', () => {
+ it.each([
+ ['mixed signs', [[-10, 10]]],
+ ['all negative', [[-30, -10, -20]]],
+ ['all positive', [[5, 10, 0]]],
+ ])('keeps every point inside the chart and spreads the line for %s values', (_name, columnValues) => {
+ const [domain] = metricsTableSparklineDomains([{ key: 'a', values: [null], sparklines: columnValues }], 1)
+
+ const ys = metricsTableSparklineCoordinates(columnValues[0], domain, { width: 96, height: HEIGHT }).map(
+ ([, y]) => y
+ )
+
+ expect(ys.every((y) => y >= 0 && y <= HEIGHT)).toBe(true)
+ expect(new Set(ys).size).toBeGreaterThan(1)
+ })
+
+ it('shares one domain across the rows of a column', () => {
+ const domains = metricsTableSparklineDomains(
+ [
+ { key: 'a', values: [null], sparklines: [[-5, 1]] },
+ { key: 'b', values: [null], sparklines: [[2, 8]] },
+ ],
+ 1
+ )
+
+ expect(domains).toEqual([{ min: -5, max: 8 }])
+ })
+
+ it('formats every value of a dimensionless column on one scale', () => {
+ const [format] = metricsTableColumnFormatters(
+ [
+ { key: 'a', values: [0.5], sparklines: [[]] },
+ { key: 'b', values: [2], sparklines: [[]] },
+ { key: 'c', values: [null], sparklines: [[]] },
+ ],
+ [{ label: 'Ratio', aggregation: 'avg', unit: '1' }]
+ )
+
+ expect([format(0.5), format(2)].map((text) => text.endsWith('%'))).toEqual([false, false])
+ })
+})
diff --git a/products/dashboards/frontend/widgets/metrics/metricsTableColumnScales.ts b/products/dashboards/frontend/widgets/metrics/metricsTableColumnScales.ts
new file mode 100644
index 000000000000..03122576f04f
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/metricsTableColumnScales.ts
@@ -0,0 +1,40 @@
+import { metricValuesFormatter } from 'products/metrics/frontend/panels/metricsUnits'
+
+import type { MetricsTableResultColumn, MetricsTableResultRow } from './MetricsTableWidget'
+
+export type MetricsTableSparklineDomain = { min: number; max: number }
+
+/** The range of each column across all rows, so the sparklines in one column share a scale. Zero stays in the range. */
+export function metricsTableSparklineDomains(
+ rows: MetricsTableResultRow[],
+ columnCount: number
+): MetricsTableSparklineDomain[] {
+ return Array.from({ length: columnCount }, (_, index) => {
+ const values = rows.flatMap((row) => (row.sparklines[index] ?? []).map((point) => point ?? 0))
+ return { min: Math.min(0, ...values), max: Math.max(0, ...values) }
+ })
+}
+
+/** SVG coordinates for a sparkline. A missing point draws at zero. */
+export function metricsTableSparklineCoordinates(
+ points: (number | null)[],
+ { min, max }: MetricsTableSparklineDomain,
+ { width, height }: { width: number; height: number }
+): [number, number][] {
+ const step = points.length > 1 ? width / (points.length - 1) : 0
+ const scale = max > min ? (height - 2) / (max - min) : 0
+ return points.map((point, index) => [index * step, height - 1 - ((point ?? 0) - min) * scale])
+}
+
+/** One value formatter per column. A dimensionless column then shows every row as a percent, or none of them. */
+export function metricsTableColumnFormatters(
+ rows: MetricsTableResultRow[],
+ columns: MetricsTableResultColumn[]
+): ((value: number) => string)[] {
+ return columns.map((column, index) =>
+ metricValuesFormatter(
+ column.unit ?? undefined,
+ rows.map((row) => row.values[index]).filter((value): value is number => value != null)
+ )
+ )
+}
diff --git a/products/dashboards/frontend/widgets/metrics/metricsTableDrilldown.test.ts b/products/dashboards/frontend/widgets/metrics/metricsTableDrilldown.test.ts
new file mode 100644
index 000000000000..194806165526
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/metricsTableDrilldown.test.ts
@@ -0,0 +1,85 @@
+import { NodeKind } from '~/queries/schema/schema-general'
+
+import { buildMetricsTableDrilldownQueries } from './metricsTableDrilldown'
+
+const CONFIG = {
+ groupBy: 'http.route',
+ dateRange: { date_from: '-3h' as const },
+ interval: 'minute' as const,
+ columns: [
+ {
+ label: 'Errors/s',
+ metricName: 'http_server_requests_total',
+ aggregation: 'rate' as const,
+ filters: [{ key: 'http.response.status_code', op: 'regex' as const, value: '5..' }],
+ },
+ {
+ label: 'p50 latency',
+ metricName: 'http_server_request_duration_seconds',
+ aggregation: 'histogram_quantile' as const,
+ quantile: 0.5,
+ },
+ ],
+}
+
+describe('buildMetricsTableDrilldownQueries', () => {
+ it('builds one full chart query per column, split by the label of the table', () => {
+ const [errors, latency] = buildMetricsTableDrilldownQueries(CONFIG, ['GET /api/traces/{id}'])
+
+ expect(errors.title).toEqual('Errors/s')
+ expect(errors.query).toEqual({
+ kind: NodeKind.MetricsQuery,
+ dateRange: { date_from: '-3h' },
+ interval: 'minute',
+ clauses: [
+ {
+ name: 'a',
+ metricName: 'http_server_requests_total',
+ aggregation: 'sum',
+ rangeFunction: 'rate',
+ filters: [
+ { key: 'http.response.status_code', op: 'regex', value: '5..' },
+ { key: 'http.route', op: 'regex', value: '^(?:GET /api/traces/\\{id\\})$' },
+ ],
+ groupBy: [{ key: 'http.route' }],
+ },
+ ],
+ })
+ expect(latency.query.clauses[0]).toMatchObject({ aggregation: 'histogram_quantile', quantile: 0.5 })
+ expect(latency.query.clauses[0].rangeFunction).toBeUndefined()
+ })
+
+ it('escapes a dollar sign so a single row is not read as a dashboard variable', () => {
+ const [errors] = buildMetricsTableDrilldownQueries(CONFIG, ['/api/$tenant'])
+
+ expect(errors.query.clauses[0].filters?.at(-1)).toEqual({
+ key: 'http.route',
+ op: 'regex',
+ value: '^(?:/api/\\$tenant)$',
+ })
+ })
+
+ it.each([
+ ['keeps the point spacing for one row', '-1h', 1, 'minute'],
+ ['coarsens the point spacing for many rows over a long range', '-14d', 50, 'hour_6'],
+ ])('%s', (_name, dateFrom, rowCount, expectedInterval) => {
+ const keys = Array.from({ length: rowCount }, (_, index) => `/api/${index}`)
+
+ const [errors] = buildMetricsTableDrilldownQueries(
+ { ...CONFIG, dateRange: { date_from: dateFrom as '-1h' } },
+ keys
+ )
+
+ expect(errors.query.interval).toEqual(expectedInterval)
+ })
+
+ it('matches several rows with one anchored regex that escapes the values', () => {
+ const [errors] = buildMetricsTableDrilldownQueries(CONFIG, ['GET /api/traces/{id}', 'POST /api/chat'])
+
+ expect(errors.query.clauses[0].filters?.at(-1)).toEqual({
+ key: 'http.route',
+ op: 'regex',
+ value: '^(?:GET /api/traces/\\{id\\}|POST /api/chat)$',
+ })
+ })
+})
diff --git a/products/dashboards/frontend/widgets/metrics/metricsTableDrilldown.ts b/products/dashboards/frontend/widgets/metrics/metricsTableDrilldown.ts
new file mode 100644
index 000000000000..f142577d7b49
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/metricsTableDrilldown.ts
@@ -0,0 +1,89 @@
+import { type MetricsQuery, type MetricsQueryClause, NodeKind } from '~/queries/schema/schema-general'
+
+import type { MetricsTableWidgetConfig } from '../../generated/widget-configs.zod'
+import type { MetricsTableColumn } from './metricsTableWidgetConfigValidation'
+
+export type MetricsTableDrilldownChart = {
+ title: string
+ query: MetricsQuery & { clauses: MetricsQueryClause[] }
+}
+
+type DrilldownConfig = Pick<MetricsTableWidgetConfig, 'groupBy' | 'dateRange' | 'interval' | 'columns'>
+
+const COUNTER_FUNCTIONS = new Set(['rate', 'increase'])
+
+function escapeRegex(value: string): string {
+ return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
+}
+
+/** An escaped regex even for one row: an `eq` value such as `/api/$tenant` reads as a dashboard variable. */
+function rowFilter(groupBy: string, keys: string[]): NonNullable<MetricsQueryClause['filters']>[number] {
+ return { key: groupBy, op: 'regex', value: `^(?:${keys.map(escapeRegex).join('|')})$` }
+}
+
+// The metrics query fails at 10,000 (bucket, series) rows, and each selected row is one series.
+const DRILLDOWN_ROW_BUDGET = 9_000
+const INTERVAL_SECONDS: [string, number][] = [
+ ['minute', 60],
+ ['minute_5', 300],
+ ['minute_15', 900],
+ ['minute_30', 1_800],
+ ['hour', 3_600],
+ ['hour_6', 21_600],
+ ['day', 86_400],
+ ['week', 604_800],
+]
+const DATE_FROM_UNIT_SECONDS: Record<string, number> = { M: 60, h: 3_600, d: 86_400, w: 604_800 }
+
+/** The requested point spacing, made coarser until the selected rows fit in the row budget of the query. */
+function drilldownInterval(interval: string | null | undefined, dateFrom: string, rowCount: number): string | null {
+ const match = /^-(\d+)([Mhdw])$/.exec(dateFrom)
+ const start = INTERVAL_SECONDS.findIndex(([name]) => name === interval)
+ if (!interval || !match || start === -1) {
+ return interval ?? null
+ }
+ const spanSeconds = Number(match[1]) * DATE_FROM_UNIT_SECONDS[match[2]]
+ const fits = INTERVAL_SECONDS.slice(start).find(
+ ([, seconds]) => (Math.ceil(spanSeconds / seconds) + 1) * rowCount <= DRILLDOWN_ROW_BUDGET
+ )
+ return (fits ?? INTERVAL_SECONDS[INTERVAL_SECONDS.length - 1])[0]
+}
+
+/** The clause the backend runs for a table column, so a full chart shows the same numbers as its row. */
+function columnClause(column: MetricsTableColumn, groupBy: string, keys: string[]): MetricsQueryClause {
+ const isCounter = COUNTER_FUNCTIONS.has(column.aggregation)
+ return {
+ name: 'a',
+ metricName: column.metricName,
+ aggregation: isCounter ? 'sum' : column.aggregation,
+ ...(isCounter ? { rangeFunction: column.aggregation as 'rate' | 'increase' } : {}),
+ ...(column.quantile != null ? { quantile: column.quantile } : {}),
+ filters: [
+ ...(column.filters ?? []).map(({ key, op, value }) => ({ key, op: op ?? 'eq', value })),
+ rowFilter(groupBy, keys),
+ ],
+ groupBy: [{ key: groupBy }],
+ }
+}
+
+/** One full chart per column for the selected rows. Each row is its own line, split by the table's label. */
+export function buildMetricsTableDrilldownQueries(
+ config: DrilldownConfig,
+ keys: string[]
+): MetricsTableDrilldownChart[] {
+ const groupBy = config.groupBy
+ if (!groupBy || keys.length === 0) {
+ return []
+ }
+ const dateFrom = config.dateRange?.date_from ?? '-1h'
+ const interval = drilldownInterval(config.interval, dateFrom, keys.length)
+ return (config.columns ?? []).map((column) => ({
+ title: column.label,
+ query: {
+ kind: NodeKind.MetricsQuery,
+ dateRange: { date_from: dateFrom },
+ ...(interval ? { interval } : {}),
+ clauses: [columnClause(column, groupBy, keys)],
+ },
+ }))
+}
diff --git a/products/dashboards/frontend/widgets/metrics/metricsTableWidgetConfigValidation.ts b/products/dashboards/frontend/widgets/metrics/metricsTableWidgetConfigValidation.ts
new file mode 100644
index 000000000000..b6a34124db3b
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/metricsTableWidgetConfigValidation.ts
@@ -0,0 +1,38 @@
+import { z } from 'zod'
+
+import { ApiError } from 'lib/api-error'
+
+import {
+ metricsTableWidgetConfigSchema,
+ metricsTableWidgetFormSchema,
+ type MetricsTableWidgetConfig,
+} from '../../generated/widget-configs.zod'
+import { WIDGET_DATE_RANGE_SELECT_OPTIONS } from '../../widget_types/widgetConfigShared'
+import { fieldErrorsFromZodError, parseWidgetConfig } from '../widgetConfigValidation'
+
+export { metricsTableWidgetConfigLimitMax as METRICS_TABLE_MAX_LIMIT } from '../../generated/widget-config-schemas/metricsTableWidgetConfig.zod'
+
+/** Metrics queries span at most 31 days, so longer presets are left out. Matches the backend config check. */
+export const METRICS_TABLE_DATE_RANGE_OPTIONS = WIDGET_DATE_RANGE_SELECT_OPTIONS.filter(
+ (option) => option.value !== '-90d'
+)
+
+export type MetricsTableColumn = NonNullable<MetricsTableWidgetConfig['columns']>[number]
+export type MetricsTableAggregation = MetricsTableColumn['aggregation']
+type MetricsTableWidgetFormField = keyof z.infer<typeof metricsTableWidgetFormSchema>
+export type MetricsTableWidgetFieldErrors = Partial<Record<MetricsTableWidgetFormField, string>>
+
+export function parseMetricsTableWidgetConfig(config: Record<string, unknown>): MetricsTableWidgetConfig {
+ return parseWidgetConfig(metricsTableWidgetConfigSchema, config)
+}
+
+export function parseMetricsTableWidgetConfigApiError(
+ error: unknown,
+ config: Record<string, unknown>
+): MetricsTableWidgetFieldErrors | null {
+ if (!(error instanceof ApiError)) {
+ return null
+ }
+ const parsed = metricsTableWidgetConfigSchema.safeParse(config)
+ return parsed.success ? null : fieldErrorsFromZodError(parsed.error)
+}
diff --git a/products/dashboards/frontend/widgets/metrics/metricsTableWidgetSampleData.ts b/products/dashboards/frontend/widgets/metrics/metricsTableWidgetSampleData.ts
new file mode 100644
index 000000000000..26e10504f54c
--- /dev/null
+++ b/products/dashboards/frontend/widgets/metrics/metricsTableWidgetSampleData.ts
@@ -0,0 +1,34 @@
+import type { MetricsTableWidgetResult } from './MetricsTableWidget'
+
+const ENDPOINTS: [string, number, number, number][] = [
+ ['POST /api/chat', 42.1, 0.38, 1.82],
+ ['POST /api/embeddings', 27.4, 0.05, 0.21],
+ ['GET /api/traces', 18.9, 0.11, 0.34],
+ ['GET /api/generations', 12.3, 0.02, 0.18],
+ ['POST /api/evaluations', 6.7, 0.41, 2.65],
+ ['GET /api/datasets', 3.2, 0, 0.09],
+]
+
+function wave(base: number, seed: number): number[] {
+ return Array.from({ length: 30 }, (_, index) => {
+ const value = base * (1 + 0.25 * Math.sin((index + seed) / 4) + 0.1 * Math.cos((index * seed) / 3))
+ return Math.max(0, Number(value.toFixed(3)))
+ })
+}
+
+export const metricsTableWidgetSampleResult: MetricsTableWidgetResult = {
+ needsConfiguration: false,
+ groupBy: 'http.route',
+ columns: [
+ { label: 'Requests/s', aggregation: 'rate', unit: '1/s' },
+ { label: 'Errors/s', aggregation: 'rate', unit: '1/s' },
+ { label: 'p95 latency', aggregation: 'histogram_quantile', unit: 's' },
+ ],
+ rows: ENDPOINTS.map(([key, requests, errors, latency], index) => ({
+ key,
+ values: [requests, errors || null, latency],
+ sparklines: [wave(requests, index + 1), errors ? wave(errors, index + 3) : [], wave(latency, index + 5)],
+ })),
+ totalCount: 24,
+ hasMore: true,
+}
diff --git a/products/dashboards/frontend/widgets/previews/MetricsTableWidgetPreview.tsx b/products/dashboards/frontend/widgets/previews/MetricsTableWidgetPreview.tsx
new file mode 100644
index 000000000000..826c1aa123bd
--- /dev/null
+++ b/products/dashboards/frontend/widgets/previews/MetricsTableWidgetPreview.tsx
@@ -0,0 +1,14 @@
+import { MetricsTableView } from '../metrics/MetricsTableWidget'
+import { metricsTableWidgetSampleResult } from '../metrics/metricsTableWidgetSampleData'
+
+export function MetricsTableWidgetPreview(): JSX.Element {
+ return (
+ <div className="shadow-sm">
+ <MetricsTableView
+ groupBy={metricsTableWidgetSampleResult.groupBy ?? ''}
+ columns={metricsTableWidgetSampleResult.columns ?? []}
+ rows={(metricsTableWidgetSampleResult.rows ?? []).slice(0, 4)}
+ />
+ </div>
+ )
+}
diff --git a/products/dashboards/frontend/widgets/previews/dashboardWidgetPreviews.ts b/products/dashboards/frontend/widgets/previews/dashboardWidgetPreviews.ts
index bbd045b8571d..e1a808ef5ff5 100644
--- a/products/dashboards/frontend/widgets/previews/dashboardWidgetPreviews.ts
+++ b/products/dashboards/frontend/widgets/previews/dashboardWidgetPreviews.ts
@@ -6,6 +6,7 @@ import { ConversationsWidgetPreview } from './ConversationsWidgetPreview'
import { ErrorTrackingWidgetPreview } from './ErrorTrackingWidgetPreview'
import { ExperimentResultsWidgetPreview, ExperimentsListWidgetPreview } from './ExperimentsWidgetPreviews'
import { LogsWidgetPreview } from './LogsWidgetPreview'
+import { MetricsTableWidgetPreview } from './MetricsTableWidgetPreview'
import { SessionReplayWidgetPreview } from './SessionReplayWidgetPreview'
import { SurveyResultsWidgetPreview } from './SurveysWidgetPreviews'
@@ -24,4 +25,5 @@ export const DASHBOARD_WIDGET_PREVIEWS: Record<DashboardWidgetCatalogKey, () =>
experiment_results: ExperimentResultsWidgetPreview,
survey_results: SurveyResultsWidgetPreview,
logs_list: LogsWidgetPreview,
+ metrics_table: MetricsTableWidgetPreview,
}
diff --git a/products/dashboards/frontend/widgets/registry.tsx b/products/dashboards/frontend/widgets/registry.tsx
index 6a8e64a83272..9eba1ea29739 100644
--- a/products/dashboards/frontend/widgets/registry.tsx
+++ b/products/dashboards/frontend/widgets/registry.tsx
@@ -26,6 +26,7 @@ import {
parseExperimentsListWidgetConfigApiError,
} from './experiments/experimentsWidgetConfigValidation'
import { parseLogsWidgetConfigApiError } from './logs/logsWidgetConfigValidation'
+import { parseMetricsTableWidgetConfigApiError } from './metrics/metricsTableWidgetConfigValidation'
import { parseSessionReplayWidgetConfigApiError } from './session_replay/sessionReplayWidgetConfigValidation'
import { parseSurveyResultsWidgetConfigApiError } from './surveys/surveysWidgetConfigValidation'
@@ -106,6 +107,12 @@ const ExperimentsListWidgetTileFilters = lazyWithRetry(() =>
const EditExperimentsListWidgetModal = lazyWithRetry(() =>
import('./experiments/EditExperimentsListWidgetModal').then((m) => ({ default: m.EditExperimentsListWidgetModal }))
)
+const MetricsTableWidget = lazyWithRetry(() =>
+ import('./metrics/MetricsTableWidget').then((m) => ({ default: m.MetricsTableWidget }))
+)
+const EditMetricsTableWidgetModal = lazyWithRetry(() =>
+ import('./metrics/EditMetricsTableWidgetModal').then((m) => ({ default: m.EditMetricsTableWidgetModal }))
+)
const LogsWidget = lazyWithRetry(() => import('./logs/LogsWidget').then((m) => ({ default: m.LogsWidget })))
const LogsWidgetTileFilters = lazyWithRetry(() =>
import('./logs/LogsWidgetTileFilters').then((m) => ({ default: m.LogsWidgetTileFilters }))
@@ -309,6 +316,12 @@ export const DASHBOARD_WIDGET_REGISTRY = {
productAccess: 'logs',
parseConfigApiError: parseLogsWidgetConfigApiError,
},
+ metrics_table: {
+ Component: MetricsTableWidget,
+ EditModal: EditMetricsTableWidgetModal,
+ parseConfigApiError: parseMetricsTableWidgetConfigApiError,
+ productAccess: 'metrics',
+ },
} satisfies Record<DashboardWidgetCatalogKey, DashboardWidgetDefinition>
function isDashboardWidgetRegistryKey(widgetType: string): widgetType is DashboardWidgetCatalogKey {
diff --git a/products/dashboards/frontend/widgets/widgetConfigSchemaParity.test.ts b/products/dashboards/frontend/widgets/widgetConfigSchemaParity.test.ts
index 62edbad89570..6953649c3d8e 100644
--- a/products/dashboards/frontend/widgets/widgetConfigSchemaParity.test.ts
+++ b/products/dashboards/frontend/widgets/widgetConfigSchemaParity.test.ts
@@ -8,6 +8,7 @@ import {
experimentResultsWidgetConfigSchema,
experimentsWidgetConfigSchema,
logsWidgetConfigSchema,
+ metricsTableWidgetConfigSchema,
notebookWidgetConfigSchema,
sessionReplayWidgetConfigSchema,
surveyResultsWidgetConfigSchema,
@@ -23,6 +24,7 @@ const WIDGET_CONFIG_SCHEMAS = {
experiments_list: experimentsWidgetConfigSchema,
experiment_results: experimentResultsWidgetConfigSchema,
logs_list: logsWidgetConfigSchema,
+ metrics_table: metricsTableWidgetConfigSchema,
notebook_widget: notebookWidgetConfigSchema,
survey_results: surveyResultsWidgetConfigSchema,
} as const
@@ -142,6 +144,10 @@ function normalizePropertyTree(tree: unknown): unknown {
const normalizedTypes = [...new Set(tree.$types.map((type) => (type === 'number' ? 'integer' : type)))].sort()
return { $types: normalizedTypes }
}
+ // Zod has one number type, so a float field (e.g. the metrics table quantile) reads as an integer.
+ if ('$type' in tree && tree.$type === 'number') {
+ return { $type: 'integer' }
+ }
return Object.fromEntries(Object.entries(tree).map(([key, value]) => [key, normalizePropertyTree(value)]))
}
diff --git a/products/desktop/packages/api-client/src/generated.ts b/products/desktop/packages/api-client/src/generated.ts
index f08381b212f0..d82ba515819f 100644
--- a/products/desktop/packages/api-client/src/generated.ts
+++ b/products/desktop/packages/api-client/src/generated.ts
@@ -6433,6 +6433,7 @@ export namespace Schemas {
* * `experiment_results` - Experiment Results
* * `experiments_list` - Experiments List
* * `logs_list` - Logs List
+ * * `metrics_table` - Metrics Table
* * `notebook_widget` - Notebook Widget
* * `session_replay_list` - Session Replay List
* * `survey_results` - Survey Results
@@ -6445,6 +6446,7 @@ export namespace Schemas {
| "experiment_results"
| "experiments_list"
| "logs_list"
+ | "metrics_table"
| "notebook_widget"
| "session_replay_list"
| "survey_results";
@@ -6583,6 +6585,49 @@ export namespace Schemas {
savedViewId: string | null;
}>;
export type CanvasAppWidgetConfig = Partial<{ canvasId: string | null }>;
+ export type MetricsTableFilter = {
+ /**
+ * Label key to filter on, e.g. `http.response.status_code`.
+ */
+ key: string;
+ op?: ("eq" | "neq" | "regex" | "not_regex") | undefined;
+ /**
+ * Label value, or a regular expression for `regex` and `not_regex`.
+ */
+ value: string;
+ };
+ export type MetricsTableColumn = {
+ /**
+ * Column header, e.g. `Requests/s`.
+ */
+ label: string;
+ /**
+ * Name of the metric this column reads.
+ */
+ metricName: string;
+ /**
+ * How each time bucket of a row is computed. `rate` and `increase` read counters.
+ */
+ aggregation:
+ | "rate"
+ | "increase"
+ | "sum"
+ | "avg"
+ | "min"
+ | "max"
+ | "histogram_quantile";
+ quantile?: (number | null) | undefined;
+ filters?: Array<MetricsTableFilter> | undefined;
+ };
+ export type MetricsTableWidgetConfig = Partial<{
+ dateRange: WidgetDateRange | null;
+ groupBy: string | null;
+ columns: Array<MetricsTableColumn>;
+ interval: ("minute" | "minute_5" | "minute_15" | "hour" | "day") | null;
+ orderByColumn: number;
+ orderDirection: "ASC" | "DESC";
+ limit: number;
+ }>;
export type DashboardWidgetConfig =
| NotebookWidgetConfig
| ActivityEventsListWidgetConfig
@@ -6593,7 +6638,8 @@ export namespace Schemas {
| SurveyResultsWidgetConfig
| LogsListWidgetConfig
| ConversationsRecentTicketsWidgetConfig
- | CanvasAppWidgetConfig;
+ | CanvasAppWidgetConfig
+ | MetricsTableWidgetConfig;
export type DashboardPatchWidgetOpenApi = Partial<{
id: string;
widget_type: DashboardWidgetTypeEnum;
diff --git a/products/metrics/backend/facade/api.py b/products/metrics/backend/facade/api.py
index f80fe34795f5..c17d2994d358 100644
--- a/products/metrics/backend/facade/api.py
+++ b/products/metrics/backend/facade/api.py
@@ -8,7 +8,7 @@ so import-linter's strict-mode contract holds.
import math
import datetime as dt
from collections.abc import Callable, Sequence
-from contextlib import nullcontext
+from contextlib import AbstractContextManager, nullcontext
from dataclasses import replace
from functools import partial
from typing import Any
@@ -69,7 +69,7 @@ from products.metrics.backend.metric_attributes_query_runner import (
)
from products.metrics.backend.metric_event_samples_query_runner import MetricEventSamplesQueryRunner
from products.metrics.backend.metric_names_query_runner import MetricNamesQueryRunner, cached_metric_names
-from products.metrics.backend.metric_query_runner import MAX_RAW_SERIES, MetricQueryRunner
+from products.metrics.backend.metric_query_runner import MAX_RAW_SERIES, MetricQueryRunner, _pick_interval
from products.metrics.backend.metric_samples_query_runner import build_metric_query_runner
from products.metrics.backend.metrics_overview_query_runner import MetricsOverviewQueryRunner
from products.metrics.backend.query_concurrency import query_concurrency_slots
@@ -174,6 +174,7 @@ def _assemble_series(
clause: MetricQueryClause,
grid: list[str],
units_by_fingerprint: dict[int, str],
+ zero_fill: bool = True,
) -> list[MetricSeries]:
"""Split bucketed rows into one series per label-set, zero-filled onto
the shared grid so every series (and later, every clause of a formula)
@@ -198,7 +199,7 @@ def _assemble_series(
return [
MetricSeries(
labels=dict(key[0]),
- points=tuple(MetricPoint(time=time, value=values.get(time, 0.0)) for time in grid),
+ points=tuple(MetricPoint(time=time, value=values.get(time, 0.0 if zero_fill else None)) for time in grid),
metric_name=clause.metric_name,
clause=clause.name,
unit=_output_unit(_unit_for_fingerprints(fingerprints_by_labels[key], units_by_fingerprint), clause),
@@ -415,6 +416,7 @@ def run_metric_query(*, team: Team, request: MetricQueryRequest) -> list[MetricS
clause=clause,
grid=grid,
units_by_fingerprint=units_by_fingerprint,
+ zero_fill=request.zero_fill,
)
for clause in request.clauses
}
@@ -433,6 +435,19 @@ def run_metric_query(*, team: Team, request: MetricQueryRequest) -> list[MetricS
]
+def metric_query_concurrency_slots(team: Team) -> AbstractContextManager[None]:
+ """Hold the concurrency slots of a metrics query runner around `run_metric_query`.
+
+ Use it when you call `run_metric_query` outside a query runner, so the query counts against the same limits.
+ """
+ return query_concurrency_slots(team)
+
+
+def pick_metric_query_interval(*, date_from: dt.datetime, date_to: dt.datetime, max_buckets: int) -> str:
+ """The finest `MetricQueryRequest.interval` that keeps the bucket count at or below `max_buckets`."""
+ return _pick_interval(date_from, date_to, target_bucket_count=max_buckets)
+
+
def list_metric_names(
*,
team: Team,
diff --git a/products/metrics/backend/facade/contracts.py b/products/metrics/backend/facade/contracts.py
index 2092075deae9..15bd6960373c 100644
--- a/products/metrics/backend/facade/contracts.py
+++ b/products/metrics/backend/facade/contracts.py
@@ -125,6 +125,9 @@ class MetricQueryRequest:
date_to: dt.datetime
interval: str | None = None
formula: str | None = None
+ # False leaves a bucket without data as a None point (a gap), so a mean over the points skips it.
+ # A formula needs aligned values, so it requires the zero fill.
+ zero_fill: bool = True
def __post_init__(self) -> None:
if not self.clauses:
@@ -133,6 +136,8 @@ class MetricQueryRequest:
raise ValueError(f"at most {MAX_CLAUSES_PER_QUERY} clauses are allowed per query")
if self.date_to <= self.date_from:
raise ValueError("date_to must be after date_from")
+ if self.formula is not None and not self.zero_fill:
+ raise ValueError("a formula requires zero_fill")
names = [c.name for c in self.clauses]
if len(names) != len(set(names)):
raise ValueError("clause names must be unique")
diff --git a/products/metrics/backend/metric_query_runner.py b/products/metrics/backend/metric_query_runner.py
index 950d544e5cf6..1f4e11533dc0 100644
--- a/products/metrics/backend/metric_query_runner.py
+++ b/products/metrics/backend/metric_query_runner.py
@@ -175,11 +175,13 @@ _INTERVAL_LADDER: list[tuple[str, dt.timedelta, ast.Call]] = [
]
-def _pick_interval(date_from: dt.datetime, date_to: dt.datetime) -> str:
+def _pick_interval(
+ date_from: dt.datetime, date_to: dt.datetime, target_bucket_count: int = _TARGET_BUCKET_COUNT
+) -> str:
"""Pick the finest interval that keeps bucket count at or below the target."""
span = date_to - date_from
for name, step, _ in _INTERVAL_LADDER:
- if span / step <= _TARGET_BUCKET_COUNT:
+ if span / step <= target_bucket_count:
return name
return _INTERVAL_LADDER[-1][0]
diff --git a/services/mcp/src/api/generated.ts b/services/mcp/src/api/generated.ts
index 45cd6a859b4a..5faaae837442 100644
--- a/services/mcp/src/api/generated.ts
+++ b/services/mcp/src/api/generated.ts
@@ -7755,6 +7755,7 @@ export namespace Schemas {
* * `experiment_results` - Experiment Results
* * `experiments_list` - Experiments List
* * `logs_list` - Logs List
+ * * `metrics_table` - Metrics Table
* * `notebook_widget` - Notebook Widget
* * `session_replay_list` - Session Replay List
* * `survey_results` - Survey Results
@@ -7770,6 +7771,7 @@ export namespace Schemas {
ExperimentResults: 'experiment_results',
ExperimentsList: 'experiments_list',
LogsList: 'logs_list',
+ MetricsTable: 'metrics_table',
NotebookWidget: 'notebook_widget',
SessionReplayList: 'session_replay_list',
SurveyResults: 'survey_results',
@@ -7797,6 +7799,7 @@ export namespace Schemas {
* * `experiment_results` - Experiment Results
* * `experiments_list` - Experiments List
* * `logs_list` - Logs List
+ * * `metrics_table` - Metrics Table
* * `notebook_widget` - Notebook Widget
* * `session_replay_list` - Session Replay List
* * `survey_results` - Survey Results */
@@ -7810,7 +7813,7 @@ export namespace Schemas {
*/
export interface AddDashboardWidgetsBatchRequestOpenApi {
/**
- * Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).
+ * Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, metrics_table, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).
* @minItems 1
* @maxItems 10
*/
@@ -11339,7 +11342,127 @@ export namespace Schemas {
canvasId?: string | null;
}
- export type DashboardWidgetConfig = NotebookWidgetConfig | ActivityEventsListWidgetConfig | ErrorTrackingListWidgetConfig | SessionReplayListWidgetConfig | ExperimentsListWidgetConfig | ExperimentResultsWidgetConfig | SurveyResultsWidgetConfig | LogsListWidgetConfig | ConversationsRecentTicketsWidgetConfig | CanvasAppWidgetConfig;
+ /**
+ * How each time bucket of a row is computed. `rate` and `increase` read counters.
+ */
+ export type MetricsTableColumnAggregation = typeof MetricsTableColumnAggregation[keyof typeof MetricsTableColumnAggregation];
+
+
+ export const MetricsTableColumnAggregation = {
+ Rate: 'rate',
+ Increase: 'increase',
+ Sum: 'sum',
+ Avg: 'avg',
+ Min: 'min',
+ Max: 'max',
+ HistogramQuantile: 'histogram_quantile',
+ } as const;
+
+ /**
+ * How the label value is compared.
+ */
+ export type MetricsTableFilterOp = typeof MetricsTableFilterOp[keyof typeof MetricsTableFilterOp];
+
+
+ export const MetricsTableFilterOp = {
+ Eq: 'eq',
+ Neq: 'neq',
+ Regex: 'regex',
+ NotRegex: 'not_regex',
+ } as const;
+
+ export interface MetricsTableFilter {
+ /**
+ * Label key to filter on, e.g. `http.response.status_code`.
+ * @minLength 1
+ * @maxLength 200
+ */
+ key: string;
+ /** How the label value is compared. */
+ op?: MetricsTableFilterOp;
+ /**
+ * Label value, or a regular expression for `regex` and `not_regex`.
+ * @maxLength 400
+ */
+ value: string;
+ }
+
+ export interface MetricsTableColumn {
+ /**
+ * Column header, e.g. `Requests/s`.
+ * @minLength 1
+ * @maxLength 40
+ */
+ label: string;
+ /**
+ * Name of the metric this column reads.
+ * @minLength 1
+ * @maxLength 200
+ */
+ metricName: string;
+ /** How each time bucket of a row is computed. `rate` and `increase` read counters. */
+ aggregation: MetricsTableColumnAggregation;
+ /** Required for `histogram_quantile`, e.g. 0.95 for p95. */
+ quantile?: number | null;
+ /**
+ * Label filters for this column only, e.g. 5xx status codes for an errors column.
+ * @maxItems 5
+ */
+ filters?: MetricsTableFilter[];
+ }
+
+ /**
+ * Time between the points of the full charts that open from a row. Null picks one from the date range. The table sparklines always use at most 30 points.
+ */
+ export type MetricsTableWidgetConfigInterval = typeof MetricsTableWidgetConfigInterval[keyof typeof MetricsTableWidgetConfigInterval] | null;
+
+
+ export const MetricsTableWidgetConfigInterval = {
+ Minute: 'minute',
+ Minute5: 'minute_5',
+ Minute15: 'minute_15',
+ Hour: 'hour',
+ Day: 'day',
+ } as const;
+
+ /**
+ * Sort direction for orderByColumn.
+ */
+ export type MetricsTableWidgetConfigOrderDirection = typeof MetricsTableWidgetConfigOrderDirection[keyof typeof MetricsTableWidgetConfigOrderDirection];
+
+
+ export const MetricsTableWidgetConfigOrderDirection = {
+ Asc: 'ASC',
+ Desc: 'DESC',
+ } as const;
+
+ export interface MetricsTableWidgetConfig {
+ dateRange?: WidgetDateRange | null;
+ /** Label that makes one row per value, e.g. `http.route`. Null until the user sets it. */
+ groupBy?: string | null;
+ /**
+ * One metric per column. Each row shows the column's average over the date range and a sparkline.
+ * @maxItems 6
+ */
+ columns?: MetricsTableColumn[];
+ /** Time between the points of the full charts that open from a row. Null picks one from the date range. The table sparklines always use at most 30 points. */
+ interval?: MetricsTableWidgetConfigInterval;
+ /**
+ * Index of the column that sorts the rows.
+ * @minimum 0
+ */
+ orderByColumn?: number;
+ /** Sort direction for orderByColumn. */
+ orderDirection?: MetricsTableWidgetConfigOrderDirection;
+ /**
+ * Maximum number of rows to show.
+ * @minimum 1
+ * @maximum 100
+ */
+ limit?: number;
+ }
+
+ export type DashboardWidgetConfig = NotebookWidgetConfig | ActivityEventsListWidgetConfig | ErrorTrackingListWidgetConfig | SessionReplayListWidgetConfig | ExperimentsListWidgetConfig | ExperimentResultsWidgetConfig | SurveyResultsWidgetConfig | LogsListWidgetConfig | ConversationsRecentTicketsWidgetConfig | CanvasAppWidgetConfig | MetricsTableWidgetConfig;
export interface DashboardWidget {
readonly id: string;
@@ -28685,6 +28808,7 @@ export namespace Schemas {
* * `experiment_results` - Experiment Results
* * `experiments_list` - Experiments List
* * `logs_list` - Logs List
+ * * `metrics_table` - Metrics Table
* * `notebook_widget` - Notebook Widget
* * `session_replay_list` - Session Replay List
* * `survey_results` - Survey Results */
@@ -70374,6 +70498,37 @@ export namespace Schemas {
dashboard_id: number | null;
}
+ export type MetricsTableWidgetCatalogEntryOpenApiWidgetType = typeof MetricsTableWidgetCatalogEntryOpenApiWidgetType[keyof typeof MetricsTableWidgetCatalogEntryOpenApiWidgetType];
+
+
+ export const MetricsTableWidgetCatalogEntryOpenApiWidgetType = {
+ MetricsTable: 'metrics_table',
+ } as const;
+
+ export interface MetricsTableWidgetCatalogEntryOpenApi {
+ widget_type: MetricsTableWidgetCatalogEntryOpenApiWidgetType;
+ group_id: string;
+ group_label: string;
+ label: string;
+ description: string;
+ /** Config shape for this widget type. Build the config for the batch add and batch update tools from it, because their schemas do not list config keys. */
+ readonly config_schema: MetricsTableWidgetConfig;
+ /** @nullable */
+ required_product_access?: string | null;
+ /** Whether tiles of this type self-update in real time after load. Live tiles show a fixed real-time window and cannot apply test-account filtering to the stream, so their config takes neither dateRange nor filterTestAccounts. */
+ live: boolean;
+ }
+
+ /**
+ * * `metrics_table` - metrics_table
+ */
+ export type MetricsTableWidgetTypeEnum = typeof MetricsTableWidgetTypeEnum[keyof typeof MetricsTableWidgetTypeEnum];
+
+
+ export const MetricsTableWidgetTypeEnum = {
+ MetricsTable: 'metrics_table',
+ } as const;
+
export interface MicrosoftDefenderCloudAppsScannerFindingSignalExtra {
severity_value: string | null;
resolution_status_value: string | null;
@@ -91161,6 +91316,7 @@ export namespace Schemas {
* * `experiment_results` - Experiment Results
* * `experiments_list` - Experiments List
* * `logs_list` - Logs List
+ * * `metrics_table` - Metrics Table
* * `notebook_widget` - Notebook Widget
* * `session_replay_list` - Session Replay List
* * `survey_results` - Survey Results */
@@ -119597,7 +119753,7 @@ export namespace Schemas {
generation_id: string;
}
- export type WidgetCatalogEntry = NotebookWidgetCatalogEntryOpenApi | ActivityEventsListWidgetCatalogEntryOpenApi | ErrorTrackingListWidgetCatalogEntryOpenApi | SessionReplayListWidgetCatalogEntryOpenApi | ExperimentsListWidgetCatalogEntryOpenApi | ExperimentResultsWidgetCatalogEntryOpenApi | SurveyResultsWidgetCatalogEntryOpenApi | LogsListWidgetCatalogEntryOpenApi | ConversationsRecentTicketsWidgetCatalogEntryOpenApi | CanvasAppWidgetCatalogEntryOpenApi;
+ export type WidgetCatalogEntry = NotebookWidgetCatalogEntryOpenApi | ActivityEventsListWidgetCatalogEntryOpenApi | ErrorTrackingListWidgetCatalogEntryOpenApi | SessionReplayListWidgetCatalogEntryOpenApi | ExperimentsListWidgetCatalogEntryOpenApi | ExperimentResultsWidgetCatalogEntryOpenApi | SurveyResultsWidgetCatalogEntryOpenApi | LogsListWidgetCatalogEntryOpenApi | ConversationsRecentTicketsWidgetCatalogEntryOpenApi | CanvasAppWidgetCatalogEntryOpenApi | MetricsTableWidgetCatalogEntryOpenApi;
export interface WidgetCatalogResponse {
/** Registered dashboard widget types. */
@@ -127876,6 +128032,7 @@ export namespace Schemas {
ExperimentResults: 'experiment_results',
ExperimentsList: 'experiments_list',
LogsList: 'logs_list',
+ MetricsTable: 'metrics_table',
NotebookWidget: 'notebook_widget',
SessionReplayList: 'session_replay_list',
SurveyResults: 'survey_results',
diff --git a/services/mcp/src/generated/dashboards/api.ts b/services/mcp/src/generated/dashboards/api.ts
index c79f64185a62..69d02fb776e8 100644
--- a/services/mcp/src/generated/dashboards/api.ts
+++ b/services/mcp/src/generated/dashboards/api.ts
@@ -950,15 +950,16 @@ export const DashboardsWidgetsBatchCreateBody = () => zod
'experiment_results',
'experiments_list',
'logs_list',
+ 'metrics_table',
'notebook_widget',
'session_replay_list',
'survey_results',
])
.describe(
- '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `metrics_table` - Metrics Table\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
)
.describe(
- 'Widget type to add. Use dashboard-widget-catalog-list to pick one.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ 'Widget type to add. Use dashboard-widget-catalog-list to pick one.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `metrics_table` - Metrics Table\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
),
config: zod
.record(zod.string(), zod.unknown())
@@ -970,7 +971,7 @@ export const DashboardsWidgetsBatchCreateBody = () => zod
.min(1)
.max(dashboardsWidgetsBatchCreateBodyWidgetsMax)
.describe(
- 'Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).'
+ 'Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, metrics_table, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).'
),
})
.describe('OpenAPI-only batch-add schema with widget_type-discriminated config shapes for agents.')
@@ -1029,16 +1030,17 @@ export const DashboardsUpdateWidgetsBatchBody = () => zod
'experiment_results',
'experiments_list',
'logs_list',
+ 'metrics_table',
'notebook_widget',
'session_replay_list',
'survey_results',
])
.describe(
- '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
+ '\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `metrics_table` - Metrics Table\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results'
)
.optional()
.describe(
- "The tile's widget type. It cannot be changed, so omit it or pass the current type.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results"
+ "The tile's widget type. It cannot be changed, so omit it or pass the current type.\n\n\* `activity_events_list` - Activity Events List\n\* `canvas_app` - Canvas App\n\* `conversations_recent_tickets` - Conversations Recent Tickets\n\* `error_tracking_list` - Error Tracking List\n\* `experiment_results` - Experiment Results\n\* `experiments_list` - Experiments List\n\* `logs_list` - Logs List\n\* `metrics_table` - Metrics Table\n\* `notebook_widget` - Notebook Widget\n\* `session_replay_list` - Session Replay List\n\* `survey_results` - Survey Results"
),
config: zod
.record(zod.string(), zod.unknown())
@@ -1106,6 +1108,7 @@ export const DashboardsWidgetCatalogRetrieveQueryParams = () => zod.object({
'experiment_results',
'experiments_list',
'logs_list',
+ 'metrics_table',
'notebook_widget',
'session_replay_list',
'survey_results',
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widget-catalog-list.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widget-catalog-list.json
index b029d140af48..aeca606c296d 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widget-catalog-list.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widget-catalog-list.json
@@ -12,6 +12,7 @@
"experiment_results",
"experiments_list",
"logs_list",
+ "metrics_table",
"notebook_widget",
"session_replay_list",
"survey_results"
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-add.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-add.json
index 8ac18831274b..0b4b3a093ef8 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-add.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-add.json
@@ -6,7 +6,7 @@
"type": "number"
},
"widgets": {
- "description": "Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).",
+ "description": "Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, metrics_table, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).",
"items": {
"properties": {
"config": {
@@ -88,7 +88,7 @@
"type": "boolean"
},
"widget_type": {
- "description": "Widget type to add. Use dashboard-widget-catalog-list to pick one.\n\n* `activity_events_list` - Activity Events List\n* `canvas_app` - Canvas App\n* `conversations_recent_tickets` - Conversations Recent Tickets\n* `error_tracking_list` - Error Tracking List\n* `experiment_results` - Experiment Results\n* `experiments_list` - Experiments List\n* `logs_list` - Logs List\n* `notebook_widget` - Notebook Widget\n* `session_replay_list` - Session Replay List\n* `survey_results` - Survey Results",
+ "description": "Widget type to add. Use dashboard-widget-catalog-list to pick one.\n\n* `activity_events_list` - Activity Events List\n* `canvas_app` - Canvas App\n* `conversations_recent_tickets` - Conversations Recent Tickets\n* `error_tracking_list` - Error Tracking List\n* `experiment_results` - Experiment Results\n* `experiments_list` - Experiments List\n* `logs_list` - Logs List\n* `metrics_table` - Metrics Table\n* `notebook_widget` - Notebook Widget\n* `session_replay_list` - Session Replay List\n* `survey_results` - Survey Results",
"enum": [
"activity_events_list",
"canvas_app",
@@ -97,6 +97,7 @@
"experiment_results",
"experiments_list",
"logs_list",
+ "metrics_table",
"notebook_widget",
"session_replay_list",
"survey_results"
diff --git a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-update.json b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-update.json
index 07ecd70f34a4..3310816cecb0 100644
--- a/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-update.json
+++ b/services/mcp/tests/unit/__snapshots__/tool-schemas/dashboard-widgets-batch-update.json
@@ -38,7 +38,7 @@
"type": "number"
},
"widget_type": {
- "description": "The tile's widget type. It cannot be changed, so omit it or pass the current type.\n\n* `activity_events_list` - Activity Events List\n* `canvas_app` - Canvas App\n* `conversations_recent_tickets` - Conversations Recent Tickets\n* `error_tracking_list` - Error Tracking List\n* `experiment_results` - Experiment Results\n* `experiments_list` - Experiments List\n* `logs_list` - Logs List\n* `notebook_widget` - Notebook Widget\n* `session_replay_list` - Session Replay List\n* `survey_results` - Survey Results",
+ "description": "The tile's widget type. It cannot be changed, so omit it or pass the current type.\n\n* `activity_events_list` - Activity Events List\n* `canvas_app` - Canvas App\n* `conversations_recent_tickets` - Conversations Recent Tickets\n* `error_tracking_list` - Error Tracking List\n* `experiment_results` - Experiment Results\n* `experiments_list` - Experiments List\n* `logs_list` - Logs List\n* `metrics_table` - Metrics Table\n* `notebook_widget` - Notebook Widget\n* `session_replay_list` - Session Replay List\n* `survey_results` - Survey Results",
"enum": [
"activity_events_list",
"canvas_app",
@@ -47,6 +47,7 @@
"experiment_results",
"experiments_list",
"logs_list",
+ "metrics_table",
"notebook_widget",
"session_replay_list",
"survey_results"
diff --git a/tach.toml b/tach.toml
index 8426cd280244..1f0d9a4863d0 100644
--- a/tach.toml
+++ b/tach.toml
@@ -304,6 +304,8 @@ depends_on = [
"products.feature_flags",
"products.logs",
"products.mcp_analytics",
+ # Facade-only: the metrics_table widget runs its query through the metrics facade.
+ "products.metrics",
"products.notifications",
"products.product_analytics",
"products.conversations",