Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
В этом разделе сравнивается мониторинг API с Edge Analytics . Хотя и API-мониторинг, и Edge Analytics позволяют собирать и просматривать данные API, они преследуют разные цели:
- Цель мониторинга API — убедиться, что ваши API работают должным образом. Для этого вам необходимо просмотреть самые последние доступные данные. Мониторинг API предоставляет данные, очень близкие к реальному времени, и позволяет создавать оповещения, которые уведомляют вас в случае возникновения проблемы.
- Цель Edge Analytics — понять долгосрочное поведение ваших API, чтобы вы могли убедиться, что они поддерживают ваши бизнес-требования, или внести изменения при необходимости. Для этих целей менее критично видеть данные в реальном времени. Следовательно, данные Analytics немного задерживаются, хотя обычно не более чем на 10 минут.
Обратите внимание, что данные мониторинга API, которые в основном связаны с кодами ошибок и задержкой, представляют собой небольшую часть данных Analytics.
Различия между данными мониторинга API и данными аналитики
В этом разделе описаны некоторые незначительные различия между данными, собранными Edge Analytics, и данными мониторинга API. Поскольку API Monitoring и Analytics используют разные конвейеры данных, вы можете увидеть незначительные различия между пользовательскими отчетами, созданными Monitoring, и отчетами, созданными Analytics. Например, вы можете увидеть расхождения в сообщаемых результатах для ошибок тайм-аута — как тайм-аутов серверной части (код состояния HTTP 504 в запросе), так и тайм-аутов клиента (код состояния HTTP 499). Они могут отображаться с кодом состояния 200 в пользовательских отчетах Analytics, но будут отображаться с кодом состояния 504 или 499 в пользовательских отчетах мониторинга.API-мониторинг
Мониторинг API предоставляет информацию о производительности API в режиме реального времени и помогает быстро диагностировать и устранять проблемы, чтобы ваши API работали должным образом.
Мониторинг API позволяет вам:
- Повысьте доступность API и сократите среднее время диагностики (MTTD).
- Принимайте соответствующие меры на основе контекстных предупреждений до того, как это повлияет на потребителей.
- Используйте коды неисправностей Apigee для ускорения диагностики.
- Быстро изолируйте проблемные области, чтобы диагностировать ошибки, проблемы с производительностью и задержкой, а также их источники.
Аналитика Edge API
Edge API Analytics собирает и анализирует информацию, передаваемую через API. API Analytics собирает такую информацию, как:
- Как ваш трафик API меняется с течением времени
- Какие у вас лучшие приложения
- Кто ваши лучшие разработчики
- Какие методы API наиболее популярны
- Когда время ответа API самое быстрое/медленное
- Географически, где вы видите больше всего трафика API
Данные, собранные API Analytics
API Analytics собирает и анализирует широкий спектр данных, передаваемых через API. Например, пока ваш API развернут, Analytics постоянно записывает количество полученных сообщений, количество разработчиков, время ответа, ошибки, количество используемых приложений, размер запроса и многие другие данные.
Хорошее введение в метрики и способы их использования см. в разделе Использование API-интерфейсов метрик для измерения производительности программ API . Полный список показателей см. в Справочнике по метрикам, параметрам и фильтрам Google Analytics .
Собирайте специальные показатели
Вы также можете собирать пользовательские метрики с помощью политики СтатистикаКоллектор . Политика СтатистикаКоллектор может записывать информацию из заголовков запросов, полезных данных XML/JSON, параметров запроса, URI и других мест на сервер аналитики для анализа и создания отчетов.
Доступ к данным аналитики
После создания вы можете получить доступ к предопределенным и пользовательским метрикам с помощью инструментов визуализации API Analytics, включая панель мониторинга, пользовательские отчеты и GeoMap. Дополнительную информацию об инструментах визуализации, предоставляемых API Analytics, см. в разделе Панели мониторинга Analytics . Дополнительную информацию о настраиваемых отчетах см. в разделе Создание настраиваемых отчетов .
Сравните мониторинг API и аналитику API
Разработчики API используют как мониторинг API, так и аналитику API. Одним из основных различий между ними является механизм оповещений, встроенный в мониторинг API. Оповещения позволяют вашей операционной команде реагировать на проблемы с вашими API в режиме реального времени, чтобы гарантировать, что ваши API доступны и работают должным образом.
Условия оповещения определяют конкретные коды состояния (2xx/4xx/5xx), задержку и пороговые значения кодов ошибок, которые при превышении вызывают визуальные оповещения в пользовательском интерфейсе и отправляют уведомления по различным каналам, таким как электронная почта, Slack, Pagerduty или веб-перехватчики. Вы можете настроить оповещения на уровне среды, прокси-сервера API, целевой службы или региона.
После срабатывания оповещения ваша операционная группа может использовать пользовательский интерфейс мониторинга API для изучения проблемы и выяснения ее основной причины. Затем вы можете создать собственный отчет, включающий предопределенную информацию о предупреждении, например:
- Общее время ответа
- Целевое время отклика
- Ошибки прокси
- Целевые ошибки
- Запрос UUID
- еще много
API Analytics предназначен для сбора широкого спектра данных для использования несколькими командами. Например:
- Операционная группа может использовать данные Analytics для определения периодов высокого или низкого трафика, чтобы они могли масштабировать или сокращать ваши услуги в соответствии с меняющимися потребностями.
- Маркетинговая команда может использовать данные Analytics для определения моделей использования клиентов, определяемых отдельными API, приложениями, клиентами или другими данными.
- Все команды могут получить доступ к пользовательским данным, собранным из запроса, для отслеживания конкретной информации, такой как значения заголовков, параметры запроса или полезные данные запроса.
Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
В этом разделе сравнивается мониторинг API с Edge Analytics . Хотя и API-мониторинг, и Edge Analytics позволяют собирать и просматривать данные API, они преследуют разные цели:
- Цель мониторинга API — убедиться, что ваши API работают должным образом. Для этого вам нужно просмотреть самые последние доступные данные. Мониторинг API предоставляет данные, очень близкие к реальному времени, и позволяет создавать оповещения, которые уведомляют вас в случае возникновения проблемы.
- Цель Edge Analytics — понять долгосрочное поведение ваших API, чтобы вы могли убедиться, что они поддерживают ваши бизнес-требования, или внести изменения при необходимости. Для этих целей менее критично видеть данные в реальном времени. Следовательно, данные Analytics немного задерживаются, хотя обычно не более чем на 10 минут.
Обратите внимание, что данные мониторинга API, которые в основном связаны с кодами ошибок и задержкой, представляют собой небольшую часть данных Analytics.
Различия между данными мониторинга API и данными аналитики
В этом разделе описаны некоторые незначительные различия между данными, собранными Edge Analytics, и данными мониторинга API. Поскольку API Monitoring и Analytics используют разные конвейеры данных, вы можете увидеть незначительные различия между пользовательскими отчетами, созданными Monitoring, и отчетами, созданными Analytics. Например, вы можете увидеть расхождения в сообщаемых результатах для ошибок тайм-аута — как тайм-аутов серверной части (код состояния HTTP 504 в запросе), так и тайм-аутов клиента (код состояния HTTP 499). Они могут отображаться с кодом состояния 200 в пользовательских отчетах Analytics, но будут отображаться с кодом состояния 504 или 499 в пользовательских отчетах мониторинга.API-мониторинг
Мониторинг API предоставляет информацию о производительности API в режиме реального времени и помогает быстро диагностировать и устранять проблемы, чтобы ваши API работали должным образом.
Мониторинг API позволяет вам:
- Повысьте доступность API и сократите среднее время диагностики (MTTD).
- Принимайте соответствующие меры на основе контекстных предупреждений до того, как это повлияет на потребителей.
- Используйте коды неисправностей Apigee для ускорения диагностики.
- Быстро изолируйте проблемные области, чтобы диагностировать ошибки, проблемы с производительностью и задержкой, а также их источники.
Аналитика Edge API
Edge API Analytics собирает и анализирует информацию, передаваемую через API. API Analytics собирает такую информацию, как:
- Как ваш трафик API меняется с течением времени
- Какие у вас лучшие приложения
- Кто ваши лучшие разработчики
- Какие методы API наиболее популярны
- Когда время ответа API самое быстрое/медленное
- Географически, где вы видите больше всего трафика API
Данные, собранные API Analytics
API Analytics собирает и анализирует широкий спектр данных, передаваемых через API. Например, пока ваш API развернут, Analytics постоянно записывает количество полученных сообщений, количество разработчиков, время ответа, ошибки, количество используемых приложений, размер запроса и многие другие данные.
Хорошее введение в метрики и способы их использования см. в разделе Использование API метрик для измерения производительности программ API . Полный список показателей см. в Справочнике по метрикам, параметрам и фильтрам Google Analytics .
Собирайте специальные показатели
Вы также можете собирать пользовательские метрики с помощью политики СтатистикаКоллектор . Политика СтатистикаКоллектор может записывать информацию из заголовков запросов, полезных данных XML/JSON, параметров запроса, URI и других мест на сервер аналитики для анализа и создания отчетов.
Доступ к данным аналитики
После создания вы можете получить доступ к предопределенным и пользовательским метрикам с помощью инструментов визуализации API Analytics, включая панель мониторинга, пользовательские отчеты и GeoMap. Дополнительную информацию об инструментах визуализации, предоставляемых API Analytics, см. в разделе Панели мониторинга Analytics . Дополнительную информацию о настраиваемых отчетах см. в разделе Создание настраиваемых отчетов .
Сравните мониторинг API и аналитику API
Разработчики API используют как мониторинг API, так и аналитику API. Одним из основных различий между ними является механизм оповещений, встроенный в мониторинг API. Оповещения позволяют вашей операционной команде реагировать на проблемы с вашими API в режиме реального времени, чтобы гарантировать, что ваши API доступны и работают должным образом.
Условия оповещения определяют конкретные коды состояния (2xx/4xx/5xx), задержку и пороговые значения кодов ошибок, которые при превышении вызывают визуальные оповещения в пользовательском интерфейсе и отправляют уведомления по различным каналам, таким как электронная почта, Slack, Pagerduty или веб-перехватчики. Вы можете настроить оповещения на уровне среды, прокси-сервера API, целевой службы или региона.
После срабатывания оповещения ваша операционная группа может использовать пользовательский интерфейс мониторинга API для изучения проблемы и выяснения ее основной причины. Затем вы можете создать собственный отчет, включающий предопределенную информацию о предупреждении, например:
- Общее время ответа
- Целевое время отклика
- Ошибки прокси
- Целевые ошибки
- Запрос UUID
- еще много
API Analytics предназначен для сбора широкого спектра данных для использования несколькими командами. Например:
- Операционная группа может использовать данные Analytics для определения периодов высокого или низкого трафика, чтобы они могли масштабировать или сокращать ваши услуги в соответствии с меняющимися потребностями.
- Маркетинговая команда может использовать данные Analytics для определения моделей использования клиентов, определяемых отдельными API, приложениями, клиентами или другими данными.
- Все команды могут получить доступ к пользовательским данным, собранным из запроса, для отслеживания конкретной информации, такой как значения заголовков, параметры запроса или полезные данные запроса.