Элементы управления дашборда

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

Элементы управления дашборда в представлении боковой панели Dashboard options

Добавление элементов управления фильтрации и группировки

Note

Функция Filter and Group by переименовывает переменную Ad hoc filters и расширяет её, добавляя группировку для источников данных Prometheus и Loki. Однако в схеме дашборда она по-прежнему называется "kind": "AdhocVariable" в свойстве схемы variables.

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

  1. Перейдите к дашборду, который хотите изменить.

  2. Нажмите Edit.

  3. Нажмите значок Add new element (синий знак плюса).

  4. Нажмите Filter and Group by.

  5. Введите Name для фильтра.

  6. (Необязательно) В поле Label введите отображаемое имя для выпадающего списка фильтра.

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

  7. (Необязательно) В поле Description введите описание фильтра. Описание отображается как всплывающая подсказка со значком информации рядом с именем фильтра на дашборде.

    Описания поддерживают ссылки. Вы можете использовать ссылки в стиле Markdown ([текст ссылки](https://example.com)) или вставить обычные URL-адреса (https://example.com). Только URL-адреса http и https отображаются как кликабельные ссылки — другие протоколы отображаются как обычный текст.

  8. Выберите опцию Display:

    • Above dashboard: выпадающий список фильтра отображается над дашбордом со значением Name или Label фильтра. Это значение по умолчанию.
    • Above dashboard, label hidden: выпадающий список фильтра отображается над дашбордом, но без отображения имени фильтра.
    • Controls menu: фильтр отображается в меню элементов управления дашборда, а не над дашбордом. Меню элементов управления дашборда отображается как кнопка на панели инструментов дашборда.
    • Hidden: выпадающий список фильтра не отображается на дашборде.
  9. В разделе Filter options страницы задайте следующие параметры:

    Опция Описание
    Data source Выберите целевой источник данных в выпадающем списке. Вы также можете нажать Open advanced data source picker, чтобы увидеть больше опций, включая добавление источника данных (только для администраторов). Дополнительные сведения об источниках данных см. в разделе Добавление источника данных.
    Default filters Задайте пару «ключ/значение» по умолчанию. Необязательно. В элементе управления фильтром дашборда значение по умолчанию обозначается значком информации.
    Enable group by Эта опция появляется только в том случае, если вы выбрали источник данных Prometheus или Loki. Включите переключатель, чтобы включить группировку данных.
    Default group by Задайте ключ по умолчанию для дашборда. Необязательно. В элементе управления фильтром дашборда значение по умолчанию обозначается значком информации.
    Use static key dimensions Чтобы указать измерения фильтра в виде значений, разделённых запятыми (CSV), включите переключатель и введите значения в отведённом для этого поле. Необязательно.
    Allow custom values Включите переключатель, чтобы разрешить пользователям дашборда добавлять собственные значения в списки фильтра и группировки. Необязательно.
  10. Нажмите Save.

  11. Введите необязательное описание изменений дашборда и нажмите Save.

  12. Нажмите Exit edit.

Более подробную информацию о параметре Filter and Group by см. в полной документации по элементам управления фильтрации и группировки.

Добавление переменных

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

  1. Перейдите к дашборду, который хотите обновить.
  2. Нажмите Edit.
  3. Нажмите значок Add new element (синий знак «плюс») и выберите Variable.
  4. Также можно нажать значок Add variable в верхней части дашборда (знак «плюс»).

  5. Выберите тип переменной из списка.

    Тип переменной можно изменить, нажав Change type на боковой панели.

  6. Введите Name переменной.

  7. (Необязательно) В поле Label введите отображаемое имя для раскрывающегося списка переменной.

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

  8. (Необязательно) В поле Description введите описание переменной. Описание отображается в виде всплывающей подсказки со значком информации рядом с именем переменной на дашборде.

    Описания поддерживают ссылки. Можно использовать ссылки в стиле Markdown ([link text](https://example.com)) или вставлять URL как есть (https://example.com). Только URL http и https отображаются как кликабельные ссылки — остальные протоколы отображаются как обычный текст.

  9. Выберите параметр Display:

    • Above dashboard — раскрывающийся список переменной отображается над дашбордом со значением Name или Label переменной. Это значение по умолчанию.
    • Above dashboard, label hidden — раскрывающийся список переменной отображается над дашбордом, но без имени переменной.
    • Controls menu — переменная отображается в меню элементов управления дашборда, а не над дашбордом. Меню элементов управления дашборда отображается в виде кнопки на панели инструментов дашборда.
    • Hidden — раскрывающийся список переменной на дашборде не отображается.
  10. Завершите настройку переменной. Для более подробной информации о настройке перейдите по одной из следующих ссылок, чтобы выполнить шаги для выбранного типа переменной:
  11. Нажмите Save.
  12. (Необязательно) Введите описание внесённых изменений.
  13. Нажмите Save.
  14. Нажмите Exit edit.

Более подробную информацию о переменных см. в полной документации по переменным.

Добавление запросов аннотаций

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

  1. Перейдите к дашборду, который хотите изменить.

  2. Нажмите Edit.

  3. Нажмите значок Add new element (синий знак «плюс»).

  4. Нажмите Annotation query.

  5. Введите имя запроса аннотации.

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

  6. Если вы не хотите использовать запрос аннотации сразу, снимите флажок Enabled.

  7. Выберите цвет для маркеров событий аннотации.

  8. Выберите один из следующих пунктов в раскрывающемся списке Show annotation controls in, чтобы определить, где отображается аннотация:

    • Above dashboard — переключатель аннотации отображается над дашбордом. Это значение по умолчанию.
    • Controls menu — переключатель аннотации отображается в меню элементов управления дашборда вместо отображения над дашбордом. Меню элементов управления дашборда отображается как кнопка на панели инструментов дашборда.
    • Hidden — переключатель аннотации не отображается на дашборде.
  9. Выберите один из следующих пунктов в раскрывающемся списке Show in, чтобы определить панели, на которых отображается аннотация:

    • All panels — аннотации отображаются на всех панелях, поддерживающих аннотации.
    • Selected panels — аннотации отображаются на всех выбранных вами панелях.
    • All panels except — аннотации отображаются на всех панелях, кроме выбранных вами.
    Фильтрация аннотаций
    Фильтрация аннотаций
  10. Чтобы добавить запрос, выполните одно из следующих действий:

    • Нажмите Open query editor, чтобы открыть диалоговое окно Annotation Query, выберите пункт в раскрывающемся списке Data source и напишите или составьте запрос. Параметры запроса аннотации различаются для каждого источника данных. Информацию об аннотациях в конкретном источнике данных см. в соответствующем разделе источника данных. Перейдите к следующему шагу.
    • Нажмите Use saved query, чтобы открыть панель Saved queries. Выберите сохранённый запрос для повторного использования, нажмите Select query и переходите к шагу 13.

    Note

    Сохранённые запросы доступны только в Grafana Enterprise и Grafana Cloud.

  11. (Необязательно) Нажмите Test annotation query, чтобы убедиться, что запрос работает правильно.

  12. Нажмите Close, когда завершите настройку запроса.

  13. Нажмите Save.

  14. (Необязательно) Введите описание внесённых изменений.

  15. Нажмите Save.

  16. Нажмите Exit edit.

Более подробную информацию об аннотациях см. в полной документации по аннотациям.

Добавление ссылок

Более подробную информацию о ссылках дашборда см. в полной документации по ссылкам дашборда.

Добавление ссылок на дашборды

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

  1. Перейдите к дашборду, который хотите изменить.
  2. Нажмите Edit.
  3. Нажмите значок Add new element (синий знак «плюс»).
  4. Нажмите Link.
  5. Тип ссылки по умолчанию — Dashboards.

  6. В выпадающем списке With tags введите метки, чтобы ограничить связанные дашборды только теми, у которых есть введённые вами метки.

    Если вы не добавите метки, Grafana включит ссылки на все остальные дашборды.

  7. Задайте параметры ссылки:

    • Show as dropdown — если вы ссылаетесь на множество дашбордов, вероятно, стоит выбрать эту опцию и добавить необязательный заголовок для выпадающего списка. В противном случае Grafana отображает ссылки дашбордов рядом друг с другом в верхней части дашборда.
    • Include current time range — выберите эту опцию, чтобы включить диапазон времени дашборда в ссылку. Когда пользователь нажимает ссылку, связанный дашборд открывается с уже установленным указанным диапазоном времени. Пример: https://play.grafana.org/d/000000010/annotations?orgId=1&from=now-3h&to=now
    • Include current template variable values — выберите эту опцию, чтобы включить переменные шаблона, используемые в данный момент, в качестве параметров запроса в ссылке. Когда пользователь нажимает ссылку, любые подходящие шаблоны в связанном дашборде устанавливаются в значения из ссылки. Дополнительные сведения см. в разделе Переменные URL дашборда.
    • Open link in new tab — выберите эту опцию, если хотите, чтобы ссылка дашборда открывалась в новой вкладке или окне.
    • Show in controls menu — выберите эту опцию, чтобы отобразить ссылку в меню элементов управления дашборда, а не в верхней части дашборда. Меню элементов управления дашборда отображается как кнопка на панели инструментов дашборда.
  8. Нажмите Save.
  9. (Необязательно) Введите описание внесённых изменений.
  10. Нажмите Save.
  11. Нажмите Exit edit.

Добавление ссылки на URL в дашборд

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

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

  1. Перейдите к дашборду, который хотите изменить.
  2. Нажмите Edit.
  3. Нажмите значок Add new element (синий знак «плюс»).
  4. Нажмите Link.
  5. В выпадающем списке Type выберите Link.

  6. В поле URL введите URL-адрес, на который хотите сослаться.

    В зависимости от цели может потребоваться включить значения полей. Пример: https://github.com/grafana/grafana/issues/new?title=Dashboard%3A%20HTTP%20Requests

  7. В поле Tooltip введите подсказку, которую должна отображать ссылка при наведении на неё курсора.

  8. В выпадающем списке Icon выберите значок, который должен отображаться вместе со ссылкой.

  9. Задайте параметры ссылки; по умолчанию эти опции включены для URL-ссылок:

    • Include current time range — выберите эту опцию, чтобы включить диапазон времени дашборда в ссылку. Когда пользователь нажимает ссылку, связанный дашборд открывается с уже установленным указанным диапазоном времени. Пример: https://play.grafana.org/d/000000010/annotations?orgId=1&from=now-3h&to=now
    • Include current template variable values — выберите эту опцию, чтобы включить переменные шаблона, используемые в данный момент, в качестве параметров запроса в ссылке. Когда пользователь нажимает ссылку, любые подходящие шаблоны в связанном дашборде устанавливаются в значения из ссылки.
    • Open link in new tab — выберите эту опцию, если хотите, чтобы ссылка дашборда открывалась в новой вкладке или окне.
    • Show in controls menu — выберите эту опцию, чтобы отобразить ссылку в меню элементов управления дашборда, а не в верхней части дашборда. Меню элементов управления дашборда отображается как кнопка в заголовке дашборда.
  10. Нажмите Save.
  11. (Необязательно) Введите описание внесённых изменений.
  12. Нажмите Save.
  13. Нажмите Exit edit.

Управление элементами управления дашборда

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

Элементы управления дашборда в представлении боковой панели Dashboard options

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

  1. Нажмите значок Dashboard options на боковой панели.

  2. На боковой панели разверните соответствующий сворачиваемый раздел.

  3. Выполните одно или несколько из следующих действий:

    • Edit: нажмите Select на элементе управления, чтобы открыть его на боковой панели и внести изменения.
    • Reorder: перетаскивайте элементы управления, чтобы изменить их порядок.
    • Change display: перетаскивайте элементы управления между подразделами Above dashboard, Controls menu и Hidden, чтобы изменить параметр отображения элемента управления. Обратите внимание, что ссылки нельзя скрыть.

    Tip

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

  4. Внесите другие необходимые изменения.

  5. Нажмите Save.

  6. (Необязательно) Введите описание внесённых изменений.

  7. Нажмите Save.

  8. Нажмите Exit edit.