feat: add a session recording metadata table

ee/clickhouse/migrations/0030_session_recording_metadata.py

@@ -0,0 +1,17 @@
+from infi.clickhouse_orm import migrations
+
+from posthog.models.session_recording_metadata.sql import (
+    DISTRIBUTED_SESSION_RECORDING_METADATA_TABLE_SQL,
+    KAFKA_SESSION_RECORDING_METADATA_TABLE_SQL,
+    SESSION_RECORDING_METADATA_TABLE_MV_SQL,
+    SESSION_RECORDING_METADATA_TABLE_SQL,
+    WRITABLE_SESSION_RECORDING_METADATA_TABLE_SQL,
+)
+
+operations = [
+    migrations.RunSQL(SESSION_RECORDING_METADATA_TABLE_SQL()),
+    migrations.RunSQL(KAFKA_SESSION_RECORDING_METADATA_TABLE_SQL()),
+    migrations.RunSQL(SESSION_RECORDING_METADATA_TABLE_MV_SQL()),
+    migrations.RunSQL(WRITABLE_SESSION_RECORDING_METADATA_TABLE_SQL()),
+    migrations.RunSQL(DISTRIBUTED_SESSION_RECORDING_METADATA_TABLE_SQL()),
+]

ee/kafka_client/topics.py

@@ -14,6 +14,7 @@
 KAFKA_PERSON_UNIQUE_ID = f"{KAFKA_PREFIX}clickhouse_person_unique_id{suffix}"
 KAFKA_PERSON_DISTINCT_ID = f"{KAFKA_PREFIX}clickhouse_person_distinct_id{suffix}"
 KAFKA_SESSION_RECORDING_EVENTS = f"{KAFKA_PREFIX}clickhouse_session_recording_events{suffix}"
+KAFKA_SESSION_RECORDING_METADATA = f"{KAFKA_PREFIX}clickhouse_session_recording_metadata{suffix}"
 KAFKA_PLUGIN_LOG_ENTRIES = f"{KAFKA_PREFIX}plugin_log_entries{suffix}"
 KAFKA_DEAD_LETTER_QUEUE = f"{KAFKA_PREFIX}events_dead_letter_queue{suffix}"
 KAFKA_GROUPS = f"{KAFKA_PREFIX}clickhouse_groups{suffix}"

plugin-server/src/config/kafka-topics.ts

@@ -11,6 +11,7 @@ export const KAFKA_PERSON = `${prefix}clickhouse_person${suffix}`
 export const KAFKA_PERSON_UNIQUE_ID = `${prefix}clickhouse_person_unique_id${suffix}`
 export const KAFKA_PERSON_DISTINCT_ID = `${prefix}clickhouse_person_distinct_id${suffix}`
 export const KAFKA_SESSION_RECORDING_EVENTS = `${prefix}clickhouse_session_recording_events${suffix}`
+export const KAFKA_SESSION_RECORDING_METADATA = `${prefix}clickhouse_session_recording_metadata${suffix}`
 export const KAFKA_EVENTS_PLUGIN_INGESTION = `${prefix}events_plugin_ingestion${suffix}`
 export const KAFKA_PLUGIN_LOG_ENTRIES = `${prefix}plugin_log_entries${suffix}`
 export const KAFKA_EVENTS_DEAD_LETTER_QUEUE = `${prefix}events_dead_letter_queue${suffix}`

posthog/models/session_recording_metadata/sql.py

@@ -0,0 +1,81 @@
+from django.conf import settings
+
+from ee.kafka_client.topics import KAFKA_SESSION_RECORDING_METADATA
+from posthog.clickhouse.kafka_engine import KAFKA_COLUMNS, kafka_engine
+from posthog.clickhouse.table_engines import Distributed, ReplacingMergeTree, ReplicationScheme
+
+SESSION_RECORDING_METADATA_DATA_TABLE = "sharded_session_recording_metadata"
+
+SESSION_RECORDING_METADATA_TABLE_BASE_SQL = """
+CREATE TABLE IF NOT EXISTS {table_name} ON CLUSTER '{cluster}'
+(
+    team_id Int64,
+    distinct_id VARCHAR,
+    session_id VARCHAR,
+    window_id VARCHAR,
+    session_start DateTime64(6, 'UTC'),
+    session_end DateTime64(6, 'UTC'),
+    duration Int64,
+    snapshot_data_location VARCHAR
+    {extra_fields}
+) ENGINE = {engine}
+"""
+
+SESSION_RECORDING_METADATA_DATA_TABLE_ENGINE = lambda: ReplacingMergeTree(
+    "session_recording_metadata", ver="_timestamp", replication_scheme=ReplicationScheme.SHARDED
+)
+SESSION_RECORDING_METADATA_TABLE_SQL = lambda: (
+    SESSION_RECORDING_METADATA_TABLE_BASE_SQL
+    + """PARTITION BY toYYYYMMDD(session_start)
+ORDER BY (team_id, toStartOfHour(session_start), session_id)
+"""
+).format(
+    table_name=SESSION_RECORDING_METADATA_DATA_TABLE,
+    cluster=settings.CLICKHOUSE_CLUSTER,
+    extra_fields=KAFKA_COLUMNS,
+    engine=SESSION_RECORDING_METADATA_DATA_TABLE_ENGINE(),
+)
+
+KAFKA_SESSION_RECORDING_METADATA_TABLE_SQL = lambda: SESSION_RECORDING_METADATA_TABLE_BASE_SQL.format(
+    table_name="kafka_session_recording_metadata",
+    cluster=settings.CLICKHOUSE_CLUSTER,
+    engine=kafka_engine(topic=KAFKA_SESSION_RECORDING_METADATA),
+    extra_fields="",
+)
+
+SESSION_RECORDING_METADATA_TABLE_MV_SQL = lambda: """
+CREATE MATERIALIZED VIEW session_recording_metadata_mv ON CLUSTER '{cluster}'
+TO {database}.{target_table}
+AS SELECT
+team_id,
+distinct_id,
+session_id,
+window_id,
+session_start,
+session_end,
+duration,
+snapshot_data_location,
+_timestamp,
+_offset
+FROM {database}.kafka_session_recording_metadata
+""".format(
+    target_table=("writable_session_recording_metadata"),
+    cluster=settings.CLICKHOUSE_CLUSTER,
+    database=settings.CLICKHOUSE_DATABASE,
+)
+
+# This table is responsible for writing to sharded_session_recording_metadata based on a sharding key.
+WRITABLE_SESSION_RECORDING_METADATA_TABLE_SQL = lambda: SESSION_RECORDING_METADATA_TABLE_BASE_SQL.format(
+    table_name="writable_session_recording_metadata",
+    cluster=settings.CLICKHOUSE_CLUSTER,
+    engine=Distributed(data_table=SESSION_RECORDING_METADATA_DATA_TABLE, sharding_key="sipHash64(session_id)"),
+    extra_fields=KAFKA_COLUMNS,
+)
+
+# This table is responsible for reading from session_recording_events on a cluster setting
+DISTRIBUTED_SESSION_RECORDING_METADATA_TABLE_SQL = lambda: SESSION_RECORDING_METADATA_TABLE_BASE_SQL.format(
+    table_name="session_recording_metadata",
+    cluster=settings.CLICKHOUSE_CLUSTER,
+    engine=Distributed(data_table=SESSION_RECORDING_METADATA_DATA_TABLE, sharding_key="sipHash64(session_id)"),
+    extra_fields=KAFKA_COLUMNS,
+)