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

Материал из Документация Ключ-АСТРОМ
Строка 38: Строка 38:


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


* Чтобы добавить показатель, выберите Добавить показатель, чтобы добавить строку (другой показатель) в запрос.
* Чтобы добавить показатель, выберите '''Добавить метрику''', чтобы добавить строку (другую метрику) в запрос.
* Чтобы дублировать показатель, выберите Еще (...) > Дублировать в строке, чтобы дублировать эту строку (показатель).
* Чтобы дублировать метрику, выберите '''Дополнительно (...) > Дублировать,''' чтобы дублировать эту строку (метрику).
* Чтобы удалить метрику, выберите Еще (...) > Удалить в строке, чтобы удалить эту строку (метрику).
* Чтобы удалить метрику, выберите '''Дополнительно (...) > Удалить''', чтобы удалить эту строку (метрику).
* Чтобы изменить порядок показателей, выберите и перетащите показатель на новую позицию в списке показателей. Повторно запустите запрос, чтобы увидеть внесенные изменения. [[Файл:Image8з.png|граница]]<!-- Порядок, в котором показатели перечислены в вашем запросе, влияет на следующее:
* Чтобы изменить порядок показателей, выберите и перетащите метрику на новую позицию в списке метрик. Повторно запустите запрос, чтобы увидеть внесенные изменения. [[Файл:Image8з.png|граница]] Порядок, в котором показатели перечислены в вашем запросе, влияет на следующее:
** Порядок отображения элементов визуализации: показатели запроса отображаются в порядке сверху вниз, поэтому последний из них отображается поверх остальных
** Порядок столбцов в визуализации таблицы
** Порядок отображения настроек на панели "'''Настройки'''"
* Чтобы попробовать выполнить запрос, нажмите '''Запуск запроса'''. Текст рядом с кнопкой '''Запуск запроса''' отображает состояние последнего запуска.


Порядок отображения элементов чертежа: показатели запроса отображаются в порядке сверху вниз, поэтому последний из них отображается поверх остальных
Основное отличие заключается в способе редактирования запроса и количестве доступных возможностей:
Порядок столбцов в визуализации таблицы
 
Порядок отображения настроек на панели "Настройки" -->
* При отключенном '''расширенном режиме''' веб-интерфейс упрощает создание запроса из пунктов меню, но возможности запроса ограничены
* Чтобы попробовать выполнить запрос, выберите Выполнить запрос. Текст рядом с кнопкой Выполнить запрос отображает состояние последнего запуска.
* При включенном '''расширенном режиме''' возможности запроса намного шире, но вам нужно знать, как редактировать запрос
 
=== Добавить метрику ===
Самый простой способ выбрать показатели для запроса - начать с выключенного '''расширенного режима'''.
 
# Вставьте указатель в строку и начните вводить название показателя. Перечислены соответствующие показатели.  Например, введите <code>cpu usage</code>, а затем выберите <code>builtin:host.cpu.usage</code> из списка.  [[Файл:Imageссмчм.png|граница]]
# Вы можете выбирать часто применяемые агрегированные данные, измерения и преобразования:
#* '''Разделить по''': выберите одно из перечисленных измерений для выбранной метрики
#* '''Агрегировать''': выберите <code>Average</code>, <code>Count</code> <code>Maximum</code>, <code>Minimum</code> <code>Sum</code>, <code>Median</code> <code>10-ый процентиль</code>, <code>75-ый процентиль</code> <code>90-ый процентиль</code>  Выбранная агрегация применяется после разделения на. Например, если вы выберете <code>10-ый процентиль</code> и разделите на <code>Host</code> для измерительной метрики, такой как <code>builtin:host.cpu.idle</code>, процентиль рассчитывается на основе значений после разделения по хостам.
#* '''Сортировать по''' возрастанию или убыванию
#* '''Фильтровать''': выбрать измерения и фильтрование атрибутов
#* '''Ограничение''': выберите предельное значение
# Включите '''расширенный режим'''.
# Редактируйте результаты по мере необходимости.
#* Копирование и вставка из одной строки в другую
#* Добавляйте, дублируйте и удаляйте строки по мере необходимости


Основное отличие заключается в способе редактирования запроса и количестве доступных возможностей:
Как добавить метрику в расширенном режиме
 
# Вставьте указатель в строку и начните вводить ключ показателя. Перечислены соответствующие показатели.  Например, введите <code>host.cpu</code>, а затем выберите <code>builtin:host.cpu.usage</code> из списка.  [[Файл:Image1ауф.png|граница]]
# Вам необходимо добавить все преобразования вручную.
 
=== Редактирование метрик ===
В окне редактирования:
 
* Введите двоеточие (<code>:</code>), чтобы указать, что можно добавить в точке вставки, а затем выберите из списка.
* Нажмите '''Shift-Enter''', чтобы принудительно ввести новую строку. Это может быть полезно для удобства чтения и не влияет на оценку запроса.
* Выберите показатель или число и нажмите '''(''' на клавиатуре, чтобы заключить выделенное значение в круглые скобки.
 
Подробнее о показателях
 
* Обзор показателей см. в разделе '''''[[Метрики]]'''''.
* Чтобы ознакомиться со списком встроенных метрик, см. раздел '''''[[Встроенные метрики]]'''''.
* Чтобы узнать о внедрении пользовательских метрик в Ключ-АСТРОМ, см. раздел '''''[[Пользовательские метрики]]'''''.
* Используйте раздел в Ключ-АСТРОМ '''Метрики''' для:
** Проверки сведений о метриках
** Открытия выбранной метрики в редакторе через кнопку '''Создать график'''
 
=== Операнды ===
Операнд - это метрика или число.


* При отключенном расширенном режиме веб-интерфейс упрощает создание запроса из пунктов меню, но возможности запроса ограничены
* Каждый операнд должен быть заключен в круглые скобки <code>()</code>. Вы также можете использовать квадратные скобки для обеспечения приоритета.
* При включенном расширенном режиме возможности запроса намного шире, но вам нужно знать, как редактировать запрос
* Все показатели с более чем 1 точкой данных, участвующие в выражении показателя, должны иметь одинаковое разрешение.
* В качестве операнда можно использовать любую метрику, включая метрики, измененные любой цепочкой преобразований, и вы можете применить преобразования к результату выражения см. в разделе '''''[[Выражение метрик]]'''''.

Версия 08:21, 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 Порядок, в котором показатели перечислены в вашем запросе, влияет на следующее:
    • Порядок отображения элементов визуализации: показатели запроса отображаются в порядке сверху вниз, поэтому последний из них отображается поверх остальных
    • Порядок столбцов в визуализации таблицы
    • Порядок отображения настроек на панели "Настройки"
  • Чтобы попробовать выполнить запрос, нажмите Запуск запроса. Текст рядом с кнопкой Запуск запроса отображает состояние последнего запуска.

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

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

Добавить метрику

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

  1. Вставьте указатель в строку и начните вводить название показателя. Перечислены соответствующие показатели. Например, введите cpu usage, а затем выберите builtin:host.cpu.usage из списка. Imageссмчм.png
  2. Вы можете выбирать часто применяемые агрегированные данные, измерения и преобразования:
    • Разделить по: выберите одно из перечисленных измерений для выбранной метрики
    • Агрегировать: выберите Average, Count Maximum, Minimum Sum, Median 10-ый процентиль, 75-ый процентиль 90-ый процентиль Выбранная агрегация применяется после разделения на. Например, если вы выберете 10-ый процентиль и разделите на Host для измерительной метрики, такой как builtin:host.cpu.idle, процентиль рассчитывается на основе значений после разделения по хостам.
    • Сортировать по возрастанию или убыванию
    • Фильтровать: выбрать измерения и фильтрование атрибутов
    • Ограничение: выберите предельное значение
  3. Включите расширенный режим.
  4. Редактируйте результаты по мере необходимости.
    • Копирование и вставка из одной строки в другую
    • Добавляйте, дублируйте и удаляйте строки по мере необходимости

Как добавить метрику в расширенном режиме

  1. Вставьте указатель в строку и начните вводить ключ показателя. Перечислены соответствующие показатели. Например, введите host.cpu, а затем выберите builtin:host.cpu.usage из списка. Image1ауф.png
  2. Вам необходимо добавить все преобразования вручную.

Редактирование метрик

В окне редактирования:

  • Введите двоеточие (:), чтобы указать, что можно добавить в точке вставки, а затем выберите из списка.
  • Нажмите Shift-Enter, чтобы принудительно ввести новую строку. Это может быть полезно для удобства чтения и не влияет на оценку запроса.
  • Выберите показатель или число и нажмите ( на клавиатуре, чтобы заключить выделенное значение в круглые скобки.

Подробнее о показателях

  • Обзор показателей см. в разделе Метрики.
  • Чтобы ознакомиться со списком встроенных метрик, см. раздел Встроенные метрики.
  • Чтобы узнать о внедрении пользовательских метрик в Ключ-АСТРОМ, см. раздел Пользовательские метрики.
  • Используйте раздел в Ключ-АСТРОМ Метрики для:
    • Проверки сведений о метриках
    • Открытия выбранной метрики в редакторе через кнопку Создать график

Операнды

Операнд - это метрика или число.

  • Каждый операнд должен быть заключен в круглые скобки (). Вы также можете использовать квадратные скобки для обеспечения приоритета.
  • Все показатели с более чем 1 точкой данных, участвующие в выражении показателя, должны иметь одинаковое разрешение.
  • В качестве операнда можно использовать любую метрику, включая метрики, измененные любой цепочкой преобразований, и вы можете применить преобразования к результату выражения см. в разделе Выражение метрик.