Импорт дашборда из Grafana

Дашборды Grafana можно перенести в Monium без ручной настройки каждого виджета. Например, можно перенести дашборды с метриками Prometheus для мониторинга кластеров Kubernetes и приложений в них.

Monium объединяет сбор, хранение и анализ метрик, логов и трейсов в одной платформе. На платформе доступны визуализация данных, алертинг, контроль выполнения SLO и другие возможности Observability. Для работы с метриками в формате Prometheus доступен Yandex Managed Service for Prometheus®, который поддерживает запись метрик по протоколу Remote Write.

Если вы еще не работаете с Monium, настройте передачу метрик из вашего приложения или попробуйте демо-приложение в Kubernetes.

Особенности импортаОсобенности импорта

При импорте учитывайте следующее:

• Метрики не переносятся вместе с дашбордом. До импорта настройте их передачу в Monium.
• Monium автоматически подберет шарды с метриками из запросов дашборда. Выберите один из них для нужного окружения и приложения.
• Monium преобразует поддерживаемые запросы и создает виджеты на основе панелей Grafana. Из-за ограничений преобразования некоторые элементы могут потребовать ручной настройки.
• После сохранения результата в выбранном проекте создается новый дашборд. Исходный дашборд в Grafana не изменяется.

Подготовка к импортуПодготовка к импорту

1. Экспортируйте конфигурацию дашборда из Grafana в формате JSON.

2. Убедитесь, что нужные метрики доступны в проекте Monium:

   1. В интерфейсе Monium в верхней панели нажмите название текущего проекта и выберите проект, в который поступают метрики.
   2. Откройте Поставка и хранение → Шарды и выберите шард.
   3. На вкладке Общая информация справа выберите Метрики шарда. Проверьте, что в шарде есть метрики из запросов исходного дашборда.
   4. Вернитесь на страницу шарда и откройте Графики шарда. Выберите нужные метрики и временной интервал. Убедитесь, что на графиках есть данные. Подробнее — в инструкции.

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

   • monium.dashboards.editor — создание и сохранение дашбордов.
   • monium.metrics.reader — чтение метрик, их значений и меток.
   • monium.shards.viewer — просмотр информации о шардах, кластерах и сервисах.

   Все эти разрешения также входят в роль monium.editor.

Импорт дашбордаИмпорт дашборда

Для импорта дашборда:

Откроется редактор нового дашборда с импортированными виджетами и параметрами.

Если нужные метрики распределены по нескольким шардам или часть метрик не найдена, некоторые графики потребуется настроить вручную.

Проверка и сохранение результатаПроверка и сохранение результата

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

Правила преобразованияПравила преобразования

Автоматическое преобразование запросов поддерживается для источников данных Monium и Prometheus. Запросы к InfluxDB, Graphite и CloudWatch, а также SQL-запросы остаются на исходном языке. Перепишите их на языке запросов Monium.

Если имена метрик в Grafana и Monium различаются, при импорте подбираются метрики с похожими именами. Найдите такие замены в логах конверсии и проверьте смысл и единицы измерения выбранных метрик.

Для некоторых типов панелей Grafana в Monium используются другие типы визуализации:

Тип панели Grafana	Результат в Monium
gauge, bargauge, barchart, table	Плитка
heatmap, histogram	Область
state-timeline	Линия
logs, alertlist и некоторые другие неподдерживаемые панели	Текстовая заглушка

Сопоставления значений с текстом и цветом (value mappings), например 1 → UP, не переносятся.

Сообщения в логах конверсииСообщения в логах конверсии

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

Столбец Уровень помогает оценить результат:

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

Содержание остальных столбцов:

• Тип — что произошло при преобразовании, например Метрика не найдена.
• Сообщение — подробное описание результата или проблемы.
• Виджет — виджет, к которому относится сообщение, или путь к элементу в исходном JSON.

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

Метрики и меткиМетрики и метки

Тип	Причина	Что делать
Метрика не найдена	В выбранном шарде не найдена метрика с именем, указанным в запросе.	Проверьте шард, имя метрики и поступление ее значений. Исправьте имя в запросе или повторите импорт с другим шардом.
Метка не найдена	Имя метки из запроса не найдено среди меток выбранного шарда.	Проверьте метки метрики и исправьте имя в фильтрах или группировках запроса.
Метрика подобрана автоматически	Подобрана метрика с похожим именем, например с другим регистром букв, разделителями или суффиксом единицы измерения.	Сравните смысл, единицы измерения и значения метрик. При необходимости исправьте запрос.
Правило предвычисления	Запрос использует результат правила предвычисления (recording rule) Prometheus. Такого временного ряда может не быть в Monium.	Настройте передачу результата правила в Monium или воспроизведите вычисление в запросе. Переименование метрики не заменяет вычисление.
Служебная метрика сбора	Запрос использует служебную метрику Prometheus, например up или метрику с префиксом scrape_. Такие метрики создаются при опросе источников и могут отсутствовать в Monium.	Проверьте передачу служебных метрик. Если они не собираются, подберите доступную метрику состояния или сбора данных и измените запрос с учетом ее смысла.
Непроверенное имя	Имя содержит переменную шаблона без подставленного значения, поэтому существование метрики или метки не проверено.	Проверьте параметры дашборда и запрос после подстановки значений. При необходимости исправьте шаблон имени.

Запросы и виджетыЗапросы и виджеты

Тип	Причина	Что делать
Неподдерживаемый запрос	Конструкция запроса или источник данных не поддерживается. Запрос оставлен на исходном языке либо пропущен вместе с виджетом.	Прочитайте подробности сообщения и перепишите запрос на языке запросов Monium. Если виджет пропущен, создайте его вручную.
Неподдерживаемый виджет	У панели Grafana нет прямого аналога в Monium. Она заменена виджетом другого типа или текстовой заглушкой либо пропущена.	Выберите подходящий тип виджета и настройте его вручную.
Приближенное преобразование	Запрос или настройки отображения перенесены с отличиями от исходных.	Проверьте указанные в сообщении отличия, значения на графике и отображение данных. При необходимости измените запрос или настройки виджета.

Другие сообщенияДругие сообщения

Тип	Причина	Что делать
Цель переименования не найдена	Правило переименования указывает на метрику, которой нет в выбранном шарде.	Проверьте имя целевой метрики и исправьте запрос в импортированном дашборде.
Неиспользованное правило переименования	Правило не соответствует ни одной метрике в исходном дашборде.	Проверьте запросы и данные на импортированном дашборде.
Не указан	Тип сообщения не задан.	Ориентируйтесь на уровень, текст сообщения и указанный виджет.

Правила переименования — внутренние настройки API конвертации. При импорте дашборда их нельзя задать или изменить.

Если импорт не выполняетсяЕсли импорт не выполняется

Проблема	Что делать
Некорректный JSON	Проверьте синтаксис. JSON должен содержать объект дашборда, а не массив или строку. Для загрузки из файла используйте расширение .json.
В дашборде нет метрик для подбора шарда	Проверьте, что экспортирован нужный дашборд и его запросы содержат метрики.
Нет шардов для проверки	Проверьте выбранный проект и наличие в нем шардов с метриками.
Метрики дашборда не найдены	Проверьте, что метрики из запросов поступают в выбранный проект. Без подходящего шарда запустить преобразование нельзя.
Каталоги шардов недоступны или произошла ошибка поиска	Повторите попытку позже. Если рядом с ошибкой есть кнопка повтора, нажмите ее.
Не удалось импортировать дашборд	Прочитайте сообщение об ошибке. Исправьте исходную конфигурацию, если причина в ней, или повторите попытку позже.

Полезные ссылкиПолезные ссылки

• Дашборд в Monium
• Добавление параметра дашборда
• Копирование дашборда

Шард — объект конфигурации Monium, которому принадлежат метрики из конкретной пары сервиса и кластера, а также настройки хранения этих метрик, например TTL.