Перейти к основному содержимому
Версия: v2.8.x

Создание Виджетов, конфигурация Дашбордов и мониторинг Системы

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

В Системе Логикор вы можете настроить отображение собираемых данных в виде различных Виджетов, которые могут быть объединены в отдельные Дашборды. Таким образом появится возможность отслеживать любые изменения в собираемых данных на интересующем вас отрезке времени.

Всего существует 7 видов отображения данных в виде Виджетов:

  • Линейный график;
  • Столбчатая диаграмма;
  • Круговая диаграмма;
  • Статистика;
  • Таблица;
  • HTML;
  • Markdown.

Общие принципы создания и конфигурации Виджетов очень похожи, поэтому в рамках данной лабораторной работы мы рассмотрим создание Виджета в виде линейного графика и в виде HTML-блока. Однако для того чтобы создать Виджет, необходимо создать свой первый Дашборд.

Создание Дашбордов​

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

Шаг 1. В веб-интерфейсе из левого бокового меню перейдите в раздел Дашборды.

Шаг 2. В левом верхнем углу окна нажмите на выпадающий список и нажмите Создать.

Шаг 3. В открывшемся модальном окне введите название вашего Дашборда и нажмите Создать.

После этого вы можете добавлять на свои Дашборды новые Виджеты.

Создание Виджетов​

После того, как вы создали свой Дашборд, необходимо добавить на него Виджеты.

Создание Виджета в виде линейного графика​

Рассмотрим процесс создания и конфигурации Виджетов на примере Виджета в виде линейного графика.

Шаг 1. В веб-интерфейсе из левого бокового меню перейдите в раздел Дашборды.

Шаг 2. В правом верхнем углу окна нажмите Добавить виджет и в выпадающем списке выберите Линейный график. После этого откроется окно конфигурации нового Виджета.

Шаг 3. В левом верхнем углу установите временные рамки, за которые должны отображаться данные в Виджете.

Шаг 4. В правой части окна конфигурации Виджета укажите название Виджета в поле Название и, при необходимости, добавьте описание в поле Описание.

Шаг 5. В поле Тип отображения выберите формат, в котором будет отображаться график. При выборе значения Линии данные будут отображаться в виде линий, при выборе значения Площадь график будет отображаться с заливкой от линии до осей.

Шаг 6. Выберите стиль отображаемых линий в поле Стиль линии. В случае, если вы выбрали значение Линии, график будет построен в виде единой непрерывной линии. Если вы выберете значение Точки, график будет построен в виде точек, соединенных отрезками.

Шаг 7. Для удобства просмотра активируйте легенду и выберите, в какой части Виджета она будет отображаться. В таком случае вы сможете быстро определить, какие данные отображены на графике.

Шаг 8. Укажите названия для осей графика в блоке Оси.

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

Шаг 10. Добавьте в поле SQL запрос A запрос, по которому будут собираться данные для построения графика. В рамках данной лабораторной работы рассмотрим отслеживание непустых сообщений, собираемых Логикор. Для этого добавьте запрос следующего вида:

SELECT
toStartOfInterval (timestamp, toIntervalHour (1)) AS `action`,
COUNT(*) AS `cnt`
FROM
`messages`
WHERE
(`action` IS NOT NULL)
AND (
timestamp >= $__fromTime
AND timestamp <= $__toTime
)
GROUP BY
`action`

Вы всегда можете изменить запрос под свои нужды.

Шаг 11. Нажмите Обновить запрос, чтобы построить график по заданному запросу.

Шаг 12. После того, как вы выполнили всю необходимую конфигурацию, нажмите Сохранить и выйти в правом верхнем углу страницы.

По такому же алгоритму вы можете добавить любой другой Виджет.

Создание Виджета в виде HTML-блока​

Также вы можете создать Виджет в виде HTML-блока. В такой Виджет вы можете поместить интересующую вас информацию, добавить памятку для себя или коллег, или встроить сторонний Виджет.

Шаг 1. В веб-интерфейсе из левого бокового меню перейдите в раздел Дашборды.

Шаг 2. В правом верхнем углу окна нажмите Добавить виджет и в выпадающем списке выберите HTML. После этого откроется окно конфигурации нового Виджета.

Шаг 3. В правой части окна конфигурации Виджета укажите название Виджета в поле Название и, при необходимости, добавьте описание в поле Описание.

Шаг 4. В блоке Значение добавьте ваш HTML-код. Его предпросмотр будет доступен в поле выше.

подсказка

Например, если вы хотите встроить Виджет мониторинга из Grafana, вставьте следующий код:
<iframe src="http://IP-адрес_Логикор:3000/путь_к_панели" width="100%" height="400" frameborder="0"></iframe>

Шаг 5. После того, как вы выполнили всю необходимую конфигурацию, нажмите Сохранить и выйти в правом верхнем углу страницы.

Управление Дашбордами​

Теперь, когда вы добавили на свой Дашборд Виджеты, вы можете управлять их расположением, изменять их, добавлять новые Дашборды, и т.д. Более подробная информация доступна в соответствующем разделе Руководства пользователя.

Мониторинг Системы​

Для того чтобы обеспечить наилучшую производительность Системы, необходимо всегда контролировать потребление системных ресурсов ее модулями. Для этого в систему добавлен модуль мониторинга, основанный на веб-приложении Grafana. Для того чтобы просмотреть предустановленные панели мониторинга, выполните следующие действия:

Шаг 1. Откройте веб-интерфейс приложения мониторинга, введя в адресную строку IP-адрес_Логикор:3000.

Шаг 2. Введите учетные данные для доступа к панелям мониторинга.

Шаг 3. На открывшейся странице нажмите на бургер-иконку в левом верхнем углу страницы и в выезжающем левом боковом меню выберите раздел Dashboards.

Шаг 4. На открывшейся странице вам будут доступны панели мониторинга метрик, разбитые по четырем основным категориям:

  • General — в данной категории расположены панели для мониторинга основных параметров Системы (статус кластера, количество Событий в секунду, потребление ресурсов и т.д.);
  • Clickhouse — в данной категории собраны панели для отслеживания параметров Clickhouse (анализ кластера, данных, запросов и т.д.);
  • Performance — в данной категории собраны панели для мониторинга производительности модулей Системы;
  • Statistics — в данной категории собраны общие данные для сбора статистики.

При выборе интересующей панели откроется вся доступная информация. Мы не рекомендуем изменять предустановленные панели.

внимание

Название панели мониторинга не может совпадать с названием папки.

Для возврата на предыдущую страницу нажмите на ее имя в поле пути в левом верхнем углу страницы.