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

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

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

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

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

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

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

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

   

Дополнительные сведения об этом шаге см. в разделе Мониторинг недавнего трафика API .

Шаг 2. Определите тенденции в данных мониторинга API.

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

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

Дополнительные сведения об этом шаге см. в разделе Определение тенденций в данных мониторинга API .

Шаг 3. Изучите проблемы 5xx

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

Чтобы исследовать проблемы 5xx:

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

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 Alert.

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

   

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

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

   

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

   and (developer_app eq 'perfBenchmarkApp0')

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

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

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

Дополнительные сведения об этом шаге см. в разделе Создание пользовательских отчетов .

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

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

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

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

Дополнительные сведения об этом шаге см. в разделе Управление коллекциями .

Шаг 7. Решите проблемы 5xx

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

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

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

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

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

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

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

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

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

   

Дополнительные сведения об этом шаге см. в разделе Мониторинг недавнего трафика API .

Шаг 2. Определите тенденции в данных мониторинга API.

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

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

Дополнительные сведения об этом шаге см. в разделе Определение тенденций в данных мониторинга API .

Шаг 3. Изучите проблемы 5xx

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

Чтобы исследовать проблемы 5xx:

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

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 Alert.

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

   

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

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

   

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

   and (developer_app eq 'perfBenchmarkApp0')

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

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

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

Дополнительные сведения об этом шаге см. в разделе Создание пользовательских отчетов .

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

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

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

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

Дополнительные сведения об этом шаге см. в разделе Управление коллекциями .

Шаг 7. Решите проблемы 5xx

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

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