aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgvit <gvit@ydb.tech>2022-11-02 21:42:00 +0300
committergvit <gvit@ydb.tech>2022-11-02 21:42:00 +0300
commit0ca12a0548e3af769774fd7fca945e36bde401e9 (patch)
tree72a0379cd5374a9dad38afaa358b750a81db6a21
parent2bdc13c7a8dc2203aa7d5f8db4328307cb295049 (diff)
downloadydb-0ca12a0548e3af769774fd7fca945e36bde401e9.tar.gz
add simple document to clickhouse benchmark
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/click-bench.md70
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/index.md1
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/commands/workload/click-bench.md1
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml2
4 files changed, 74 insertions, 0 deletions
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/click-bench.md b/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/click-bench.md
new file mode 100644
index 0000000000..781787b14f
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/click-bench.md
@@ -0,0 +1,70 @@
+# ClickBench нагрузка
+
+Этот тест представляет типичную рабочую нагрузку в следующих областях: анализ потока кликов и трафика, веб-аналитика, машинно-генерируемые данные, структурированные журналы и данные о событиях. Он охватывает типичные запросы в аналитике и информационных панелях реального времени.
+
+Набор данных из этого бенчмарка был получен на основе фактической записи трафика одной из крупнейших в мире платформ веб-аналитики. Он анонимизирован, сохраняя при этом все основные распределения данных. Набор запросов был импровизирован, чтобы отразить реалистичные рабочие нагрузки, в то время как запросы не исходят непосредственно из производства.
+
+Нагрузка базируется на данных и запросах из репозитория [https://github.com/ClickHouse/ClickBench](https://github.com/ClickHouse/ClickBench)`, а запросы и схема таблица адаптированы под {{ ydb-short-name }}.
+
+## Инициализация нагрузочного теста {#init}
+
+Для начала работы необходимо создать таблицу
+```bash
+{{ ydb-cli }} workload click_bench init --path clickhouse
+```
+
+Посмотрите описание команды для запуска нагрузки:
+
+```bash
+{{ ydb-cli }} workload click_bench init --help
+```
+
+### Доступные параметры {#init_options}
+
+Имя параметра | Описание параметра
+---|---
+`--path <значение>` | Директория, в которой будует создана таблица `hits`.
+
+## Загрузка данных в таблицу {#load}
+
+Для начала работы необходимо загрузить данные в таблицу. Для этого сначала необходимо скачать и распаковать архив с данными,
+[https://datasets.clickhouse.com/hits_compatible/hits.csv.gz](https://datasets.clickhouse.com/hits_compatible/hits.csv.gz), после чего используя команду
+`import file csv` необходимо загрузить данные в таблицу.
+
+```bash
+wget https://datasets.clickhouse.com/hits_compatible/hits.csv.gz
+unzip hits.csv.gz
+{{ ydb-cli }} import file csv --path clickhouse/hits --input-file hits.csv
+```
+
+## Запуск нагрузочного теста {#run}
+
+Для запуска нагрузки необходимо выполнить команду:
+```bash
+{{ ydb-cli }} workload click_bench run --path clickhouse
+```
+В течение теста на экран выводится статистика по нагрузке для каждого временного окна.
+
+Посмотрите описание команды для запуска нагрузки:
+
+```bash
+{{ ydb-cli }} workload click_bench run --help
+```
+
+### Общие параметры для всех видов нагрузки {#run_options}
+
+Имя параметра | Описание параметра
+---|---
+`--output <значение>` | Имя файла, в котором будут сохранены результаты выполния запросов. Значение по умолчанию 10.
+`--iterations <значение>` | Количество выполнений каждого из запросов нагрузки, создающих нагрузку. Значение по умолчанию: 1.
+`--json` | Имя файла, в котором будет сохранена статиска выполнения запросов в формате `json`. По умолчанию файл не сохраняется.
+`--ministat` | Имя файла, в котором будет сохранена статиска выполнения запросов в формате `ministat`. По умолчанию файл не сохраняется.
+`--window` | Длительность окна сбора статистики в секундах. Значение по умолчанию: 1.
+`--disable-llvm` | Опция для отключения `llvm` компиляции запроса.
+`--enable-pushdown` | Опция для включения возможности опускания агрегатов
+`--ext-queries-file` | Имя файла, в котором можно указать внешние запросы для выполнения нагрузки. По умолчанию файл не требуется.
+`--ext-query` | Строка с внешними запросами для выполнения нагрузки. Значение по умолчанию отсутствует.
+`--table` | Имя таблицы. Значение по умолчанию: `hits`
+`--path` | Путь до директории, в котором находится таблица. Значение по умолчанию отсутствует.
+`--include` | Номера или отрезки номеров запросов, которые нужно выполнить в рамках нагрузки. По умолчанию выполняются все запросы.
+`--exclude` | Номера или отрезки номеров запросов, которые нужно исключить в рамках нагрузки. По умолчанию выполняются все запросы.
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/index.md b/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/index.md
index fe1b6dd772..f1c4e28196 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/index.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/index.md
@@ -22,3 +22,4 @@
В данный момент поддерживаются следующие виды нагрузочных тестов:
* [Stock](../stock.md) - симулятор склада интернет-магазина.
* [Key-value](../../../workload-kv.md) - Key-Value нагрузка
+* [ClickBench](../click-bench.md) - нагрузка аналитическими запросами
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/click-bench.md b/ydb/docs/ru/core/reference/ydb-cli/commands/workload/click-bench.md
new file mode 100644
index 0000000000..ff7a2e722e
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/workload/click-bench.md
@@ -0,0 +1 @@
+{% include [click-bench.md](_includes/click-bench.md) %}
diff --git a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
index e6b4c0319a..a85b636227 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
+++ b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
@@ -99,6 +99,8 @@ items:
href: commands/workload/index.md
- name: Stock нагрузка
href: commands/workload/stock.md
+ - name: ClickBench нагрузка
+ href: commands/workload/click-bench.md
- name: Key-Value нагрузка
href: workload-kv.md