Документация Grafana Документация GlaberGraph Как код Наблюдаемость как код Синхронизация Git Work with provisioned dashboards

Работа с выделенными дашбордами в Git Sync

Используя выделение ресурсов (provisioning), вы можете хранить JSON-файлы дашбордов либо в репозиториях Git с помощью Git Sync, либо по локальному пути и управлять ими через интерфейс Grafana. Дашборды и папки, синхронизированные с помощью Git Sync или локального пути, называются выделенными (provisioned) ресурсами. Git Sync — рекомендуемый способ выделения ресурсов для ваших дашбордов.

Управление дашбордами, выделенными с помощью Git Sync

С помощью Git Sync вы можете управлять дашбордами в интерфейсе и синхронизировать их с настроенным репозиторием Git. Если вы отправите изменение в репозиторий, эти изменения отражаются в вашем экземпляре Grafana.

• Дашборды, сохранённые в вашем репозитории или локальной папке, настроенной с помощью Git Sync, отображаются в выделенной папке в Grafana.
• Любые папки дашбордов, сохранённые с помощью Git Sync, имеют в интерфейсе метку Provisioned.
• Чтобы сохранить любые изменения выделенных ресурсов, откройте pull request или зафиксируйте изменения напрямую в существующей ветке, например в ветке main.
  • Используйте pull request для проверки изменений дашбордов.
  • Просмотрите изменения перед слиянием.

Дополнительные сведения см. в разделе Ключевые понятия.

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

У вас есть следующие варианты добавления новых дашбордов в ваше подключение Git Sync:

• Создать их непосредственно в папках, управляемых Git Sync, в интерфейсе Grafana
• Добавить их, зафиксировав JSON-файлы в вашем репозитории Git

Если вы хотите добавить существующий дашборд в свои выделенные ресурсы, см. раздел Экспорт невыделенных ресурсов из Grafana.

Добавление нового дашборда из интерфейса Grafana

Чтобы добавить новый дашборд из интерфейса Grafana:

1. На вкладке Dashboards нажмите New в правом верхнем углу и выберите один из следующих вариантов:
   • New dashboard. При создании нового дашборда в выделенной папке, связанной с репозиторием Git, вы используете тот же процесс, что и для любого нового дашборда. Дополнительные сведения см. в разделе Создание дашборда.
   • Import dashboard. Дополнительные сведения см. в разделе Добавление дашборда через Import dashboards.
   • Use template. Создайте дашборд с помощью шаблона Grafana.

После создания дашборда выполните следующие шаги:

1. Нажмите Save dashboard.
2. На панели Provisioned dashboard выберите нужные параметры:
   • Title: заголовок дашборда.
   • Description: описание дашборда.
   • Target folder: папка, в которой вы хотите разместить новый дашборд.
   • Branch: укажите имя ветки в вашем Git-провайдере (например, main).
   • Repository folder: папка внутри репозитория. Оставьте пустой для корня репозитория.
   • Filename: имя файла дашборда.
   • Comment: добавьте комментарий с описанием изменений для вашего коммита.
3. Необязательно: выберите вкладку Changes, чтобы просмотреть различия между внесёнными обновлениями и исходным ресурсом.
4. Выберите Save, и обновлённый дашборд загрузится.
5. В появившемся приглашении выберите Open a pull request in GitHub, чтобы открыть новый PR в вашем репозитории.
6. Следуйте своему обычному рабочему процессу Git, чтобы сохранить и слить PR в ваш репозиторий.

Редактирование дашбордов

При редактировании выделенного ресурса вам предлагается сохранить или отменить эти изменения. Сохранение изменений требует открытия pull request в вашем репозитории Git.

Чтобы сохранить изменения дашборда:

1. Выберите Edit, чтобы обновить выделенный дашборд.
2. Внесите нужные изменения и нажмите Save dashboard.
3. На панели Provisioned dashboard выберите нужные параметры:
   • Branch: укажите имя ветки в вашем Git-провайдере (например, main).
   • Repository folder: папка внутри репозитория. Оставьте пустой для корня репозитория.
   • Filename: имя файла дашборда.
   • Comment: добавьте комментарий с описанием изменений для вашего коммита.
4. Необязательно: выберите вкладку Changes, чтобы просмотреть различия между внесёнными обновлениями и исходным ресурсом.
5. Выберите Save, и обновлённый дашборд загрузится.
6. В появившемся приглашении выберите Open a pull request in GitHub, чтобы открыть новый PR в вашем репозитории.
7. Следуйте своему обычному рабочему процессу Git, чтобы сохранить и слить PR в ваш репозиторий.

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

Вы можете удалить выделенный дашборд, удалив его из репозитория. Интерфейс Grafana обновляется при синхронизации изменений из репозитория Git.

Чтобы восстановить удалённый дашборд, создайте PR напрямую в вашем репозитории Git. Восстановление ресурсов из интерфейса на данный момент невозможно.

Документирование папок с помощью README

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

• Если папка содержит файл README.md, Grafana отображает его содержимое в формате Markdown. Относительные ссылки и изображения в README разрешаются относительно хост-репозитория.
• Если в папке нет README.md или папка пуста, вам будет предложено выполнить действие с помощью кнопки Add README.
• Вы можете редактировать README в любое время. Выберите значок карандаша в заголовке README, чтобы открыть файл в редакторе вашего Git-провайдера и зафиксировать изменения через свой обычный рабочий процесс.

Рекомендации

Следуйте этим рекомендациям при работе с выделенными дашбордами:

• Используйте pull request в GitHub для изменений: поддерживайте процессы проверки для изменений дашбордов.
• Пишите понятные сообщения коммитов: описывайте свои изменения, чтобы упростить отслеживание и совместную работу.
• Регулярно синхронизируйте свой репозиторий: поддерживайте Grafana в актуальном состоянии с последними изменениями.
• Просматривайте вкладку Events: следите за состоянием синхронизации, чтобы убедиться, что изменения применяются корректно.
• Добавьте README для папки: документируйте содержимое каждой папки с помощью README.md, чтобы коллеги могли быстро найти нужный дашборд.

Общие рекомендации по использованию Git Sync см. в разделе Работа с выделенными репозиториями.