Skip to content

🪢 Open source agent evals & observability: Trace, evaluate, and improve LLM applications with one open platform.

fix(clickhouse): label client-closed streams and tag the dashboard stream route (#19309)

Niklas Semmler4bbe46d23094
diff --git a/packages/shared/src/server/clickhouse/queryOutcome.ts b/packages/shared/src/server/clickhouse/queryOutcome.ts
index c8212b1302..89e8b5b497 100644
--- a/packages/shared/src/server/clickhouse/queryOutcome.ts
+++ b/packages/shared/src/server/clickhouse/queryOutcome.ts
@@ -24,9 +24,13 @@ export const CLICKHOUSE_QUERY_OUTCOME_METRIC =
export const CLICKHOUSE_QUERY_ELAPSED_MS_METRIC =
"langfuse.clickhouse.query.elapsed_ms";
+/**
+ * `client_closed` is not a ClickHouse failure: the caller aborted or stopped
+ * reading a streamed result, e.g. a browser closing a dashboard stream.
+ */
export type ClickHouseQueryOutcome =
| "success"
- | "cancelled"
+ | "client_closed"
| "timeout"
| "memory_limit"
| "overcommit"
diff --git a/packages/shared/src/server/clickhouse/queryTags.ts b/packages/shared/src/server/clickhouse/queryTags.ts
index 0e116709ff..beda159d31 100644
--- a/packages/shared/src/server/clickhouse/queryTags.ts
+++ b/packages/shared/src/server/clickhouse/queryTags.ts
@@ -9,6 +9,7 @@ export const clickHouseQuerySurfaces = [
"publicapi",
"mcp",
"ssr",
+ "internalapi",
] as const;
export type ClickHouseQuerySurface = (typeof clickHouseQuerySurfaces)[number];
diff --git a/packages/shared/src/server/repositories/clickhouse.test.ts b/packages/shared/src/server/repositories/clickhouse.test.ts
index c5b9084009..c0495dfb39 100644
--- a/packages/shared/src/server/repositories/clickhouse.test.ts
+++ b/packages/shared/src/server/repositories/clickhouse.test.ts
@@ -124,13 +124,13 @@ describe("queryClickhouseWithProgress", () => {
);
expect(mocks.query).toHaveBeenCalledOnce();
expect(mocks.recordOutcome).toHaveBeenCalledOnce();
- expect(mocks.recordOutcome.mock.calls[0][0]).toBe("cancelled");
+ expect(mocks.recordOutcome.mock.calls[0][0]).toBe("client_closed");
expect(mocks.recordElapsed).not.toHaveBeenCalled();
},
);
it.each([
- [{ row: { id: "row-1" } }, "cancelled"],
+ [{ row: { id: "row-1" } }, "client_closed"],
[{ exception: "Code: 159. DB::Exception: Timeout exceeded" }, "timeout"],
])("counts early consumer closure once: %j", async (event, outcome) => {
mocks.query.mockResolvedValueOnce(response([event]));
diff --git a/packages/shared/src/server/repositories/clickhouse.ts b/packages/shared/src/server/repositories/clickhouse.ts
index b754dcf3b4..9d61981c95 100644
--- a/packages/shared/src/server/repositories/clickhouse.ts
+++ b/packages/shared/src/server/repositories/clickhouse.ts
@@ -1069,7 +1069,7 @@ function recordClickHouseProgressError(
context.normalizedTags,
);
const fallbackOutcome =
- error instanceof ClickHouseQueryAbortedError ? "cancelled" : "error";
+ error instanceof ClickHouseQueryAbortedError ? "client_closed" : "error";
recordClickHouseQueryOutcome(
wrapped instanceof ClickHouseResourceError
? CLICKHOUSE_RESOURCE_ERROR_OUTCOMES[wrapped.errorType]
diff --git a/web/src/pages/api/dashboard/execute-query-stream.ts b/web/src/pages/api/dashboard/execute-query-stream.ts
index 9bb1e98ba7..664b2160b0 100644
--- a/web/src/pages/api/dashboard/execute-query-stream.ts
+++ b/web/src/pages/api/dashboard/execute-query-stream.ts
@@ -157,6 +157,11 @@ export default async function handler(
Record<string, unknown>
>({
...chOpts,
+ tags: {
+ ...chOpts.tags,
+ surface: "internalapi",
+ route: "POST /api/dashboard/execute-query-stream",
+ },
clickhouseSettings: {
...chOpts.clickhouseSettings,
cancel_http_readonly_queries_on_client_close: 1,