Кастомные дашборды

На этой странице:

• Введение
• Создание дашборда
• Типы виджетов
• Источники данных для виджетов-графиков
  • OLAP Мастер (APM и EUM метрики)
  • PromQL (Инфраструктурные метрики)
  • LogsQL (Аналитика логов)
  • OLAP экспертный режим
  • Базовый режим (устаревший)
• Типы визуализации
  • Визуализации для OLAP Мастер
  • Визуализации для PromQL
  • Визуализации для LogsQL
  • Визуализации для OLAP экспертного режима
  • Визуализации для Базового режима (устаревший)
• Вкладки дашборда
• Переменные дашборда (фильтры)
• Операции с дашбордами
• Примеры

Введение

Кастомные дашборды — раздел платформы Proto Observability для создания персонализированных визуализаций на основе метрик, логов и других данных. Дашборды позволяют собирать на одном экране виджеты с графиками, таблицами, карточками и текстом для мониторинга ключевых показателей.

Как открыть: перейдите в раздел Дашборды в основном меню навигации платформы.

Создание дашборда

1. Перейдите в раздел Дашборды в меню навигации
2. Нажмите кнопку + Дашборд
3. В открывшемся окне введите название дашборда и нажмите Создать
4. Откроется конструктор дашбордов с пустой рабочей областью

После создания дашборда добавьте виджеты и настройте их, затем нажмите Сохранить в правом верхнем углу.

Для отмены создания нажмите кнопку с красным крестиком рядом с кнопкой Сохранить.

Типы виджетов

При добавлении виджета выберите один из типов из выпадающего меню Виджет:

Виджеты можно перемещать и изменять их размер на рабочей области дашборда. На дашборде может быть размещено произвольное количество виджетов обоих типов.

Источники данных для виджетов-графиков

При редактировании виджета типа «График» необходимо выбрать источник данных. Платформа поддерживает пять источников данных.

OLAP Мастер (APM и EUM метрики)

Источник данных OLAP Мастер — управляемый (wizard) режим для построения графиков по APM и EUM метрикам через OLAP-движок.

Возможности:

• Выбор метрик из курируемого каталога
• Выбор сервиса и эндпоинта (операции)
• Автоматическое построение OLAP-запроса на основе выбранных параметров
• Курируемый набор визуализаций, оптимизированных для APM-данных

Этот режим подходит для быстрого построения визуализаций по стандартным метрикам APM и EUM без написания запросов.

PromQL (Инфраструктурные метрики)

Источник данных PromQL позволяет писать произвольные PromQL-запросы для визуализации метрик Prometheus.

Возможности:

• Текстовое поле для ввода PromQL-запроса
• Добавление до 5 запросов на один виджет через кнопку + Запрос — результаты всех запросов отображаются на одном графике
• Поддержка всех функций и операторов PromQL

Пример запроса:

round(avg(system_cpu_system{host=~".*central1.internal"}) by (host), 0.1)

Подробнее о синтаксисе PromQL см. Браузер метрик и построитель PromQL-запросов.

LogsQL (Аналитика логов)

Источник данных LogsQL позволяет визуализировать данные логов с помощью запросов LogsQL. Этот источник данных поддерживает два режима работы:

Режим Hits (попадания)

Визуализация количества лог-записей, соответствующих запросу, в виде временного ряда. Подходит для отслеживания динамики объема логов по заданным критериям.

Режим Stats (статистика)

Визуализация результатов агрегатных запросов LogsQL с использованием пайпа stats. Подходит для отображения вычисленных показателей (количество, среднее, максимум и другие агрегации).

Пример запроса LogsQL для режима Hits:

service:exact("payment-service") AND level:exact("error")

Подробнее о синтаксисе LogsQL см. Logs Explorer.

OLAP экспертный режим

Источник данных OLAP экспертный режим предоставляет полный доступ к OLAP-движку с расширенным набором визуализаций.

Возможности:

• Произвольные OLAP-запросы (measures, dimensions, filters, timeDimensions)
• Расширенный набор визуализаций, включая специализированные типы: поток бизнес-процесса (BusinessFlow), геокарта (GeoMap), граф связей (DirectedGraph), горизонтальная столбчатая диаграмма (StackHorizontalBar), составная карточка (CardStacked)
• Полный контроль над параметрами запроса и отображения

Этот режим подходит для опытных пользователей, которым нужны расширенные визуализации и полный контроль над OLAP-запросами.

Базовый режим (устаревший)

Источник данных Базовый режим использует GraphQL API для выбора метрик.

Возможности:

• Выбор метрик через GraphQL API платформы
• Поддержка специфичных визуализаций: список топ значений (TopList), текст (Text), тепловая карта (Heatmap), список сервисов (ServiceList), список эндпоинтов (EndpointList), список инстансов (InstanceList)

Типы визуализации

Доступные типы визуализации зависят от выбранного источника данных.

Визуализации для OLAP Мастер

Визуализации для PromQL

Визуализации для LogsQL

Доступные визуализации зависят от режима LogsQL:

Режим Hits (попадания):

Режим Stats (статистика):

Визуализации для OLAP экспертного режима

Визуализации для Базового режима (устаревший)

Вкладки дашборда

Дашборд может содержать несколько вкладок для организации виджетов по категориям.

Управление вкладками:

• Переименование — нажмите иконку с тремя точками рядом с названием вкладки и выберите Переименовать вкладку
• Добавление — нажмите иконку + рядом с последней вкладкой
• Удаление — нажмите иконку x над названием вкладки

По умолчанию при создании дашборда доступна одна вкладка — «Вкладка 1».

Переменные дашборда (фильтры)

Переменные дашборда — это фильтры, которые отображаются в виде выпадающих списков в шапке дашборда и применяются сразу ко всем виджетам. Например, переменная host позволяет на одном дашборде переключаться между серверами вместо создания отдельного дашборда для каждого. Это знакомый по Grafana механизм template variables.

Переменные работают с виджетами на источнике данных PromQL.

Как открыть управление переменными

1. Откройте дашборд на редактирование (иконка «ручка»)
2. Нажмите кнопку Переменные на панели инструментов
3. Откроется окно со списком переменных дашборда

В списке отображается имя переменной ($имя), её тип и определение. Для каждой переменной доступны действия: изменить, дублировать, удалить. Кнопка Добавить переменную создаёт новую.

Добавление и настройка переменной

При добавлении или изменении переменной заполните поля формы:

После настройки нажмите Применить в форме, затем Применить в окне списка и Сохраните дашборд.

Как переменная применяется к виджетам

Есть два способа связать переменную с виджетами; можно использовать любой из них или оба сразу.

Способ 1 — автоматически по метке (рекомендуется). Заполните поле Фильтровать виджеты по label (обычно совпадает с Label, например host). Тогда ко всем PromQL-виджетам дашборда автоматически добавляется фильтр по выбранным значениям этой метки — запросы виджетов менять не нужно. Это основной сценарий: «один дашборд, фильтруемый по хосту».

Способ 2 — явно в запросе. Сошлитесь на переменную прямо в PromQL-запросе виджета через $имя. Используйте оператор =~, так как при мультивыборе подставляется регулярное выражение:

system_cpu_system{host=~"$host"}

При выборе «Все» (или пустом выборе) фильтр снимается — отображаются данные по всем значениям.

Использование фильтров

В режиме просмотра дашборда выпадающие списки переменных отображаются в шапке, рядом с подписью Фильтр. Выберите одно или несколько значений — графики обновятся автоматически.

Текущий выбор сохраняется в адресной строке (URL), поэтому ссылкой на дашборд можно поделиться вместе с выбранными значениями фильтров — кнопка Поделиться учитывает их автоматически. Значения по умолчанию сохраняются в дашборде при его сохранении.

Операции с дашбордами

Примеры

Пример 1: дашборд с PromQL-виджетами для мониторинга CPU

1. Создайте новый дашборд
2. Добавьте виджет типа График
3. В настройках виджета выберите источник данных PromQL (Инфраструктурные метрики)
4. Выберите тип визуализации Линейная диаграмма
5. Введите запрос:

round(avg(system_cpu_system{host=~".*central1.internal"}) by (host), 0.1)

6. Задайте название виджета, например, «CPU по хостам»
7. Сохраните дашборд

Пример 2: виджет через OLAP Мастер для отслеживания времени отклика сервиса

1. Создайте новый дашборд или откройте существующий на редактирование
2. Добавьте виджет типа График
3. В настройках виджета выберите источник данных OLAP Мастер (APM и EUM метрики)
4. Выберите метрику, например, «Время отклика (P95)»
5. Выберите сервис из выпадающего списка
6. Выберите тип визуализации Линейная диаграмма
7. Задайте название виджета, например, «P95 время отклика — payment-service»
8. Сохраните дашборд