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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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-код. Его предпросмотр будет доступен в поле выше.

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

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

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

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

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

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

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

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

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

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

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

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