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(clickhouse): make the default query workload configurable (#119916)

Bryan Ciaraldiad782f4d0ecb
diff --git a/posthog/clickhouse/client/connection.py b/posthog/clickhouse/client/connection.py
index 3b430731f72e..3ba257a2ec5b 100644
--- a/posthog/clickhouse/client/connection.py
+++ b/posthog/clickhouse/client/connection.py
@@ -77,7 +77,14 @@ SINGLE_SHARD_DATA_NODE_ROLES: frozenset[NodeRole] = frozenset(
)
-_default_workload = Workload.ONLINE
+def default_workload_from_settings() -> Workload:
+ workload = Workload(settings.CLICKHOUSE_DEFAULT_WORKLOAD)
+ if workload not in (Workload.ONLINE, Workload.OFFLINE):
+ raise ValueError(f"CLICKHOUSE_DEFAULT_WORKLOAD must be ONLINE or OFFLINE, got {workload}")
+ return workload
+
+
+_default_workload = default_workload_from_settings()
class ClickHouseUser(StrEnum):
diff --git a/posthog/clickhouse/client/test/test_connection.py b/posthog/clickhouse/client/test/test_connection.py
index 8d7f086986bc..694766597d73 100644
--- a/posthog/clickhouse/client/test/test_connection.py
+++ b/posthog/clickhouse/client/test/test_connection.py
@@ -16,6 +16,7 @@ from posthog.clickhouse.client.connection import (
RefreshingChPool,
Workload,
default_client,
+ default_workload_from_settings,
get_clickhouse_creds,
get_http_client,
get_http_kwargs,
@@ -76,6 +77,21 @@ def test_connection_pool_creation_with_offline_cluster(settings):
assert get_pool(Workload.DEFAULT) is offline_pool
[email protected]("value,expected", [("ONLINE", Workload.ONLINE), ("OFFLINE", Workload.OFFLINE)])
+def test_default_workload_from_settings(settings, value, expected):
+ settings.CLICKHOUSE_DEFAULT_WORKLOAD = value
+
+ assert default_workload_from_settings() == expected
+
+
[email protected]("value", ["LOGS", "ENDPOINTS", "DEFAULT", "offline-ish"])
+def test_default_workload_from_settings_rejects_other_workloads(settings, value):
+ settings.CLICKHOUSE_DEFAULT_WORKLOAD = value
+
+ with pytest.raises(ValueError):
+ default_workload_from_settings()
+
+
def test_connection_pool_creation_with_team_id(settings):
settings.CLICKHOUSE_PER_TEAM_SETTINGS = {}
diff --git a/posthog/settings/data_stores.py b/posthog/settings/data_stores.py
index 71017c9e99e5..a4a4f0659c68 100644
--- a/posthog/settings/data_stores.py
+++ b/posthog/settings/data_stores.py
@@ -303,6 +303,9 @@ CLICKHOUSE_TEST_DB: str = "posthog" + SUFFIX
CLICKHOUSE_HOST: str = os.getenv("CLICKHOUSE_HOST", "clickhouse")
CLICKHOUSE_LOGS_HOST: str = os.getenv("CLICKHOUSE_LOGS_HOST", "clickhouse")
CLICKHOUSE_OFFLINE_CLUSTER_HOST: str | None = os.getenv("CLICKHOUSE_OFFLINE_CLUSTER_HOST", None)
+# Workload that Workload.DEFAULT resolves to in this process. Celery tasks switch to OFFLINE per task.
+# Temporal workers and Dagster set OFFLINE so background queries are tagged with where they run.
+CLICKHOUSE_DEFAULT_WORKLOAD: str = os.getenv("CLICKHOUSE_DEFAULT_WORKLOAD", "ONLINE")
CLICKHOUSE_MIGRATIONS_HOST: str = os.getenv("CLICKHOUSE_MIGRATIONS_HOST", CLICKHOUSE_HOST)
CLICKHOUSE_ENDPOINTS_HOST: str = os.getenv("CLICKHOUSE_ENDPOINTS_HOST", CLICKHOUSE_HOST)
CLICKHOUSE_USER: str = os.getenv("CLICKHOUSE_USER", "default")