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(metrics): limit attribute value suggestions to the selected metric (#120424)

Frank Hamandb8fd5a86b51e
diff --git a/products/metrics/backend/facade/api.py b/products/metrics/backend/facade/api.py
index 2a85abb4a039..43f118b2f34d 100644
--- a/products/metrics/backend/facade/api.py
+++ b/products/metrics/backend/facade/api.py
@@ -485,6 +485,7 @@ def list_metric_attribute_values(
*,
team: Team,
key: str,
+ metric_name: str = "",
search: str = "",
date_from: dt.datetime | None = None,
date_to: dt.datetime | None = None,
@@ -493,13 +494,20 @@ def list_metric_attribute_values(
"""List observed values for one metric attribute key, most frequent first,
for the filter bar's value autocomplete.
- `service_name`/`service.name` read the first-class column, matching how
- filters on it execute. The window defaults to the last 24 hours. Returns
+ When a metric name is provided, only values seen on that metric supply
+ choices. `service_name`/`service.name` read the first-class column,
+ matching how filters on it execute. The window defaults to the last 24 hours. Returns
`{"id": str, "name": str, "count": int}` dicts. Raises `ValueError` for an
empty key, an out-of-range limit, or an inverted window.
"""
runner = MetricAttributeValuesQueryRunner(
- team=team, key=key, search=search, date_from=date_from, date_to=date_to, limit=limit
+ team=team,
+ key=key,
+ metric_name=metric_name,
+ search=search,
+ date_from=date_from,
+ date_to=date_to,
+ limit=limit,
)
return runner.run()
diff --git a/products/metrics/backend/metric_attributes_query_runner.py b/products/metrics/backend/metric_attributes_query_runner.py
index 9e5bde1ec41b..d4f660cd1957 100644
--- a/products/metrics/backend/metric_attributes_query_runner.py
+++ b/products/metrics/backend/metric_attributes_query_runner.py
@@ -1,7 +1,7 @@
"""Attribute key/value autocomplete for the metrics filter bar.
Keys for one metric count distinct attribute values from recent series metadata.
-Keys across all metrics and values use the `metric_attributes` aggregate table:
+Keys across all metrics and values (for one metric or all) use the `metric_attributes` aggregate table:
scanning series metadata without a metric name reads every attribute map.
Both queries merge metric attributes and resource attributes.
"""
@@ -161,13 +161,15 @@ class MetricAttributeKeysQueryRunner:
class MetricAttributeValuesQueryRunner:
"""Observed values for one attribute key in a window, most frequent first.
`service_name`/`service.name` read the first-class column instead of
- attribute rows, matching how filters on it are executed."""
+ attribute rows, matching how filters on it are executed. A metric name
+ limits values to values seen on that metric."""
def __init__(
self,
team: Team,
*,
key: str,
+ metric_name: str = "",
search: str = "",
date_from: dt.datetime | None = None,
date_to: dt.datetime | None = None,
@@ -177,6 +179,7 @@ class MetricAttributeValuesQueryRunner:
raise ValueError("key is required")
self.team = team
self.key = key
+ self.metric_name = metric_name.strip()
self.search = search.strip()
self.date_from, self.date_to = _resolve_window(date_from, date_to)
self.limit = _validate_limit(limit)
@@ -191,6 +194,7 @@ class MetricAttributeValuesQueryRunner:
FROM posthog.metric_attributes
WHERE time_bucket >= {date_from}
AND time_bucket < {date_to}
+ AND {metric_name_filter}
AND service_name ILIKE {search_pattern}
GROUP BY service_name
ORDER BY
@@ -210,6 +214,7 @@ class MetricAttributeValuesQueryRunner:
FROM posthog.metric_attributes
WHERE time_bucket >= {date_from}
AND time_bucket < {date_to}
+ AND {metric_name_filter}
AND attribute_key = {key}
AND attribute_value ILIKE {search_pattern}
GROUP BY attribute_value
@@ -238,6 +243,15 @@ class MetricAttributeValuesQueryRunner:
"date_from": ast.Constant(value=self.date_from),
"date_to": ast.Constant(value=self.date_to),
"key": ast.Constant(value=self.key),
+ "metric_name_filter": (
+ ast.CompareOperation(
+ op=ast.CompareOperationOp.Eq,
+ left=ast.Field(chain=["metric_name"]),
+ right=ast.Constant(value=self.metric_name),
+ )
+ if self.metric_name
+ else ast.Constant(value=True)
+ ),
"search_pattern": ast.Constant(value=ilike_pattern(self.search)),
"exact": ast.Constant(value=self.search),
"limit": ast.Constant(value=self.limit),
diff --git a/products/metrics/backend/presentation/api.py b/products/metrics/backend/presentation/api.py
index 99634670ab07..5b4c316a0b97 100644
--- a/products/metrics/backend/presentation/api.py
+++ b/products/metrics/backend/presentation/api.py
@@ -645,6 +645,13 @@ class _MetricAttributeValuesParamsSerializer(serializers.Serializer):
max_length=255,
help_text="Attribute key to list values for (e.g. 'env'). 'service_name'/'service.name' list service names.",
)
+ metricName = serializers.CharField(
+ required=False,
+ allow_blank=True,
+ default="",
+ max_length=255,
+ help_text="Exact metric name to limit values to. Omit to list values across all metrics.",
+ )
value = serializers.CharField(
required=False,
allow_blank=True,
@@ -1101,7 +1108,8 @@ class MetricsViewSet(TeamAndOrgViewSetMixin, viewsets.ViewSet):
)
def attribute_values(self, request: Request, *args, **kwargs) -> Response:
"""Observed values for one metric attribute key, most frequent first.
- Backs the filter bar's value autocomplete."""
+ Backs the filter bar's value autocomplete. `metricName` limits choices
+ to one metric."""
tag_queries(product=Product.METRICS, feature=Feature.QUERY)
params = _MetricAttributeValuesParamsSerializer(data=request.query_params)
@@ -1111,6 +1119,7 @@ class MetricsViewSet(TeamAndOrgViewSetMixin, viewsets.ViewSet):
results = list_metric_attribute_values(
team=self.team,
key=params.validated_data["key"],
+ metric_name=params.validated_data["metricName"],
search=params.validated_data["value"],
date_from=params.validated_data["dateFrom"],
date_to=params.validated_data["dateTo"],
diff --git a/products/metrics/backend/tests/test_metric_attributes.py b/products/metrics/backend/tests/test_metric_attributes.py
index 4916be2c21b8..2b5da2a2be7c 100644
--- a/products/metrics/backend/tests/test_metric_attributes.py
+++ b/products/metrics/backend/tests/test_metric_attributes.py
@@ -120,6 +120,24 @@ class TestMetricAttributesAPI(ClickhouseTestMixin, APIBaseTest):
assert response.status_code == status.HTTP_200_OK
assert [r["name"] for r in response.json()["results"]] == ["prod"]
+ @parameterized.expand(
+ [
+ ("matching_metric", "http_requests", "region", ["us"]),
+ ("other_metric", "queue_depth", "region", []),
+ ("service_name_matching_metric", "http_requests", "service_name", ["checkout", "billing"]),
+ ("service_name_unknown_metric", "missing_metric", "service_name", []),
+ ]
+ )
+ def test_attribute_values_metric_name_limits_values_to_that_metric(
+ self, _name: str, metric_name: str, key: str, expected: list[str]
+ ) -> None:
+ response = self._get(
+ "attribute_values",
+ {"key": key, "metricName": metric_name, "dateFrom": (self.now - dt.timedelta(hours=6)).isoformat()},
+ )
+ assert response.status_code == status.HTTP_200_OK, response.json()
+ assert [r["name"] for r in response.json()["results"]] == expected
+
@parameterized.expand([("underscore_spelling", "service_name"), ("dotted_spelling", "service.name")])
def test_attribute_values_for_service_name_read_the_column(self, _name: str, key: str) -> None:
response = self._get("attribute_values", {"key": key})
diff --git a/products/metrics/frontend/generated/api.schemas.ts b/products/metrics/frontend/generated/api.schemas.ts
index b680a0be8e31..bdf934b6db9b 100644
--- a/products/metrics/frontend/generated/api.schemas.ts
+++ b/products/metrics/frontend/generated/api.schemas.ts
@@ -1328,6 +1328,11 @@ export type MetricsAttributeValuesRetrieveParams = {
* @maximum 1000
*/
limit?: number
+ /**
+ * Exact metric name to limit values to. Omit to list values across all metrics.
+ * @maxLength 255
+ */
+ metricName?: string
/**
* Substring filter (case-insensitive) applied to values. Named 'value' to match the property-values autocomplete convention.
* @maxLength 1024
diff --git a/products/metrics/frontend/generated/api.ts b/products/metrics/frontend/generated/api.ts
index 481d272cf6ad..83d20941f2e7 100644
--- a/products/metrics/frontend/generated/api.ts
+++ b/products/metrics/frontend/generated/api.ts
@@ -106,7 +106,8 @@ export const getMetricsAttributeValuesRetrieveUrl = (
/**
* Observed values for one metric attribute key, most frequent first.
- * Backs the filter bar's value autocomplete.
+ * Backs the filter bar's value autocomplete. `metricName` limits choices
+ * to one metric.
*/
export const metricsAttributeValuesRetrieve = async (
projectId: string,
diff --git a/services/mcp/src/api/generated.ts b/services/mcp/src/api/generated.ts
index c015f0cb7c76..55efb514397b 100644
--- a/services/mcp/src/api/generated.ts
+++ b/services/mcp/src/api/generated.ts
@@ -130275,6 +130275,11 @@ export namespace Schemas {
* @maximum 1000
*/
limit?: number;
+ /**
+ * Exact metric name to limit values to. Omit to list values across all metrics.
+ * @maxLength 255
+ */
+ metricName?: string;
/**
* Substring filter (case-insensitive) applied to values. Named 'value' to match the property-values autocomplete convention.
* @maxLength 1024
diff --git a/services/mcp/src/generated/metrics/api.ts b/services/mcp/src/generated/metrics/api.ts
index 0d914bfa4b56..31e1997b4b50 100644
--- a/services/mcp/src/generated/metrics/api.ts
+++ b/services/mcp/src/generated/metrics/api.ts
@@ -10,7 +10,8 @@ import * as zod from 'zod'
/**
* Observed values for one metric attribute key, most frequent first.
- * Backs the filter bar's value autocomplete.
+ * Backs the filter bar's value autocomplete. `metricName` limits choices
+ * to one metric.
*/
export const MetricsAttributeValuesRetrieveParams = () => zod.object({
project_id: zod
@@ -25,6 +26,9 @@ export const metricsAttributeValuesRetrieveQueryKeyMax = 255
export const metricsAttributeValuesRetrieveQueryLimitDefault = 100
export const metricsAttributeValuesRetrieveQueryLimitMax = 1000
+export const metricsAttributeValuesRetrieveQueryMetricNameDefault = ``
+export const metricsAttributeValuesRetrieveQueryMetricNameMax = 255
+
export const metricsAttributeValuesRetrieveQueryValueDefault = ``
export const metricsAttributeValuesRetrieveQueryValueMax = 1024
@@ -50,6 +54,11 @@ export const MetricsAttributeValuesRetrieveQueryParams = () => zod.object({
.max(metricsAttributeValuesRetrieveQueryLimitMax)
.default(metricsAttributeValuesRetrieveQueryLimitDefault)
.describe('Max number of values to return. Defaults to 100; maximum 1000.'),
+ metricName: zod
+ .string()
+ .max(metricsAttributeValuesRetrieveQueryMetricNameMax)
+ .default(metricsAttributeValuesRetrieveQueryMetricNameDefault)
+ .describe('Exact metric name to limit values to. Omit to list values across all metrics.'),
value: zod
.string()
.max(metricsAttributeValuesRetrieveQueryValueMax)
diff --git a/services/mcp/src/tools/generated/metrics.ts b/services/mcp/src/tools/generated/metrics.ts
index 5b24c6e3fdca..877308df7f06 100644
--- a/services/mcp/src/tools/generated/metrics.ts
+++ b/services/mcp/src/tools/generated/metrics.ts
@@ -53,6 +53,7 @@ const metricAttributeValuesList = (): ToolBase<
dateTo: params.dateTo,
key: params.key,
limit: params.limit,
+ metricName: params.metricName,
value: params.value,
},
})