ddadminandClaude Fable 5
10ee1a1cb6
- Зачем:
- менти собирал мир генерацией (минуты и десятки минут CPU); теперь
готовый трёхдневный мир загружается импортом за ~2 минуты, и числа
у всех менти совпадают число-в-число (issue #3).
- Что:
- артефакт data/startup_history/reference-world.json.xz в git:
3 модельных дня daily-wave, ~850 МБ JSON → 32 МБ xz;
- чтение и запись артефакта понимают .xz потоково (lzma); пустое поле
artifact_path в пульте и make startup-history-import читают эталон;
- длительность профиля daily-wave стала 3d — в тон эталонному миру;
- предпроверка чистого стенда ставит зависимости генератора через uv;
экспорт и импорт разведены отдельными переменными Makefile;
- доки и runbook обновлены; новые контрактные тесты: xz round-trip
и дефолтные пути артефакта.
- Проверка:
- make test (210 + 31) и make lint зелёные; импорт на чистом стенде
за 2м03с, manifest совпал (280437 событий), Superset-проверка
зелёная; независимое ревью — APPROVED.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
170 lines
8.7 KiB
Markdown
170 lines
8.7 KiB
Markdown
# Учебный стенд DWH кликстрима
|
||
|
||
[](./docker-compose.yml)
|
||
[](./docs/ARCHITECTURE.md)
|
||
|
||
Живой стек для работы с кликстримом: Kafka, ClickHouse, Airflow, Superset и мониторинг
|
||
(Prometheus с Grafana) поднимаются в Docker одной командой. На этом стенде можно учиться
|
||
по курсу или просто поднять его у себя и поэкспериментировать с потоковой загрузкой и
|
||
витринами.
|
||
|
||
Поток данных коротко:
|
||
- **стартовая история**: `generator backfill → Kafka → ClickHouse (STG) →
|
||
batch STG → ODS → DDS → DM → Superset`.
|
||
- **живое продолжение**: `generator live → Kafka → ClickHouse (STG) → batch ETL
|
||
→ Superset`.
|
||
|
||
Файлы `data/*.jsonl` больше не основной источник аналитики. Пока они остаются
|
||
архивной кладовкой значений для генератора: браузеры, страны, устройства и UTM.
|
||
|
||
## Куда дальше
|
||
|
||
- **Хочешь учиться** — открой [курс «Кликстрим на ClickHouse»](./docs/course/README.md).
|
||
Это продвинутый курс «со звёздочкой»: основные приёмы инженерии данных проходишь прямо
|
||
на этом стенде.
|
||
- **Хочешь поднять и попробовать** — следуй быстрому старту ниже.
|
||
- **Хочешь разобраться в устройстве** — смотри [архитектуру слоёв](./docs/ARCHITECTURE.md),
|
||
[запуск и эксплуатацию](./docs/OPERATIONS.md) и [карту репозитория](./docs/REPO_MAP.md).
|
||
|
||
## Быстрый старт
|
||
|
||
Перед первой командой нужны `Docker` с `docker compose`, `make`, `bash`, `curl`,
|
||
`git` и `uv`. `uv` нужен для локальных Python-проверок и команд разработки.
|
||
|
||
Для ручной работы поднимите стенд и создайте стартовую историю через Airflow:
|
||
|
||
```bash
|
||
make up
|
||
make ddl
|
||
docker compose ps
|
||
```
|
||
|
||
Откройте Airflow: `http://localhost:8080` (`admin/admin`). Сначала снимите
|
||
паузу с DAG `etl_pipeline` (переключатель слева от имени): на свежем стенде он
|
||
создаётся на паузе, и `backfill` откажется стартовать. Затем запустите
|
||
`generator_control` с операцией `backfill`: DAG создаст стартовую историю,
|
||
запустит ETL и выполнит `check`. `make up` не запускает live-генератор; live
|
||
включается отдельно командой `make generator-continue`.
|
||
|
||
После обновления репозитория снова выполните `make up`: команда пересобирает
|
||
Airflow-образ и подтягивает новые зависимости и DAG-и. Superset-дэшборд
|
||
собирается позже, когда DM уже готов: через `make generated-history-analytics`
|
||
или `make superset-init`.
|
||
|
||
Для полностью автоматического чистого прогона из консоли есть команда — это
|
||
тот же путь, что выше через Airflow UI, но одной командой и без ручных шагов
|
||
(DDL она применяет сама, отдельный `make ddl` не нужен):
|
||
|
||
```bash
|
||
make generated-history-analytics
|
||
```
|
||
|
||
По умолчанию используется учебный профиль `daily-wave`: 3 суток с суточной
|
||
волной. В live-продолжении он идёт с ×60: модельные сутки проходят примерно
|
||
за 24 настенные минуты. Плоский профиль `ci` на 6 часов остаётся служебным
|
||
для автоматических тестов.
|
||
|
||
Разовую длительность можно задать без ручного расчёта правой границы:
|
||
|
||
```bash
|
||
GEN_HISTORY_DURATION=2d make generated-history-analytics
|
||
```
|
||
|
||
Повторить техническую проверку после такого прогона только стартовой истории:
|
||
|
||
```bash
|
||
CHECK_LIVE_SEAM=0 make generated-history-check
|
||
```
|
||
|
||
Стык backfill/live проверяйте отдельным коротким сценарием:
|
||
|
||
```bash
|
||
make generated-history-runtime-check
|
||
```
|
||
|
||
Перед коммитом используйте быстрые проверки:
|
||
|
||
```bash
|
||
make test
|
||
make lint
|
||
```
|
||
|
||
Они не чистят volumes и не запускают долгие стендовые сценарии. Полная проверка
|
||
стыка backfill/live остаётся отдельной командой `make generated-history-runtime-check`.
|
||
|
||
Сохранить стартовую историю в файл и восстановить её без новой генерации можно
|
||
по [runbook стартовой истории](./docs/runbooks/startup-history.md).
|
||
|
||
Проверить, что данные дошли до витрин:
|
||
|
||
```bash
|
||
docker compose exec -T clickhouse clickhouse-client --user=default --password=123456 \
|
||
--query "SELECT count() FROM dm.v_events_enriched"
|
||
```
|
||
|
||
Подробный сценарий запуска, параметры DAG-ов и разбор частых проблем — в
|
||
[OPERATIONS](./docs/OPERATIONS.md).
|
||
|
||
## Сервисы и доступы
|
||
|
||
| Сервис | Адрес | Назначение | Логин/пароль |
|
||
|--------|-------|------------|--------------|
|
||
| Airflow | `http://localhost:8080` | оркестрация ETL | admin/admin |
|
||
| ClickHouse | `http://localhost:9123/play` | SQL-запросы | default/123456 |
|
||
| Kafka UI | `http://localhost:8082` | просмотр топиков | — |
|
||
| Superset | `http://localhost:8088` | дашборды | admin/admin |
|
||
| Prometheus | `http://localhost:9090` | метрики | — |
|
||
| Grafana | `http://localhost:3000` | графики метрик | admin/admin |
|
||
|
||
Готовый дашборд в Superset:
|
||
`http://localhost:8088/superset/dashboard/ecommerce-analytics/` — он создаётся
|
||
во время `make generated-history-analytics`. Состав и настройка дашборда описаны в
|
||
[SUPERSET_DASHBOARD](./docs/SUPERSET_DASHBOARD.md).
|
||
|
||
## Как устроен поток данных
|
||
|
||
```mermaid
|
||
flowchart LR
|
||
subgraph GEN["Generator"]
|
||
BF["backfill"]
|
||
LIVE["live"]
|
||
end
|
||
|
||
subgraph Kafka["Kafka"]
|
||
Topics[4 топика]
|
||
end
|
||
|
||
subgraph CH["ClickHouse"]
|
||
STG["STG: сырые данные"]
|
||
ODS["ODS: типизация + DQ"]
|
||
DDS["DDS: сущности"]
|
||
DM["DM: витрины VIEW"]
|
||
end
|
||
|
||
BF -->|стартовая история| Kafka
|
||
LIVE -->|продолжение| Kafka
|
||
Kafka -->|Kafka MV| STG
|
||
STG -->|batch| ODS -->|batch| DDS -->|VIEW| DM
|
||
|
||
DDL["DDL"] -.-> CH
|
||
```
|
||
|
||
«Грязные» записи не роняют пайплайн: ошибки разбора складываются в `ods.*_errors` и в
|
||
поле `parse_errors`, а обработка продолжается.
|
||
|
||
Подробное описание слоёв STG/ODS/DDS/DM, диаграммы и обоснование решений —
|
||
в [ARCHITECTURE](./docs/ARCHITECTURE.md).
|
||
|
||
## Документация
|
||
|
||
- [Архитектура и слои](./docs/ARCHITECTURE.md) — устройство STG/ODS/DDS/DM, диаграммы,
|
||
обоснование решений.
|
||
- [Запуск и эксплуатация](./docs/OPERATIONS.md) — сценарий запуска, параметры DAG-ов,
|
||
мониторинг, частые проблемы.
|
||
- [Runbook стартовой истории](./docs/runbooks/startup-history.md) — экспорт,
|
||
импорт эталонного мира из Git по умолчанию и live-продолжение.
|
||
- [Карта репозитория](./docs/REPO_MAP.md) — где какие файлы и что менять.
|
||
- [Курс «Кликстрим на ClickHouse»](./docs/course/README.md) — учебная программа на этом
|
||
стенде.
|
||
- [DE-task.md](./docs/DE-task.md) — задание, из которого вырос стенд.
|