Использование параметров в панелях мониторинга Azure Data Explorer

Статья
10/19/2023

Параметры используются в качестве стандартных блоков для фильтров на панелях мониторинга Data Explorer Azure. Управление ими происходит в области панели мониторинга. Их также можно добавить в запросы, чтобы фильтровать данные, представленные базовым визуальным элементом. Запрос может использовать один или несколько параметров.

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

Примеры запросов, используемые в этой статье, основаны на StormEvents таблице в коллекции примеров.

Примечание

Управление параметрами доступно в режиме правки для редакторов панелей мониторинга.

Предварительные требования

Визуализация данных с помощью панелей мониторинга Azure Data Explorer
Разрешения редактора на панели мониторинга Data Explorer Azure
Панель мониторинга с визуальными элементами

Просмотр списка параметров

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

Создание параметра

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

Переключитесь из режима просмотра в режим редактирования .
Нажмите кнопку Параметры в верхней части панели мониторинга.
Нажмите кнопку + Создать параметр в верхней части правой области.
Заполните соответствующие свойства для параметра.

Поддерживаемые свойства

На панели Добавление параметра настройте следующие свойства:

Поле	Описание
Label	Имя параметра, отображаемое на панели мониторинга или на карточке редактирования.
Тип параметра	Используйте один из следующих параметров: Одно выделенное значение. В качестве входных данных для параметра можно выбрать только одно значение в фильтре. Несколько выделенных значений. В качестве входных данных для параметра можно выбрать несколько значений в фильтре. Диапазон времени. Позволяет создавать дополнительные параметры для фильтрации запросов и панелей мониторинга на основе времени. По умолчанию у каждой панели мониторинга есть средство выбора диапазона времени. Произвольный текст. Значения в фильтре не заполнены. Пользователь может ввести значение в текстовое поле или скопировать и вставить его. Фильтр сохраняет последние использованные значения.
Имя переменной	Имя параметра, используемое в запросе. Совет. Добавление префиксов к именам переменных с помощью отличительного символа, например символа подчеркивания (_), упрощает их поиск при написании запросов.
Data type	Тип данных значений параметра.
Show on pages (Показывать на страницах)	Выберите страницы, на которых будет отображаться этот параметр. Если выбрать вариант Выбрать все, параметр будет отображаться на всех страницах.
Источник	Источник значений параметра: Фиксированные значения. Статические значения фильтра предоставляются вручную. Запрос. Динамические значения предоставляются с помощью запроса KQL.
Значение по умолчанию	Значение фильтра по умолчанию. При начальном отображении панели мониторинга фильтр всегда будет запускаться со значением по умолчанию.
Add a "Select all" value (Добавление значения "Выбрать все")	Применимо только к одному и нескольким выделенным значениям. Используется для получения данных для всех значений параметров. Это значение нужно встроить в запрос для предоставления функциональных возможностей. Дополнительные примеры создания таких запросов см. в разделе Использование параметра на основе запроса с множественным выбором.

Управление параметрами

Выбрав Параметры на верхней панели, можно просмотреть список существующих параметров. В каждом параметре карта выберите мини-приложение карандаша, чтобы изменить параметр, или выберите в меню Дополнительно [...]пункт Дублировать, Удалить или переместить параметр.

На карточке параметров можно просмотреть следующие индикаторы:

Отображаемое имя параметра
Имена переменных
Число запросов, в которых использовался параметр
страницы, на которых закреплен параметр.

Карточки параметров можно упорядочить путем перетаскивания или с помощью параметра Переместить > в и выбрать новое расположение.

Снимок экрана: карточки примеров параметров.

Использование параметров в вашем запросе

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

Примечание

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

Типы параметров

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

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

В следующих примерах описывается использование параметров в запросе для различных типов параметров.

Параметр диапазона времени по умолчанию

Для каждой панели мониторинга по умолчанию предусмотрен параметр Диапазон времени. Он отображается на панели мониторинга в виде фильтра только при использовании в запросе. Примените ключевые слова параметра _startTime и _endTime, чтобы использовать в запросе стандартный параметр диапазона времени, как показано в следующем примере:

StormEvents
| where StartTime between (_startTime.._endTime)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

Как только вы сохраните данные, фильтр диапазона времени отобразится на панели мониторинга. Теперь его можно использовать для фильтрации данных в карточке. Вы можете отфильтровать панель мониторинга, выбрав в раскрывающемся списке: Диапазон времени (за последние x минут/часов/дней) или Настраиваемый диапазон времени.

Снимок экрана: фильтрация с помощью настраиваемого диапазона времени.

Параметры с фиксированными значениями с одним выбором

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

Создание параметра с фиксированными значениями с одним выбором

Выберите пункт Параметры, чтобы открыть панель Параметры, а затем выберите Создать параметр.

Заполните следующие сведения:

Метка: тип события
Тип параметра: Single selection (с одиночным выбором)
Имя переменной: _eventType
Тип данных: строка
Pin as dashboard filter (Закрепить как фильтр панели мониторинга): флажок установлен

Источник: фиксированные значения

В этом примере используйте следующие значения:

Значение	Отображаемое имя параметра
Шквалистый ветер	Грозовой ветер
Град	Град
Внезапное наводнение	Мгновенное наводнение
Засухи	Засухи
Зимняя погода	Зимняя погода

Задайте для параметра Выбрать все значение: "Не помечено"
Значение по умолчанию: Грозовой ветер

Нажмите кнопку Готово, чтобы создать параметр.

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

Использование параметра с фиксированными значениями с одним выбором

Выполните пример запроса, используя новый параметр Event TypTope , используя имя переменной _eventType :
```
StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType == _eventType
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
```
Новый параметр отображается в списке параметров в верхней части панели мониторинга.
Выберите другие значения, чтобы обновить визуальные элементы.

Параметры с фиксированными значениями с множественным выбором

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

Создание параметров с фиксированными значениями с множественным выбором

Выберите пункт Параметры, чтобы открыть панель Параметры, а затем выберите Создать параметр.
Заполните сведения, как указано в разделе Использование параметра с фиксированными значениями с одним выбором , со следующими изменениями:
- Метка: тип события
- Тип параметра: множественный выбор
- Имя переменной: _eventType
Нажмите кнопку Готово, чтобы создать параметр.

Новые параметры можно увидеть в боковой панели Параметры, однако в настоящее время они еще не используются в каких-либо визуальных элементах.

Использование параметра с фиксированными значениями с множественным выбором

Выполните пример запроса с помощью нового параметра Тип события с помощью переменной _eventType .
```
StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
```
Новый параметр отображается в списке параметров в верхней части панели мониторинга.
Выберите одно или несколько различных значений для обновления визуальных элементов.

Параметры на основе запроса с одним выбором

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

Создание параметра на основе запроса с одним выбором

Выберите пункт Параметры, чтобы открыть панель Параметры, а затем выберите Создать параметр.
Заполните сведения, как указано в разделе Использование параметра с фиксированными значениями с одним выбором , со следующими изменениями:
- Метка: State
- Имя переменной: _state
- Источник: запрос
- Источник данных: StormEventsSample
- Выберите Изменить запрос и введите следующий запрос. Нажмите кнопку Готово.
```
StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
| project State
```
- Значение: State
- Отображаемое имя: State
- Значение по умолчанию: выберите значение по умолчанию.
Нажмите кнопку Готово, чтобы создать параметр.

Использование параметра на основе запроса с одним выбором

В следующем примере запроса с новым параметром State используется _state переменная :
```
StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State == _state
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
```
Новый параметр отображается в списке параметров в верхней части панели мониторинга.
Выберите другие значения, чтобы обновить визуальные элементы.

Параметры запроса с множественным выбором

Значения параметра на основе запроса выводятся во время загрузки панели мониторинга путем выполнения заданного пользователем запроса. В следующем примере показано, как создать параметр на основе запроса с множественным выбором:

Создание параметра на основе запроса с множественным выбором

Выберите Параметры , чтобы открыть панель Параметры , и выберите + Новый параметр.
1. Заполните сведения, как указано в разделе Использование параметра с фиксированными значениями с одним выбором , со следующими изменениями:
- Метка: State
- Тип параметра: множественный выбор
- Имя переменной: _state
Нажмите кнопку Готово, чтобы создать параметр.

Использование параметра на основе запроса с множественным выбором

В следующем примере запроса используется новый параметр State с помощью переменной _state .
```
StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State in (_state) or isempty(_state)
| summarize TotalEvents = count() by State
| top 5 by TotalEvents
```
Примечание

Этот пример использует вариант Выбрать все, проверяя наличие неуказанных значений с помощью функции isempty().

Новый параметр отображается в списке параметров в верхней части панели мониторинга.
Выберите одно или несколько различных значений для обновления визуальных элементов.

Параметры свободного текста

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

Создание параметра "Произвольный текст"

Выберите Параметры , чтобы открыть панель Параметры , и выберите + Новый параметр.
Заполните следующие сведения:
- Метка: State
- Тип параметра: произвольный текст
- Имя переменной: _state
- Тип данных: строка
- Значение по умолчанию: значение по умолчанию не указано

Использование параметра свободного текста

Выполните пример запроса, используя новый параметр State , используя имя переменной _state :

StormEvents
| where StartTime between (_startTime.._endTime)
| where EventType in (_eventType) or isempty(_eventType)
| where State contains _state
| summarize TotalEvents = count() by State
| top 5 by TotalEvents

Параметры источника данных

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

Создание параметра источника данных

Выберите Параметры , чтобы открыть панель Параметры , и выберите + Новый параметр.
Заполните следующие сведения:
- Метка: источник
- Тип параметра: источник данных
- Показать на страницах: выберите все
- Значения: выберите все.
- Значение по умолчанию: StormEventsSample
Нажмите кнопку Готово.

Новый параметр теперь отображается в списке параметров в верхней части панели мониторинга.

Использование параметра источника данных

Перейдите к запросу новой или существующей плитки.
В поле Источник выберите имя нового параметра в разделе Параметры источника данных. Для созданного выше параметра выберите Кластер.
Нажмите кнопку Применить изменения.
Используйте параметр Cluster , чтобы изменить источник данных для этого подключенного запроса.

Параметры перекрестных фильтров

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

Определение перекрестных фильтров

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

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

Важно!

Столбец и параметр должны иметь один и тот же тип данных.

Снимок экрана: страница редактирования визуального элемента с вкладкой

Взаимодействие с данными с помощью перекрестных фильтров

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

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

Вы можете сбросить перекрестный фильтр, выбрав Сбросить в верхней части визуального элемента, в котором он был выбран.

Использование детализаций в качестве параметров панели мониторинга

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

Определение детализации

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

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

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

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

Важно!

У столбца и параметра должен быть один и тот же тип данных.

Взаимодействие с данными с помощью детализации

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

Снимок экрана: визуальный элемент панели мониторинга с детализацией.

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

Использование поиска по фильтру для фильтров с одиночным и множественным выбором

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

Использование параметров в панелях мониторинга Azure Data Explorer

Предварительные требования

Просмотр списка параметров