Расширенный редактор запросов: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Создана пустая страница)
 
Строка 1: Строка 1:
Чтобы в полной мере использовать возможности запросов '''''Metrics API v2''''' из веб-интерфейса Ключ-АСТРОМ, используйте Редактор запросов в '''расширенном режиме'''.


В '''расширенном режиме''' вы можете:
* Проверить и редактировать созданный вами запрос с помощью настроек веб-интерфейса Ключ-АСТРОМ (при выключенном расширенном режиме).
* Использовать '''''селекторы показателей''''' для применения преобразований, которые в ином случае невозможны. Например, сдвиги временных рамок.
* Использовать '''''выражения метрик''''' для создания простых арифметических операций с несколькими различными значениями метрик. Например, <code>metric A</code> + <code>metric B</code>.
* Работать с '''''селекторами объектов''''', чтобы применять более продвинутые фильтры к своим метрикам. Например, для фильтрации метрики узла Kubernetes для определенного кластера Kubernetes.
== Включить расширенный режим ==
Вы можете начать создавать простой запрос через веб-интерфейс, а затем включить '''расширенный режим''', чтобы просмотреть базовый запрос.
Например, если вы начнете выполнение этого запроса с выключенным '''расширенным режимом''':
[[Файл:Image12уйыа.png|граница]]
При включенном '''расширенным режимом''':
[[Файл:Расширенный режим.png|граница]]
Базовый код запроса отображается в том виде, в котором он передается в '''Metrics API v2''':
<code>builtin:host.cpu.usage:splitBy("dt.entity.host"):avg:auto:sort(value(avg,descending)):limit(20)</code>
== Отключение расширенного режима ==
Для простых запросов, в которых требуется одно из следующих преобразований, вы можете снова отключить расширенный режим:
* '''Разделить по''' измерениям метрики (если вы не добавили никаких дополнительных измерений с помощью селектора объектов в расширенном режиме)
* '''Фильтровать''', подключенный через связь OR
* '''Сортировать по'''
* '''Ограничение'''
Подробное описание отдельных преобразований см. в разделе '''''Селекторы метрик'''''.
Отключение расширенного режима возможно только в том случае, если преобразования, которые вы редактировали в расширенном режиме, были добавлены при выключенном расширенном режиме.
Например, если вы изначально применили преобразование сортировки при выключенном расширенном режиме, вы можете изменить порядок сортировки с <code>ascending</code> на <code>descending</code> при включенном расширенном режиме, а затем снова отключить расширенный режим. Однако после добавления новых частей в запрос — например, путем добавления преобразований, таких как сдвиг времени или выражения метрик, которые пока невозможны при выключенном расширенном режиме, — вы не сможете снова отключить расширенный режим и продолжить работу.
== Редактирование запроса ==
Основные функции редактора запросов одинаковы независимо от того, включен или выключен расширенный режим:
* Чтобы добавить показатель, выберите Добавить показатель, чтобы добавить строку (другой показатель) в запрос.
* Чтобы дублировать показатель, выберите Еще (...) > Дублировать в строке, чтобы дублировать эту строку (показатель).
* Чтобы удалить метрику, выберите Еще (...) > Удалить в строке, чтобы удалить эту строку (метрику).
* Чтобы изменить порядок показателей, выберите и перетащите показатель на новую позицию в списке показателей. Повторно запустите запрос, чтобы увидеть внесенные изменения. [[Файл:Image8з.png|граница]]<!-- Порядок, в котором показатели перечислены в вашем запросе, влияет на следующее:
Порядок отображения элементов чертежа: показатели запроса отображаются в порядке сверху вниз, поэтому последний из них отображается поверх остальных
Порядок столбцов в визуализации таблицы
Порядок отображения настроек на панели "Настройки" -->
* Чтобы попробовать выполнить запрос, выберите Выполнить запрос. Текст рядом с кнопкой Выполнить запрос отображает состояние последнего запуска.
Основное отличие заключается в способе редактирования запроса и количестве доступных возможностей:
* При отключенном расширенном режиме веб-интерфейс упрощает создание запроса из пунктов меню, но возможности запроса ограничены
* При включенном расширенном режиме возможности запроса намного шире, но вам нужно знать, как редактировать запрос

Версия 05:42, 28 июня 2024

Чтобы в полной мере использовать возможности запросов Metrics API v2 из веб-интерфейса Ключ-АСТРОМ, используйте Редактор запросов в расширенном режиме.

В расширенном режиме вы можете:

  • Проверить и редактировать созданный вами запрос с помощью настроек веб-интерфейса Ключ-АСТРОМ (при выключенном расширенном режиме).
  • Использовать селекторы показателей для применения преобразований, которые в ином случае невозможны. Например, сдвиги временных рамок.
  • Использовать выражения метрик для создания простых арифметических операций с несколькими различными значениями метрик. Например, metric A + metric B.
  • Работать с селекторами объектов, чтобы применять более продвинутые фильтры к своим метрикам. Например, для фильтрации метрики узла Kubernetes для определенного кластера Kubernetes.

Включить расширенный режим

Вы можете начать создавать простой запрос через веб-интерфейс, а затем включить расширенный режим, чтобы просмотреть базовый запрос.

Например, если вы начнете выполнение этого запроса с выключенным расширенным режимом:

Image12уйыа.png

При включенном расширенным режимом:

Расширенный режим.png

Базовый код запроса отображается в том виде, в котором он передается в Metrics API v2:

builtin:host.cpu.usage:splitBy("dt.entity.host"):avg:auto:sort(value(avg,descending)):limit(20)

Отключение расширенного режима

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

  • Разделить по измерениям метрики (если вы не добавили никаких дополнительных измерений с помощью селектора объектов в расширенном режиме)
  • Фильтровать, подключенный через связь OR
  • Сортировать по
  • Ограничение

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

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

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

Редактирование запроса

Основные функции редактора запросов одинаковы независимо от того, включен или выключен расширенный режим:

  • Чтобы добавить показатель, выберите Добавить показатель, чтобы добавить строку (другой показатель) в запрос.
  • Чтобы дублировать показатель, выберите Еще (...) > Дублировать в строке, чтобы дублировать эту строку (показатель).
  • Чтобы удалить метрику, выберите Еще (...) > Удалить в строке, чтобы удалить эту строку (метрику).
  • Чтобы изменить порядок показателей, выберите и перетащите показатель на новую позицию в списке показателей. Повторно запустите запрос, чтобы увидеть внесенные изменения. Image8з.png
  • Чтобы попробовать выполнить запрос, выберите Выполнить запрос. Текст рядом с кнопкой Выполнить запрос отображает состояние последнего запуска.

Основное отличие заключается в способе редактирования запроса и количестве доступных возможностей:

  • При отключенном расширенном режиме веб-интерфейс упрощает создание запроса из пунктов меню, но возможности запроса ограничены
  • При включенном расширенном режиме возможности запроса намного шире, но вам нужно знать, как редактировать запрос