Документация Grafana Документация GlaberGraph Как код Наблюдаемость как код Провижининг файлов в локальной установке Настройка provisioning файлов

Настройка provisioning файлов

Используйте provisioning локальных файлов, чтобы включить в ваш экземпляр Grafana ресурсы, которые вы храните в локальной файловой системе.

Монтирование локального пути называется repository (репозиторий).

Использование локального пути позволяет также применять его с таким инструментом, как fuse, что даёт возможность монтировать бакеты S3 как локальные пути. Вы также можете использовать такие инструменты, как restic, чтобы автоматически создавать резервные копии ваших дашбордов в предпочитаемом хранилище резервных копий.

Чтобы настроить синхронизацию файлов с локальными файлами, необходимо:

1. Настроить разрешённые пути в файле конфигурации Grafana (при первой настройке).
2. Задать локальный путь.
3. Выбрать, какое содержимое синхронизировать с Grafana.

Новые возможности provisioning файлов

Provisioning локальных файлов с помощью Administration > Provisioning в конечном итоге заменит традиционные методы, которые Grafana использовала для обращения к локальным файловым системам для файлов дашбордов.

Прежде чем начать

Чтобы настроить provisioning файлов, вам потребуется:

• Права администратора в вашей организации Grafana.
• Локальный каталог для хранения ваших дашбордов. Если вы хотите использовать репозиторий GitHub, см. раздел Set up Git Sync.
• Обновить раздел permitted_provisioning_paths файла custom.ini.
• Понимать ограничения provisioning локальных файлов. Подробнее см. в разделе Как это работает.

Настройка разрешённых путей

Флаг функциональности provisioning включён по умолчанию в Grafana Cloud, а начиная с Grafana v13 — также для OSS и Enterprise. Ручная настройка флага функциональности не требуется.

Локальная настройка должна быть относительным путём, и её относительный путь должен быть задан в параметре конфигурации permitted_provisioned_paths. Параметр конфигурации задаётся относительно вашего рабочего каталога, то есть каталога, из которого вы запускаете Grafana; обычно это /usr/share/grafana или подобный путь.

Локальные пути к файлам могут указывать на любой каталог, разрешённый конфигурацией. Пути по умолчанию — devenv/dev-dashboards и conf/provisioning в каталоге вашей установки grafana.

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

Значения, которые вы вводите для permitted_provisioning_paths, становятся базовыми путями для значений, вводимых вами при указании локального пути в мастере Connect to local storage.

1. Откройте файл конфигурации Grafana — grafana.ini или custom.ini. О расположении файла в зависимости от операционной системы см. в разделе Configuration file location.

2. Найдите или добавьте раздел [paths]. Чтобы добавить более одного расположения, разделяйте пути символом вертикальной черты (|). Список не должен содержать пустых путей или завершающих символов вертикальной черты. Добавьте следующие значения:

   ini Copy

   [paths]
   ; This is devenv/dev-dashboards and conf/provisioning by default.
   permitted_provisioning_paths = grafana/ | /etc/grafana/provisioning/

3. Сохраните изменения в файле и запустите Grafana.

Настройка provisioning на основе файлов

Чтобы использовать provisioning на основе файлов, вам нужен путь к папке grafana, где в репозитории хранятся ваши дашборды.

Чтобы начать настройку provisioning на основе файлов:

1. Войдите на свой сервер Grafana с учётной записью, у которой установлен флаг Grafana Admin.
2. Выберите Administration в меню слева, а затем Provisioning.
3. Выберите Configure file provisioning.

Подключение к локальному хранилищу

Локальный путь может указывать на любой каталог, разрешённый конфигурацией. См. раздел Настройка разрешённых путей для получения информации.

Начальный путь всегда является вашим рабочим каталогом grafana. Префикс, который нужно ввести, определяется расположениями, заданными в permitted_provisioning_paths. Пути по умолчанию — devenv/dev-dashboards и conf/provisioning в каталоге вашей установки grafana. Значение, которое вы вводите в интерфейсе Grafana, должно начинаться с любого из заданных значений. Например, conf/provisioning/test допустимо, а conf/test — нет.

1. Введите Local path, например grafana/. Он должен начинаться с любого из заданных значений permitted_provisioned_paths.
2. Выберите Choose what to synchronize.

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

Выбор содержимого для синхронизации

Ограничения синхронизации

Чтобы получить доступ к полной синхронизации экземпляра, необходимо явно включить эту опцию.

Применяются следующие правила:

• После завершения настройки вы не сможете создавать новые оповещения или библиотечные панели.
• Если вы выбрали полную синхронизацию экземпляра и хотите использовать оповещения и библиотечные панели, вам придётся удалить provisioned-репозиторий и подключиться заново с синхронизацией папок.

Настройка синхронизации

Вы можете синхронизировать внешние ресурсы в новую папку, не затрагивая остальную часть вашего экземпляра.

Чтобы настроить синхронизацию:

1. Выберите ресурсы, которые хотите синхронизировать.

2. Введите Display name для подключения к репозиторию. Ресурсы, хранящиеся в этом подключении, отображаются в интерфейсе Grafana под выбранным отображаемым именем.

3. Нажмите Synchronize, чтобы продолжить.

4. Вы можете повторить этот процесс для числа подключений до 10.

Синхронизация с внешним хранилищем

На этом шаге вы переходите к синхронизации ресурсов, выбранных на предыдущем шаге. При желании вы можете установить флажок Migrate existing resources, чтобы перенести ваши неуправляемые дашборды в provisioned-папку.

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

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

Выбор дополнительных настроек

При желании вы можете пометить любые синхронизируемые файлы как Read only, чтобы через Grafana нельзя было вносить изменения в ресурсы. Любые ресурсы, созданные вне Grafana и сохранённые в локальном репозитории, будут отражены в Grafana.

Выберите Finish.

Проверка дашбордов в Grafana

Чтобы убедиться, что ваши дашборды доступны по указанному вами расположению, нажмите Dashboards. Имя дашборда приводится в столбце Name.