Files
clickstream-data-platform/generator/README.md
T
ddadmin 7c9eeedc40 feat(stand): make up наполняет стенд стартовым миром, опись сторожит его
Зачем
Стенд поднимался пустым, и всякая приёмка следующих этапов начиналась с
ручной заливки данных. Теперь `make up` сам приводит стенд к одному и тому
же состоянию, а в git лежит то, чем это состояние проверяется.

Что
- Опись мира `data/world-inventory.json`: паспорт (зерно, версия
  генератора, хеш каталога) и по строке на каждый из восьми дней — дата,
  число событий, хеш байтов. Собирается `make inventory`, свежесть сторожит
  `test_inventory.py` — тем же способом, что свежесть описания выгрузки.
- Разовая служба `world-init` вышла из-под профиля и играет в топик восемь
  дней при каждом подъёме; зависимый у неё — `airflow-init`, иначе `--wait`
  считает успешно отработавшую службу упавшей.
- `scripts/wait-for-world.sh` — вторая половина `make up`: приём
  асинхронный, поэтому ждать надо доезда до `ods.event`, а не завершения
  заливки. Ограниченный цикл опроса, не пауза наугад.
- Девятая проверка `make check-clickhouse`: подневный счёт событий против
  описи, рамка по датам стартового мира, счёт через `FINAL`. При
  расхождении называет, где искать, — в событиях или в браке.
- Порог «день ≤ 30 с» снят из спеки генератора в обоих местах: замер дал
  1,7 с, порог был выше факта в восемнадцать раз. На его месте — замеры с
  датой. Раздел 9 спеки закрыт: открытых вопросов не осталось.
- Слова: «манифест» стал описью мира, «зерновой мир» — стартовым миром
  (решение владельца). Оба заведены в словарь CONTEXT.md.

Проверка
`make clean && make up` с нуля — 2 м 50 с, доехало ровно 401 185 событий.
`make check-clickhouse` зелёный (8 с), `make smoke` зелёный (9 с),
`make test` — 407 тестов за 71 с, `make lint`, `make typecheck`,
`make config-test` зелёные.

Что проверка умеет краснеть, снято двумя поломками: снос партиции
2026-06-03 дал диагноз «не доехали до ODS», негодная строка в сырье —
«сломан разбор». Строки опыта убраны, день переигран, счёт вернулся.
Тест свежести проверен молчаливой правкой цены в каталоге: покраснел.

Ссылка: #42
2026-08-07 18:37:01 +03:00

9.0 KiB
Raw Blame History

Генератор кликстрима

Клиентская сторона стенда: отсюда берётся поток событий — широкое событие по образцу облачной выгрузки Яндекс Метрики. Устройство и принятые решения — спека «Генератор (этап 2)».

События уже есть и уже уезжают: день-функция отдаёт по паре (зерно, D) упорядоченный поток трёх видов — просмотр страницы, корзина, покупка, — канонический сериализатор превращает его в JSON, а проигрыватель гонит в файл или в Kafka. Клиентская сторона на этом целая; заказы бэкенда — за следующими этапами.

Как это работает

Раздел черновой. По сути он верен, но на понятность читателем со стороны не выверен: пишет его тот, кто держит устройство генератора в голове, а это худший судья понятности. Выверка — вместе с путеводителем, тикет #48.

Цепочка одна и всегда та же: корневое зерно → подпотоки по позиции в дереве → когорта дня (кто впервые пришёл, сколько раз вернётся, чей паспорт какой) → аудитория дня, то есть когорта плюс возвраты когорт окна → визиты этих кук → строки событий. Мир при этом ленив: когорта считается по требованию, а до D0 живёт предыстория, поэтому любой день собирается сам по себе — прожитая история для него не нужна и на него не влияет.

Главное правило для того, кто придёт следующим: внутри подпотока порядок бросков — часть контракта. Броски раздаёт один генератор подряд, и k-й бросок достаётся тому, кто спросил k-м. Приписать новый бросок в конец функции безопасно: у прежних он ничего не отнимает. Вставить в середину — значит сдвинуть все броски после него, а с ними и весь мир: события того же дня станут другими, счётчики канонического мира разойдутся с описью, и поймается это не ошибкой, а красным чеком. Ровно поэтому паспорта кук в plan.cohort бросаются последними.

Случайность целочисленная — только диапазоны и выбор по целым весам: готовые распределения numpy расходятся между версиями и архитектурами, а обещано побайтовое совпадение (спека, раздел 2). Отсюда weights.py вместо rng.choice с вероятностями.

Что где лежит

  • src/clickstream_generator/world.py — конфигурация мира: все его числа одним местом. Правка любого — смена мира; крутить их и предлагается.
  • src/clickstream_generator/seeds.py — иерархия зёрен: кто из какого подпотока берёт случайность. На ней держится весь детерминизм.
  • src/clickstream_generator/plan.py — план состава: кто есть в мире в день D. Когорты, приток, двухкуковые пары, паспорта кук и счётчики — до генерации событий.
  • src/clickstream_generator/weights.py — выбор по целым весам: один приём на весь генератор, чтобы дисциплина целочисленной случайности не жила копиями.
  • src/clickstream_generator/reference.py — справочники: устройства, города, источники трафика, карта сайта. Таблицы-литералы: доля живёт в строке, которой принадлежит.
  • src/clickstream_generator/catalog.py — каталог товаров из data/catalog/products.csv, общего у генератора и словаря ClickHouse.
  • src/clickstream_generator/day.py — день-функция: визиты, страницы, атрибуция, устройство и гео. Там же правила резки визитов и шов, на который садятся торговые события.
  • src/clickstream_generator/commerce.py — торговые события: что легло в корзину, что из этого куплено, деньги, номера заказов и сырой ecommerce. Своя случайность, поэтому правка торговли трафик не двигает.
  • src/clickstream_generator/ids.py — номера событий: неповторяющиеся и ниже 2^53. Обещание одно на обе половины дня, поэтому и живёт отдельно.
  • src/clickstream_generator/serialize.py — канонический сериализатор: единственное место, где событие целиком превращается в JSON. Порядок ключей, все 47 колонок всегда и форма на проводе — ISO-8601.
  • src/clickstream_generator/sinks.py — приёмники: файл (одно событие — одна строка) и Kafka (одно событие — одно сообщение). Про содержимое они не знают; там же довод, почему у сообщения нет ключа.
  • src/clickstream_generator/player.py — проигрыватель: гонит дни в приёмник пачкой или с темпом живого дня. Состояния не хранит.
  • src/clickstream_generator/cli.py — интерфейс запуска: параметры аргументами или окружением, логи в стандартный вывод, итог кодом возврата.
  • src/clickstream_generator/schema.py — контракт схемы: чистые данные о колонках выгрузки. Собственность генератора; из него выводятся сам генератор, его валидация и описание выгрузки в доках.
  • src/clickstream_generator/schema_doc.py — сборка «описания выгрузки» (docs/formats/clickstream-event.md) из контракта. Документ руками не правят — пересобирают.
  • src/clickstream_generator/inventory.py — сборка описи мира (data/world-inventory.json): паспорт мира и хеши восьми дней, которыми наполняется стенд. Руками не правят — пересобирают целью make inventory.
  • tests/ — инварианты контракта, свежесть описания и обещания мира: чистота от зерна, приток, гарантия двухкуковых пар, форма суточной волны и сборка визитов по задокументированным правилам. Там же побайтовое обещание, доведённое до диска: два прогона дня в файл дают тот же файл, а строк в нём ровно столько, сколько событий.

Команды

Проиграть день — быстрый старт и --help.

Из корня репозитория:

  • make test — тесты генератора;
  • make lint — ruff: проверка и формат;
  • make typecheck — ty: проверка типов;
  • make docs — пересобрать описание выгрузки.

Python и зависимости — через uv, версии закреплены в uv.lock: на этом держится обещание побайтовой воспроизводимости (спека, раздел 2).