Мониторинг ключевых запросов

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

• Ключевые запросы имеют специальные метрики, которыми можно управлять через веб-интерфейс или API. Вы можете создавать отдельные дашборды для построения графиков ключевых запросов с прямым доступом с вашего дашборда и анализировать долгосрочную историю метрик ключевых запросов на графиках запросов.
• Оповещения всегда включены для ключевых запросов, даже если они составляют менее 1% от общей пропускной способности. Также предусмотрены настраиваемые пороговые значения.
• Сроки хранения ключевых запросов устанавливаются следующим образом:

Тип данных	Срок хранения
Подробные данные на уровне кода	10 дней
Агрегированные данные на уровне кода	35 дней
Долгосрочная история показателей	5 лет

Ключевые запросы выделены в разделе Ключевые запросы/конечные точки на странице обзора каждого сервиса. Такая наглядность особенно важна для запросов с небольшим объемом, но высоком приоритетом, которые в противном случае отображались бы внизу списка топа популярных запросов.

Количество ключевых запросов ограничено: 500 ключевых запросов на каждую среду во всех сервисах. 100 ключевых запросов на один сервис. Когда вы достигнете этого предела, рассмотрите возможность использования расчетных метрик обслуживания, которые предлагают более гибкий подход.

Создание ключевого запроса (через веб-интерфейс)

Чтобы пометить конкретный запрос как ключевой запрос

1. Перейдите в раздел Сервисы.
2. Выберите нужный сервис из списка.
3. На странице обзора сервиса выберите кнопку Дополнительно (...) в правом верхнем угу > Посмотреть все детали запроса.
4. Прокрутите вниз до раздела Топ запросов и выберите запрос, который хотите пометить как ключевой.
5. На странице обзора запросов выберите «Дополнительно» ( … ) > Отметить как ключевой запрос или Закрепить на дашборде.

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

Отображение ключевых запросов на дашборде

Создать плитку на дашборде для конкретного запроса.

1. Перейдите в раздел Сервисы.
2. Выберите нужный сервис из списка.
3. На странице обзора сервиса выберите кнопку Дополнительно (...) в правом верхнем угу > Посмотреть все детали запроса.
4. Прокрутите вниз до раздела Топ запросов и выберите запрос, который хотите пометить как ключевой.
5. На странице обзора запросов выберите «Дополнительно» ( … ) > Закрепить на дашборде.

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

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

Переименование ключевых запросов

Обнаружение ключевых запросов основано на их именах. Применение правила именования запросов может повлиять на ключевые запросы. Если вы хотите, чтобы Ключ-АСТРОМ продолжал обнаруживать переименованные запросы как ключевые, вам необходимо добавить новое имя в список имен ключевых запросов.

1. Перейдите в раздел Сервисы и выберите сервис, которую хотите настроить.
2. Выберите Дополнительно ( … ) > Настройки.
3. На странице настроек сервиса перейдите на вкладку Ключевые запросы и выберите Добавить элемент, чтобы добавить имя, к которому будут применяться правила именования запросов.

Обнаружение аномалий с помощью ключевых запросов

Ключ-АСТРОМ исходит из предположения, что запросы с малым объемом имеют меньшее значение, чем запросы с большим объемом и ключевые запросы. Это означает, что запросы, которые составляют менее 1% от общей нагрузки сервиса, не будут вызывать оповещения, если их влияние не является достаточно значительным, чтобы повлиять на общее время отклика сервиса или частоту сбоев. Поскольку такой подход по умолчанию не подходит для всех запросов с малым объемом, следует вручную помечать важные запросы с малым объемом как ключевые запросы, чтобы обеспечить установление для них стандартных пороговых значений оповещений.

Пороговые значения для оповещений, специфичные для каждого запроса

Поскольку некоторые запросы могут иметь специфические шаблоны времени ответа и частоты сбоев, а другие — строгие пороговые значения SLA, Ключ-АСТРОМ позволяет определять пользовательские пороговые значения оповещений при обнаружении аномалий, связанных с производительностью ключевых запросов. Если заданы пороговые значения на уровне ключевых запросов, они переопределяют пороговые значения на уровне сервиса.

Расчетная метрика сервиса

В качестве альтернативного способа сосредоточиться на конкретных запросах вы можете создать вычисляемую метрику сервиса, основанную на необходимых вам запросах. Такой подход обеспечивает большую гибкость в настройке оповещений — вы можете использовать вычисляемую метрику так же, как и любую встроенную метрику, предоставляемую Ключ-АСТРОМ.

Управление ключевыми запросами через API настроек

Вы можете управлять ключевыми конфигурациями запросов через API настроек .

Для использования API вам потребуется токен доступа с областями действия Чтение настроек (settings.read) и Запись настроек (settings.write). Чтобы узнать, как его получить, см. раздел Создание токена доступа.

Создание конфигурации ключевых запросов

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

1. Чтобы узнать формат объекта настроек, запросите его схему с помощью вызова GET a schema. Идентификатор ключа request schema — builtin:settings.subscriptions.service.
2. Создайте JSON-объект для ваших настроек.
   • Обратите внимание, что областью действия ключевого запроса всегда является сервис. Вы должны указать сервис по его идентификатору сущности Ключ-АСТРОМ. Чтобы узнать идентификатор сущности вашего сервиса, используйте запрос GET entities list.
3. Используйте конечную точку POST для отправки объекта, чтобы передать вашу конфигурацию.

Пример JSON
[   {     "schemaId": "builtin:settings.subscriptions.service",     "scope": "SERVICE-123456789",     "value": {       "keyRequestNames": [         "/cart/checkout"         ]       }   } ]

Обновление конфигурации ключевого запроса

1. Чтобы узнать формат объекта настроек, запросите его схему с помощью вызова GET a schema. Идентификатор ключа request schema — builtin:settings.subscriptions.service.
   • Обратите внимание, что областью действия ключевого щапроса всегда является сервис. Необходимо указать сервис по ее идентификатору сущности Ключ-АСТРОМ. Чтобы узнать идентификатор сущности вашей службы, используйте запрос GET entities list.
2. Запросите текущую конфигурацию с помощью вызова GET objects.
3. Создайте JSON-файл для обновления.
   1. Используйте значение updateToken из предыдущего шага.
   2. При необходимости измените список запросов в массиве keyRequestNames.
4. Используйте конечную точку PUT для отправки объекта и сохранения конфигурации.

Пример JSON
{   "updateToken": "vu9U3hXY3q0ATAAkMG",   "value": {     "keyRequestNames": [       "/cart/checkout",       "/cart"     ]   } }