Настройка наименования запросов

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

Применение Ключ-АСТРОМ / Сервисы / Настройки / Настройка наименования запросов

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

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

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

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

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

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

  1. В меню Ключ-АСТРОМ перейдите в раздел « Службы » и выберите службу, которую хотите настроить.
  2. Выберите Еще ( … ) > Настройки .
  3. На странице настроек службы перейдите на вкладку Запросить правила именования и выберите Добавить правило .

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

Niz1.png

В приведенном выше примере определены три условия:

  • Путь URL должен содержать строкуorange-booking-payment
  • Запрос должен быть HTTP-методом типа GET .
  • Запрос должен иметь атрибутeasyTravel destination

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

Niz2.png

Глобальные правила именования запросов

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

Дополнительные элементы для именования запросов

Атрибуты запроса и заполнители

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

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

Пример: атрибуты запроса в шаблонах именования

Используя атрибут запроса easyTravel destinationв шаблоне именования, запрос варианта создается для каждого пункта назначения, забронированного клиентами easyTravel. В результате это правило больше не создает один тип запроса, теперь оно создает отдельный отслеживаемый запрос для каждого забронированного пункта назначения.

Niz3.png

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

Niz4.png

  • Заполнители могут извлекать значения из атрибутов запроса или URL-адресов.

Пример: Пользовательские заполнители

Если путь URL-адреса содержит строку orange-booking, бронирование, определенное заполнителем stage, извлекается из шаблона именования URL-адресов и записывается в верхнем регистре. Заполнитель stageопределяется как текст между URL-адресом orange-booking-и внутри него..jsf

Niz5.png

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

Niz6.png

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

Правила очистки

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

Доступ к настройкам службы > Именование веб-запросов позволяет:

  • Удалите UUID, IP-адреса и IBAN из URL-адресов. Нормализуйте пути URL-адресов, содержащие UUID, IP-адреса и IBAN. Это действие заменяет определенные значения статическими строками, связанными с содержимым, такими как UUID, IPv4и IBAN.
  • Создать правило чистого URL . Определите регулярные выражения для удаления частей пути URL-адреса службы веб-запросов, например идентификаторов.

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

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

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

Вы можете изменить правило именования запросов или объединить их, чтобы создать еще более подробные имена запросов. Preview Rule показывает выходные данные нового правила именования запросов.

Niz7.png

В приведенном выше примере новое правило Booking {RequestAttribute:easyTravel destination} - {stage}объединяет два предыдущих примера. Он определяет шаблон именования запросов, который включает не только этап резервирования ( {stage}), но и атрибут назначения ( {RequestAttribute:easyTravel destination}). Теперь мы получаем отдельный запрос для каждого этапа бронирования, а также дальнейшее разделение на основе атрибута пункта назначения.

Маскировка данных

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

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

Сервисный анализ

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

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

Многоуровневый анализ

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

Niz8.png

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

Теперь, когда мы смотрим на отдельную трассировку, мы видим, насколько полезны два определенных атрибута запроса. В этом примере мы видим, что это Booking Shizunaiбыло выполнено клиентом, имеющим PLATINUMстатус лояльности. Это было достигнуто за счет определения правила именования запросов в easyTravel Customer Frontendслужбе, которое отслеживает бронирования по направлениям, и отдельного правила именования запросов, которое отслеживает бронирования на серверной части BookingServiceTomна основе статуса лояльности.

Niz9.png

Многомерный анализ

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

Niz10.png

Niz11.png

Вы также можете использовать эту функцию в сочетании с мощной иерархической фильтрацией . В этом примере мы анализируем запросы на бронирование, находящиеся на finishстадии, с пунктом назначения shizunai, диапазоном времени ответа 1-2 секунды и статусом лояльности Platinum.

Niz12.png

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