Skip to content

Commit 3f0e0c6

Browse files
author
Nikita Velgin
committed
add prometheus widget changes description
1 parent 373df83 commit 3f0e0c6

2 files changed

Lines changed: 49 additions & 24 deletions

File tree

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

Lines changed: 37 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1032,57 +1032,70 @@ title: Типы виджетов
10321032
| Index pattern | Да | Название index pattern из которого будут загружаться данные в виджет. Может содержать символ «*». Примеры: `security-auditlog`, `security-auditlog-*` | - |
10331033
| Timestamp field | Нет | Название поля с timestamp. Значение поля выводится в таблице с данными в отдельной колонке | @timestamp |
10341034

1035-
### Prometheus metrics (range)
1035+
### Prometheus. Метрики (диапазон)
10361036

1037-
Виджет позволяет построить график из диапазона значений на основе метрики из Prometheus, задать для него единицу измерения и выбрать пороговое значение. Запрос (query), указанный в виджете, должен возвращать тип Scalar или тип Vector с одним значением.
1037+
Виджет строит график по результату запроса `query_range` к Prometheus. Запрос в формате PromQL должен возвращать тип **Matrix** (одну или несколько временных серий).
10381038

1039-
Пример корректного запроса для виджета:
1039+
Пример запроса с плейсхолдерами:
10401040

1041-
```sh
1042-
rate(nginx_ingress_controller_nginx_process_connections[5m])
1041+
```promql
1042+
sum by (status) (rate(http_requests_total[{{rateInterval}}]))
10431043
```
10441044

1045+
#### Плейсхолдеры в запросе
1046+
1047+
Виджет подставляет в запрос значения, рассчитанные из активного интервала:
1048+
1049+
| Плейсхолдер | Описание |
1050+
|-------------|----------|
1051+
| `{{range}}` | Длительность выбранного интервала |
1052+
| `{{rateInterval}}` | Окно диапазона для функций `rate()` и `increase()` |
1053+
| `{{interval}}` | Шаг между точками на графике (рассчитывается автоматически) |
1054+
1055+
Шаг запроса выбирается по длительности интервала (не более 1100 точек на графике, минимум 30 секунд). Поле «Шаг разрешения» в конфигурации больше не используется.
1056+
10451057
#### Конфигурация
10461058

10471059
| Название | Обязательность | Описание | Значение по умолчанию |
10481060
|-----------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
10491061
| URL | Да | URL Prometheus | - |
1050-
| Query | Да | Запрос метрики из Prometheus в формате PromQL | - |
1051-
| Шаг разрешения (сек.) | Да | Интервал между отсчетами на горизонтальной оси (в секундах) | 60 |
1052-
| Метка | Да | Метка в результатах запроса, чье уникальное значение присваивается в качестве названий соответствующих линий на графике визуализации | - |
1053-
| Порог | Нет | Порог, отображаемый в виде горизонтальной красной полосы на графике | - |
1054-
| Минимальное значение | Нет | Начальная точка отсчёта для вертикальной линии на графике | - |
1055-
| Максимальное значение | Нет | Предельная точка отсчёта для вертикальной линии на графике | - |
1062+
| Запрос | Да | PromQL-запрос для графика диапазона | - |
1063+
| Метка | Да | Имя метки Prometheus, используемое как название серии в легенде графика | - |
1064+
| Интервал по умолчанию | Нет | Интервал при загрузке виджета и при обновлении, если пользователь не выбрал другой диапазон в панели виджета | Последний час |
1065+
| Пороговое значение | Нет | Горизонтальная пунктирная линия на графике | - |
1066+
| Минимальное значение | Нет | Нижняя граница оси Y; оставьте пустым для автоматического масштабирования | - |
1067+
| Максимальное значение | Нет | Верхняя граница оси Y; оставьте пустым для автоматического масштабирования | - |
10561068
| InsecureSkipVerify | Нет | Отключение проверки подлинности TLS/SSL-сертификата Prometheus | false |
10571069

10581070
#### Авторизация
10591071

10601072
Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#prometheus).
10611073

1062-
#### Дополнительные возможности виджета
1063-
1064-
При просмотре виджета возможно настроить диапазон отображаемых значений. Доступные параметры отображения диапазона:
1074+
### Prometheus. Метрики (значение)
10651075

1066-
* Интервал.
1067-
* Минимальное значение (начальная точка отсчёта для вертикальной линии на графике).
1068-
* Максимальное значение (предельная точка отсчёта для вертикальной линии на графике).
1076+
Виджет выводит одно число по instant-запросу к Prometheus на **конце** выбранного интервала. Запрос в формате PromQL должен возвращать тип **Scalar** или тип **Vector** с одним значением.
10691077

1070-
### Prometheus metrics (single)
1078+
Пример запроса с плейсхолдерами:
10711079

1072-
Виджет позволяет вывести одно число на основе метрики из Prometheus, задать для него единицу измерения и выбрать пороговое значение. Query, указанная в виджете, должна возвращать тип Scalar или тип Vector с одним значением.
1080+
```promql
1081+
sum(increase(http_requests_total[{{range}}]))
1082+
```
10731083

1074-
Пример корректной query для виджета:
1084+
#### Плейсхолдеры в запросе
10751085

1076-
```sh
1077-
sum(ingress_nginx_detail_requests_total)
1078-
```
1086+
| Плейсхолдер | Описание |
1087+
|-------------|----------|
1088+
| `{{range}}` | Длительность выбранного интервала |
1089+
| `{{rateInterval}}` | Окно диапазона для функций `rate()` и `increase()` |
1090+
| `{{interval}}` | Шаг запроса, рассчитанный из интервала |
10791091

10801092
#### Конфигурация
10811093

10821094
| Название | Обязательность | Описание | Значение по умолчанию |
10831095
|----------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------------|
10841096
| URL | Да | URL Prometheus | - |
1085-
| Query | Да | Query для запроса метрики из Prometheus в формате PromQL | - |
1097+
| Запрос | Да | PromQL instant-запрос на конце выбранного интервала | - |
1098+
| Интервал по умолчанию | Нет | Интервал при загрузке виджета и при обновлении, если пользователь не выбрал другой диапазон в панели виджета | Последний час |
10861099
| Количество цифр после запятой | Нет | Точность, с которой будет выводиться полученное значение | - |
10871100
| Единица измерения | Нет | Постфикс, с которым будет выводиться полученное значение | - |
10881101
| Отображать пороговое значение | Нет | Отображать пороговое значение в формате <значение метрики> / <пороговое значение> | false |

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ description: Заметки о выпуске v1.6.0 — выгрузка ауд
88
Выпуск релиза планируется 22.06.2026
99
{{< /alert >}}
1010

11+
## Несовместимые изменения
12+
13+
### Виджеты Prometheus
14+
15+
Обновлены виджеты [«Prometheus. Метрики (диапазон)»](../../admin/widgets/types/#prometheus-метрики-диапазон) и [«Prometheus. Метрики (значение)»](../../admin/widgets/types/#prometheus-метрики-значение). Существующие виджеты продолжают открываться, но для корректного отображения данных может потребоваться перенастройка:
16+
17+
- у виджета **«Prometheus. Метрики (диапазон)»** удалено поле «Шаг разрешения» — шаг между точками рассчитывается автоматически; сохранённое значение в конфигурации игнорируется;
18+
- запросы PromQL теперь поддерживают плейсхолдеры `{{range}}`, `{{rateInterval}}` и `{{interval}}` — проверьте запросы с фиксированными окнами (`[5m]`, `[1h]` и т. п.) и при необходимости замените их на плейсхолдеры;
19+
- задайте «Интервал по умолчанию» в конфигурации виджета;
20+
- выбор момента запроса для виджета **«Prometheus. Метрики (значение)»** выполняется через интервал в панели виджета, а не через параметр `queryTime`.
21+
1122
## Новые возможности
1223

1324
### Пользователи
@@ -35,6 +46,7 @@ description: Заметки о выпуске v1.6.0 — выгрузка ауд
3546

3647
- Добавлен виджет [«DefectDojo. Продукт»](../../admin/widgets/types/#defectdojo-продукт) для просмотра уязвимостей продукта в DefectDojo с разбивкой по engagement и уровням критичности.
3748
- Добавлен виджет [«Kanban доска сущностей»](../../admin/widgets/types/#kanban-доска-сущностей) для отображения сущностей ресурса на Kanban-доске.
49+
- Обновлены виджеты [«Prometheus. Метрики (диапазон)»](../../admin/widgets/types/#prometheus-метрики-диапазон) и [«Prometheus. Метрики (значение)»](../../admin/widgets/types/#prometheus-метрики-значение): выбор интервала в панели виджета, плейсхолдеры в PromQL, автоматический расчёт шага графика.
3850

3951
### Наборы данных
4052

0 commit comments

Comments
 (0)