Пройдите пример сценария

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Рассмотрим пример сценария, демонстрирующий, как устранять проблемы с ошибками 5xx в ваших API.

Шаг 1: Отслеживание недавнего трафика API

Чтобы просмотреть данные мониторинга API для прокси-серверов и целевых объектов API, по которым осуществлялся трафик в течение последнего часа:

1. Чтобы получить доступ к панели мониторинга «Недавние», выберите в пользовательском интерфейсе Edge пункт «Анализировать» > «Мониторинг API» > «Недавние» .

2. Обратите внимание на API-прокси и целевые объекты, которые показали высокий процент ошибок за последний час.
   

3. Щелкните по API-прокси или целевому объекту с высоким процентом ошибок, чтобы просмотреть подробности в правой панели. Обратите внимание на высокий процент ошибок 5xx в этом примере.

   

Для получения более подробной информации об этом шаге см. раздел «Мониторинг недавнего трафика API» .

Шаг 2: Выявите тенденции в данных мониторинга вашего API.

Чтобы получить доступ к историческому обзору данных мониторинга API для прокси-серверов и целевых объектов, по которым осуществлялся трафик за последние три месяца:

1. В правой панели панели «Недавние» выберите > Чтобы получить доступ к панели мониторинга «Хронология», нажмите «Просмотреть в режиме временной шкалы» . В качестве альтернативы, вы можете нажать «Анализировать» > «Мониторинг API» > «Хронология» в пользовательском интерфейсе Edge.
   
2. Просмотрите динамику изменения параметров API-прокси или целевого объекта с течением времени. Обратите внимание, что тенденция остается стабильной на протяжении последних 7 дней.

Для получения более подробной информации об этом шаге см. раздел «Выявление тенденций в данных мониторинга API» .

Шаг 3: Расследование проблем, связанных с кодом 5xx.

Apigee предоставляет набор кодов неисправностей , которые помогают диагностировать проблемы. Как правило, коды состояния 5xx можно классифицировать с помощью одного или нескольких кодов неисправностей.

Для расследования проблем, связанных с кодом 5xx:

1. В правой панели панели мониторинга «Хронология» выберите > Чтобы получить доступ к панели мониторинга Investigate, перейдите в меню «Просмотреть в Investigate» . Также вы можете нажать «Анализировать» > «Мониторинг API» > «Исследовать» в пользовательском интерфейсе Edge.
   
   Панель мониторинга Investigate позволяет сравнивать взаимосвязь между показателями, например, код ошибки в зависимости от времени.

2. Просмотрите матрицу кодов неисправностей в зависимости от времени , чтобы увидеть активность кодов неисправностей за последний час. Обратите внимание на коды неисправностей с наибольшим относительным объемом, определяемым по цветовой гамме блока. Чем темнее блок, тем выше относительный объем.

   Например, коды ошибок policies.ratelimit.SpikeArrestViolation и policies.ratelimit.QuotaViolation показывают более высокий относительный объем в следующей матрице:

3. Щелкните по самому темному блоку (первому блоку) в строке policies.ratelimit.SpikeArrestViolation , чтобы просмотреть более подробную информацию в правой панели.
   

4. Обратите внимание, что источником ошибки является прокси-сервер API perfBenchmark_invalid_v1 , а код состояния HTTP равен 500. Код состояния 500 — это распространенный код ошибки времени выполнения, указывающий на нарушения политики Spike Arrest.

5. Чтобы определить приложения разработчиков с самым высоким уровнем ошибок, просмотрите раздел «Распределение по приложениям разработчиков» чуть ниже панели «Предполагаемая причина».
   

Для получения более подробной информации об этом шаге см. раздел «Выявление проблем» .

Шаг 4: Настройка оповещения 5xx

Настройте оповещение на основе выбранного контекста в панели сведений об расследовании, чтобы получать уведомления, когда количество кодов состояния 5xx превысит определенный порог.

1. В правой панели панели мониторинга «Расследование» выберите > Создать оповещение .

2. Заполните поля в диалоговом окне предупреждения. Поля условия предварительно заполняются данными из текущего контекста. Например:

   

3. Нажмите « Сохранить ».

В будущем, если частота ошибок 5xx превысит 5% в течение 5 минут для прокси-сервера API perfBenchmark_invalid_v1 , уведомление будет отправлено на указанный адрес электронной почты, а в пользовательском интерфейсе отобразится визуальное предупреждение . Например:

Для получения более подробной информации об этом шаге см. раздел «Настройка оповещений и уведомлений» .

Шаг 5: Создайте пользовательский отчет с данными о клиенте (необязательно)

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

На странице «Отчеты» пользовательские отчеты, создаваемые на основе оповещения, именуются в следующем формате: API Monitoring Generated: alert-name .

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

   • Чтобы открыть страницу «Отчеты», выберите в левой панели навигации «Анализ» > «Пользовательские отчеты» > «Отчеты» . Щелкните название отчета в списке: «Мониторинг API: сгенерировано оповещение 5xx».

   • Щелкните внутри уведомления, которое отображается при создании оповещения. Например:

   

2. Добавьте следующие размеры:

   • Приложение для разработчиков
   • Идентификатор клиента
   • IP-адрес клиента

   

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

   and (developer_app eq 'perfBenchmarkApp0')

   Примечание : В этом случае удалите приложение разработчика из списка параметров.

4. Нажмите « Сохранить ».

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

Для получения более подробной информации об этом шаге см. раздел «Создание пользовательских отчетов» .

Шаг 6: Сгруппируйте API-прокси в коллекцию.

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

1. Чтобы отобразить панель мониторинга коллекций, выберите в пользовательском интерфейсе Edge пункт «Анализ» > «Мониторинг API» > «Коллекции» .
2. Click + Коллекция .
3. Выберите прокси .
4. Выберите продукт из выпадающего списка «Окружение».
5. Нажмите «Далее» .
6. Заполните поля в диалоговом окне выбора коллекции.
   
7. Нажмите «Сохранить».

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

Для получения более подробной информации об этом шаге см. раздел «Управление коллекциями» .

Шаг 7: Устранение проблем с кодом 5xx

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

• Используйте Apigee Sense , чтобы определить, является ли всплеск запросов подозрительным, и решить, хотите ли вы заблокировать IP-адрес клиента, указанный в пользовательском отчете.
• Добавьте политику квот , чтобы ограничить количество подключений, которые приложения разработчиков могут устанавливать к вашему API-прокси за определенный период времени.
• Монетизируйте свой API , взимая плату с разработчиков за использование, превышающее определенное количество вызовов.