Skip to content

Commit 7a37614

Browse files
AvtandilkoNikita Velgin
Avtandilko
and
Nikita Velgin
authored
add clickhouse widgets description (#225)
Co-authored-by: Nikita Velgin <nikita.velgin@flant.com>
1 parent 36c1afd commit 7a37614

3 files changed

Lines changed: 142 additions & 0 deletions

File tree

‎content/documentation/admin/external-services.ru.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,35 @@ menuTitle: Внешние сервисы
8787
Authorization: <ваш-api-token>
8888
```
8989

90+
### ClickHouse
91+
92+
Тип авторизации: Basic Authentication или заголовки `X-ClickHouse-User` / `X-ClickHouse-Key`.
93+
94+
Заголовки:
95+
96+
| Заголовок | Формат значения |
97+
|-----------|-----------------|
98+
| `Authorization` | `Basic <base64-encoded-credentials>` |
99+
| `X-ClickHouse-User` | `<имя-пользователя>` |
100+
| `X-ClickHouse-Key` | `<пароль>` |
101+
102+
Пример Basic Authentication:
103+
104+
1. Сформируйте строку `username:password`.
105+
1. Закодируйте её в Base64: `echo -n "username:password" | base64`.
106+
1. Добавьте заголовок:
107+
108+
```sh
109+
Authorization: Basic <base64-encoded-credentials>
110+
```
111+
112+
Пример с заголовками ClickHouse:
113+
114+
```sh
115+
X-ClickHouse-User: <имя-пользователя>
116+
X-ClickHouse-Key: <пароль>
117+
```
118+
90119
### DefectDojo
91120

92121
Тип авторизации: API v2 Key Token.

‎content/documentation/admin/widgets/types.ru.md‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,118 @@ title: Типы виджетов
246246
| URL | Да | URL CodeScoring | - |
247247
| ID проекта | Да | Идентификатор проекта в CodeScoring | - |
248248

249+
### ClickHouse. Метрики (диапазон)
250+
251+
Виджет позволяет построить линейный график на основе read-only SQL-запроса к ClickHouse. В запросе можно использовать плейсхолдеры `{{from}}` и `{{to}}` для подстановки границ временного интервала.
252+
253+
Пример корректного запроса для виджета:
254+
255+
```sql
256+
SELECT
257+
toStartOfMinute(timestamp) AS time,
258+
avg(value) AS value,
259+
service AS series
260+
FROM metrics
261+
WHERE timestamp >= {{from}} AND timestamp < {{to}}
262+
GROUP BY time, series
263+
ORDER BY time
264+
```
265+
266+
#### Конфигурация
267+
268+
| Название | Обязательность | Описание | Значение по умолчанию |
269+
|-----------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
270+
| Запрос | Да | Read-only SQL-запрос. Используйте `{{from}}` и `{{to}}` для подстановки интервала | - |
271+
| База данных | Нет | Название базы ClickHouse, передаётся в заголовке `X-ClickHouse-Database` | - |
272+
| Интервал по умолчанию | Нет | Интервал, используемый при открытии виджета и при обновлении, если в параметрах запроса интервал не задан | Последний час |
273+
| Колонка времени | Да | Колонка с меткой времени для оси X графика | - |
274+
| Колонка значения | Да | Колонка с числовыми значениями для оси Y графика | - |
275+
| Колонка серии | Нет | Колонка, используемая как название серии в легенде графика | - |
276+
| Пороговое значение | Нет | Порог, отображаемый в виде горизонтальной линии на графике | - |
277+
| Минимальное значение | Нет | Начальная точка отсчёта для вертикальной оси графика | - |
278+
| Максимальное значение | Нет | Предельная точка отсчёта для вертикальной оси графика | - |
279+
280+
#### Авторизация
281+
282+
Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#clickhouse).
283+
284+
### ClickHouse. Метрики (значение)
285+
286+
Виджет позволяет вывести одно число на основе read-only SQL-запроса к ClickHouse, задать для него единицу измерения и настроить пороговое значение. Запрос должен возвращать одну строку; отображается значение первой колонки.
287+
288+
Пример корректного запроса для виджета:
289+
290+
```sql
291+
SELECT count() AS value
292+
FROM events
293+
WHERE timestamp >= {{from}} AND timestamp < {{to}}
294+
```
295+
296+
#### Конфигурация
297+
298+
| Название | Обязательность | Описание | Значение по умолчанию |
299+
|----------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------------|
300+
| Запрос | Да | Read-only SQL-запрос. Используйте `{{from}}` и `{{to}}` для подстановки интервала | - |
301+
| База данных | Нет | Название базы ClickHouse, передаётся в заголовке `X-ClickHouse-Database` | - |
302+
| Интервал по умолчанию | Нет | Интервал, используемый при открытии виджета и при обновлении, если в параметрах запроса интервал не задан | Последний час |
303+
| Количество цифр после запятой | Нет | Точность, с которой будет выводиться полученное значение | - |
304+
| Единица измерения | Нет | Постфикс, с которым будет выводиться полученное значение | - |
305+
| Отображать пороговое значение | Нет | Отображать пороговое значение в формате <значение метрики> / <пороговое значение> | false |
306+
| Пороговое значение | Нет | Пороговое значение | - |
307+
| Меньшее значение считается лучше | Нет | Метрика считается «хорошей», когда её значение ниже заданного порогового значения | false |
308+
| Порог предупреждения (%) | Нет | Граница между красным и оранжевым цветами. Если значение метрики превышает этот процент от порога, оно получит оранжевый цвет | 60 |
309+
| Порог успеха (%) | Нет | Граница между оранжевым и зелёным цветами. Если значение метрики превышает этот процент от порога, оно получит зелёный цвет | 90 |
310+
311+
#### Авторизация
312+
313+
Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#clickhouse).
314+
315+
### ClickHouse. Таблица
316+
317+
Виджет позволяет вывести результат read-only SQL-запроса к ClickHouse в виде таблицы с сортировкой и постраничной навигацией. В запросе можно использовать плейсхолдеры `{{from}}` и `{{to}}`.
318+
319+
#### Конфигурация
320+
321+
| Название | Обязательность | Описание | Значение по умолчанию |
322+
|-----------------------|----------------|------------------------------------------------------------------------------------------------------------|-----------------------|
323+
| Запрос | Да | Read-only SQL-запрос. Используйте `{{from}}` и `{{to}}` для подстановки интервала | - |
324+
| База данных | Нет | Название базы ClickHouse, передаётся в заголовке `X-ClickHouse-Database` | - |
325+
| Интервал по умолчанию | Нет | Интервал, используемый при открытии виджета и при обновлении, если в параметрах запроса интервал не задан | Последний час |
326+
| Размер страницы | Да | Количество строк, загружаемых за один запрос | 50 |
327+
328+
#### Авторизация
329+
330+
Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#clickhouse).
331+
332+
### ClickHouse. Топ N
333+
334+
Виджет позволяет построить горизонтальную столбчатую диаграмму на основе read-only SQL-запроса к ClickHouse. Запрос должен возвращать колонки с метками и числовыми значениями; количество отображаемых строк ограничивается параметром «Лимит».
335+
336+
Пример корректного запроса для виджета:
337+
338+
```sql
339+
SELECT service AS label, count() AS value
340+
FROM events
341+
WHERE timestamp >= {{from}} AND timestamp < {{to}}
342+
GROUP BY label
343+
ORDER BY value DESC
344+
```
345+
346+
#### Конфигурация
347+
348+
| Название | Обязательность | Описание | Значение по умолчанию |
349+
|-----------------------|----------------|------------------------------------------------------------------------------------------------------------|-----------------------|
350+
| Запрос | Да | Read-only SQL-запрос. Используйте `{{from}}` и `{{to}}` для подстановки интервала | - |
351+
| База данных | Нет | Название базы ClickHouse, передаётся в заголовке `X-ClickHouse-Database` | - |
352+
| Интервал по умолчанию | Нет | Интервал, используемый при открытии виджета и при обновлении, если в параметрах запроса интервал не задан | Последний час |
353+
| Колонка метки | Да | Колонка для подписей столбцов диаграммы | - |
354+
| Колонка значения | Да | Колонка с числовыми значениями для длины столбцов | - |
355+
| Лимит | Да | Максимальное количество строк для диаграммы | 10 |
356+
357+
#### Авторизация
358+
359+
Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#clickhouse).
360+
249361
### DefectDojo. Продукт
250362

251363
Виджет позволяет просматривать уязвимости продукта в DefectDojo с разбивкой по engagements и уровням критичности.

‎content/documentation/release-notes/v1.6.0.ru.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ description: Заметки о выпуске v1.6.0 — выгрузка ауд
4646

4747
### Виджеты
4848

49+
- Добавлены виджеты для визуализации данных из ClickHouse: [«ClickHouse. Метрики (диапазон)»](../../admin/widgets/types/#clickhouse-метрики-диапазон), [«ClickHouse. Метрики (значение)»](../../admin/widgets/types/#clickhouse-метрики-значение), [«ClickHouse. Таблица»](../../admin/widgets/types/#clickhouse-таблица), [«ClickHouse. Топ N»](../../admin/widgets/types/#clickhouse-топ-n).
4950
- Добавлен виджет [«DefectDojo. Продукт»](../../admin/widgets/types/#defectdojo-продукт) для просмотра уязвимостей продукта в DefectDojo с разбивкой по engagement и уровням критичности.
5051
- Добавлен виджет [«Kanban доска сущностей»](../../admin/widgets/types/#kanban-доска-сущностей) для отображения сущностей ресурса на Kanban-доске.
5152
- Добавлен виджет [«Svacer. Ветка»](../../admin/widgets/types/#svacer-ветка) для просмотра статистики по ветке проекта в Svacer.

0 commit comments

Comments
 (0)