Документацияbreadcrumb arrow Grafanabreadcrumb arrow Документация GlaberGraphbreadcrumb arrow Визуализация данныхbreadcrumb arrow Дашбордыbreadcrumb arrow Общий доступ

Предоставление общего доступа к дашбордам и панелям

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

  • Прямых ссылок для пользователей внутри и за пределами вашей организации
  • Снимков (snapshots)
  • Встраивания (embeds)
  • PDF-файлов
  • Изображений PNG
  • JSON-файлов
  • Отчётов
  • Панелей из библиотеки

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

Note

Разрешение анонимного доступа недоступно в Grafana Cloud. Эта возможность поддерживается только в Grafana Enterprise и Grafana Open Source.

Предоставление общего доступа к дашбордам

Делиться дашбордами можно следующими способами:

Когда вы делитесь дашбордом извне — по ссылке или по электронной почте, — эти дашборды попадают в список ваших общих дашбордов. Чтобы просмотреть список и управлять этими дашбордами, перейдите в Dashboards > Shared dashboards.

Note

Если вы изменили дашборд, обязательно сохраните изменения перед тем, как делиться им.

Чтобы поделиться настроенной прямой ссылкой на дашборд внутри вашей организации, выполните следующие шаги:

  1. В главном меню нажмите Dashboards.
  2. Нажмите на дашборд, которым хотите поделиться.
  3. Нажмите раскрывающийся список Share в правом верхнем углу и выберите Share internally.
  4. (Необязательно) В открывшейся панели Share internally задайте следующие параметры:
    • Lock time range — преобразует текущий относительный временной диапазон в абсолютный. Эта опция включена по умолчанию.
    • Shorten link — сокращает ссылку на дашборд. Эта опция включена по умолчанию.
  5. Выберите тему оформления дашборда. На выбор: Current, Dark или Light.
  6. Нажмите Copy link.
  7. Отправьте скопированную ссылку пользователю Grafana, у которого есть право на её просмотр.
  8. Нажмите X в правом верхнем углу, чтобы закрыть панель общего доступа.

Быстрое предоставление внутренней ссылки

Настроив внутреннюю ссылку, вы можете быстро ею поделиться, выполнив следующие шаги:

  1. В главном меню нажмите Dashboards.
  2. Нажмите на дашборд, которым хотите поделиться.
  3. Нажмите кнопку Share, а не значок раскрывающегося списка, чтобы скопировать сокращённую ссылку.

Эта ссылка содержит все настройки, заданные ранее, — например, фиксацию временного диапазона или тему оформления. Они хранятся в области видимости браузера.

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

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

Планирование отчёта

Note

Эта функция доступна только в Grafana Enterprise.

Чтобы поделиться дашбордом в виде отчёта, выполните следующие шаги:

  1. В главном меню нажмите Dashboards.
  2. Нажмите на дашборд, которым хотите поделиться.
  3. Нажмите раскрывающийся список Share в правом верхнем углу и выберите Schedule a report.
  4. Настройте отчёт.
  5. В зависимости от настроек расписания на этом шаге будут разные варианты. Нажмите Schedule send или Send now.

Также отчёт можно сохранить как черновик.

Чтобы управлять отчётами, перейдите в Dashboards > Reporting > Reports.

Предоставление снимка

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

Снимки можно публиковать в вашем локальном экземпляре или на snapshots.raintank.io. Последний — бесплатный сервис, предоставляемый Grafana Labs, который позволяет публиковать снимки дашбордов во внешнем экземпляре Grafana. Любой, у кого есть ссылка, может его просмотреть. При необходимости можно задать срок действия, чтобы снимок удалялся через определённое время.

Note

Опция snapshots.raintank.io по умолчанию отключена в Grafana Cloud. Чтобы включить эту функциональность, обновите свой файл конфигурации.

Чтобы увидеть другие снимки, которыми поделилась ваша организация, перейдите в Dashboards > Snapshots в главном меню.

Чтобы поделиться дашбордом с кем угодно в виде снимка, выполните следующие шаги:

  1. В главном меню нажмите Dashboards.

  2. Нажмите на дашборд, которым хотите поделиться.

  3. Нажмите раскрывающийся список Share в правом верхнем углу и выберите Share snapshot.

  4. В открывшейся панели Share snapshot введите описательный заголовок снимка в поле Snapshot name.

  5. Выберите один из следующих вариантов срока действия снимка:

    • 1 Hour
    • 1 Day
    • 1 Week
    • Never

  6. Нажмите Publish snapshot или Publish to snapshots.raintank.io.

    Grafana формирует ссылку на снимок. Учтите, что публиковать снимки дашбордов с пользовательскими панелями на snapshot.raintank.io нельзя.

  7. Нажмите Copy link и поделитесь ссылкой внутри организации или публично в интернете.

  8. Нажмите X в правом верхнем углу, чтобы закрыть панель общего доступа.

Удаление снимка

Чтобы удалить существующие снимки, выполните следующие шаги:

  1. Перейдите в Dashboards > Snapshots в главном меню.

  2. Чтобы убедиться, какой снимок вы собираетесь удалить, нажмите View в строке снимка.

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

  3. Нажмите красный x рядом со снимком, который хотите удалить.

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

Экспорт дашбордов

Помимо предоставления общего доступа к дашбордам в виде ссылок, отчётов и снимков, их можно экспортировать в формате PDF или JSON.

Экспорт дашборда в PDF

Note

Эта функция доступна только в Grafana Enterprise.

Чтобы экспортировать дашборд в его текущем состоянии в формате PDF, выполните следующие шаги:

  1. В главном меню нажмите Dashboards.

  2. Откройте дашборд, который хотите экспортировать.

  3. Нажмите раскрывающийся список Export на панели инструментов и выберите Export as PDF.

  4. В открывшейся панели Export dashboard PDF выберите ориентацию PDF: Landscape или Portrait.

  5. Выберите макет PDF: Grid или Simple.

  6. Задайте уровень Zoom: увеличьте масштаб, чтобы текст стал крупнее, или уменьшите, чтобы видеть больше данных (например, столбцов таблицы) на панель.

  7. Нажмите Generate PDF.

    PDF откроется в другой вкладке, где его можно скачать.

  8. Нажмите X в правом верхнем углу, чтобы закрыть панель общего доступа.

Экспорт дашборда как кода

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

  1. В главном меню нажмите Dashboards.

  2. Откройте дашборд, который хотите экспортировать.

  3. На панели инструментов нажмите значок Export и выберите Export as code.

    Откроется панель Export dashboard.

  4. (Необязательно) Нажмите Advanced options, чтобы развернуть раздел, и сделайте следующие выборы:

    • Model: выберите Classic или V2 Resource
    • Format: только для V2 Resource выберите JSON или YAML

  5. (Необязательно) Переключите тумблер Share dashboard with another instance, чтобы удалить сведения, специфичные для вашего экземпляра Grafana.

  6. Нажмите Download file или Copy to clipboard.

  7. Вставьте JSON в другое место.

  8. Нажмите X в правом верхнем углу, чтобы закрыть панель общего доступа.

Note

Чтобы опубликовать дашборд в каталоге сообщества Grafana, его нужно экспортировать с использованием модели Classic. О том, как добавлять дашборды в каталог сообщества Grafana, см. в разделе Публикация дашборда в сообществе.

Экспорт дашборда в изображение

Note

Чтобы экспортировать дашборд в виде изображения, у вас должна быть настроена служба рендеринга изображений Grafana.

Чтобы экспортировать дашборд в его текущем состоянии в виде файла изображения PNG, выполните следующие шаги:

  1. В главном меню нажмите Dashboards.

  2. Откройте дашборд, который хотите экспортировать.

  3. Нажмите раскрывающийся список Export на панели инструментов и выберите Export as image.

    Откроется панель Export as image.

  4. Нажмите Generate image.

    Отображается предварительный просмотр изображения.

  5. Нажмите Download image.

  6. Нажмите X в правом верхнем углу, чтобы закрыть панель общего доступа.

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

Публикация дашборда в сообществе

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

Чтобы опубликовать дашборд в каталоге сообщества, выполните следующие шаги:

  1. Экспортируйте свой дашборд с использованием модели Classic.
  2. Перейдите на Grafana и войдите в свою учётную запись Grafana Cloud.
  3. Перейдите в My dashboards и нажмите Upload dashboard.
  4. Загрузите файл Classic JSON, экспортированный из Grafana.
  5. Заполните обязательные поля метаданных и нажмите Save and Publish.

Обновление метаданных опубликованных дашбордов

После публикации дашборда в каталоге отображается кнопка Submit вместо Save and Publish. Нажатие Submit сохраняет и публикует изменения метаданных, включая снимки экрана, логотип и содержимое README.

Предоставление общего доступа к панелям

Делиться панелями можно следующими способами:

Note

Если вы изменили панель, обязательно сохраните изменения перед тем, как делиться ею.

Предоставление внутренней ссылки

Чтобы поделиться персонализированной прямой ссылкой на панель внутри вашей организации, выполните следующие шаги:

  1. Наведите курсор на любую часть панели, которой хотите поделиться, чтобы в правом верхнем углу появилось меню действий.

  2. Нажмите меню и выберите Share link.

  3. (Необязательно) В открывшейся панели Link settings задайте следующие параметры:

    • Lock time range — преобразует текущий относительный временной диапазон в абсолютный. Эта опция включена по умолчанию.
    • Shorten link — сокращает ссылку на панель. Эта опция по умолчанию отключена.

  4. Выберите тему оформления дашборда. На выбор: Current, Dark или Light.

  5. Нажмите Copy link.

  6. Отправьте скопированную ссылку пользователю Grafana, у которого есть право на её просмотр.

  7. (Необязательно) Чтобы сформировать изображение панели в виде файла PNG, настройте параметры изображения:

    • Width — в пикселях. Значение по умолчанию и минимум — 1000.
    • Height — в пикселях. Значение по умолчанию и минимум — 500.
    • Scale factor — по умолчанию 1.

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

  8. (Необязательно) Нажмите Generate image, чтобы увидеть предварительный просмотр изображения панели.

  9. (Необязательно) Нажмите Download image.

  10. Отправьте скопированное изображение пользователю Grafana, у которого есть право на его просмотр.

  11. Нажмите X в правом верхнем углу, чтобы закрыть панель общего доступа.

Параметры строки запроса для изображений, отрисованных на сервере

Когда вы нажимаете Generate image в настройках ссылки на панель, Grafana формирует изображение PNG этой панели со следующими параметрами по умолчанию:

Parameter Description
width Ширина в пикселях. Значение по умолчанию и минимум — 1000.
height Высота в пикселях. Значение по умолчанию и минимум — 500.
tz Часовой пояс в формате UTC%2BHH%3AMM, где HH и MM — смещение в часах и минутах после UTC.
timeout Количество секунд. Тайм-аут можно увеличить, если запросу для панели требуется больше 30 секунд по умолчанию.
scale Числовое значение для настройки коэффициента масштабирования устройства. По умолчанию 1. Используйте большее значение, чтобы получить более детализированные изображения (более высокий DPI).

Note

Рендерер изображений требует минимальных размеров: 1000px по ширине и 500px по высоте. В самостоятельно развёрнутых установках Grafana эти минимумы можно изменить через конфигурацию рендерера изображений. В Grafana Cloud конфигурация управляется Grafana и не может быть изменена. Если при отрисовке изображений через API возникают ошибки, связанные с размерами, убедитесь, что ваши размеры соответствуют минимальным требованиям.

Эти параметры также можно изменить в конфигурации рендеринга изображений.

В следующем примере показана ссылка на PNG, отрисованный на сервере:

Bash 
https://play.grafana.org/render/d-solo/ktMs4D6Mk?from=2024-09-03T11:55:44.442Z&to=2024-09-03T17:55:44.442Z&panelId=panel-13&width=1000&height=500&tz=UTC

Предоставление встраивания

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

Note

Встраивание панелей и разрешения анонимного доступа недоступны в Grafana Cloud — даже для панелей во внешних общих дашбордах. Эти возможности поддерживаются только в Grafana Enterprise и Grafana Open Source.

Чтобы создать панель, которую можно встроить, выполните следующие шаги:

  1. Наведите курсор на любую часть панели, которой хотите поделиться, чтобы в правом верхнем углу появилось меню действий.

  2. Нажмите меню и выберите Share embed.

    Откроется панель Share embed.

  3. (Необязательно) Переключите тумблер Lock time range, чтобы задать, использует ли панель текущий относительный временной диапазон или абсолютный. Эта опция включена по умолчанию.

  4. Выберите тему оформления дашборда. На выбор: Current, Dark или Light.

  5. (Необязательно) Внесите необходимые изменения в HTML.

  6. Нажмите Copy to clipboard.

  7. Вставьте HTML-код в код вашего веб-сайта.

  8. Нажмите X в правом верхнем углу, чтобы закрыть панель общего доступа.

Вот пример того, как может выглядеть HTML-код:

HTML 
<iframe
  src="https://snapshots.raintank.io/dashboard-solo/snapshot/y7zwi2bZ7FcoTlB93WN7yWO4aMiz3pZb?from=1493369923321&to=1493377123321&panelId=4"
  width="650"
  height="300"
  frameborder="0"
></iframe>

В результате получается интерактивная визуализация Grafana, встроенная в iframe.

Предоставление снимка

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

Снимки можно публиковать в вашем локальном экземпляре или на snapshots.raintank.io. Последний — бесплатный сервис, предоставляемый Grafana Labs, который позволяет публиковать снимки дашбордов во внешнем экземпляре Grafana. Любой, у кого есть ссылка, может его просмотреть. При необходимости можно задать срок действия, чтобы снимок удалялся через определённое время.

Note

Опция snapshots.raintank.io по умолчанию отключена в Grafana Cloud. Чтобы включить эту функциональность, обновите свой файл конфигурации.

Чтобы увидеть другие снимки, которыми поделилась ваша организация, перейдите в Dashboards > Snapshots в главном меню.

Чтобы поделиться панелью с кем угодно в виде снимка, выполните следующие шаги:

  1. Наведите курсор на любую часть панели, которой хотите поделиться, чтобы в правом верхнем углу появилось меню действий.

  2. Нажмите меню и выберите Share snapshot.

  3. В открывшейся панели Share snapshot введите описательный заголовок снимка в поле Snapshot name.

  4. Выберите один из следующих вариантов срока действия снимка:

    • 1 Hour
    • 1 Day
    • 1 Week
    • Never

  5. Нажмите Publish snapshot или Publish to snapshots.raintank.io.

    Grafana формирует ссылку на снимок. Учтите, что публиковать снимки, включающие пользовательские панели, на snapshot.raintank.io нельзя.

  6. Нажмите Copy link и поделитесь ссылкой внутри организации или публично в интернете.

  7. Нажмите X в правом верхнем углу, чтобы закрыть панель общего доступа.

Удаление снимка

Чтобы удалить существующие снимки, выполните следующие шаги:

  1. Перейдите в Dashboards > Snapshots в главном меню.

  2. Чтобы убедиться, какой снимок вы собираетесь удалить, нажмите View в строке снимка.

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

  3. Нажмите красный x рядом с URL снимка, который хотите удалить.

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