Обзор API-аналитики

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

В этой теме представлен обзор аналитики Edge API.

Улучшите свой API с помощью аналитики.

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

Аналитика помогает ответить на распространенные вопросы, такие как:

• Как меняется трафик моего API с течением времени?
• Какие методы API наиболее популярны?
• Кто мои лучшие разработчики?
• Когда время ответа API самое быстрое? Самое медленное?
• С географической точки зрения, где я наблюдаю наибольший трафик API?

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

API Analytics помогает всем улучшить

Благодаря непрерывному процессу сбора, анализа и визуализации данных, Edge API Analytics помогает вашей команде разработчиков API улучшать свои API, а разработчикам приложений — улучшать свои приложения:

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

Какие данные собираются и анализируются?

Edge API Analytics собирает и анализирует широкий спектр данных, передаваемых через API-прокси, таких как:

• Время отклика
• Задержка запроса
• Размер запроса
• Целевые ошибки
• Название продукта API
• Адрес электронной почты разработчика
• Название приложения
• Многие другие

Полный список данных, собираемых API Analytics, см. в справочнике по метрикам, параметрам и фильтрам Analytics .

Как мне собирать пользовательские аналитические данные?

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

Сбор пользовательских аналитических данных осуществляется с помощью политики StatisticsCollector . После извлечения пользовательских данных вы можете использовать пользовательский интерфейс аналитики или API для их изучения. Полный пример сбора пользовательских аналитических данных см. в разделе «Анализ содержимого сообщений API с помощью пользовательской аналитики» .

Различия между аналитическими данными и данными мониторинга API.

Когда и на какой срок становятся доступны мои аналитические данные?

Существуют два временных интервала, которые определяют, когда и как долго вы можете просматривать свои аналитические данные:

• Интервал задержки данных — после обращения к API-прокси может потребоваться до 10 минут, прежде чем данные станут доступны для отображения или для вызовов API управления.
• Срок хранения данных — продолжительность хранения аналитических данных зависит от вашего тарифного плана подписки:
  • Стандартный срок : 30 дней
  • Предприятие : 3 месяца
  • Enterprise Plus : 14 месяцев
  Дополнительную информацию о ценах на Apigee API Management см. в соответствующем разделе.

Как мне получить доступ к своим аналитическим данным?

Edge API Analytics предоставляет инструменты визуализации данных, встроенные в пользовательский интерфейс Edge. Эти инструменты включают в себя предопределенные аналитические панели и пользовательские отчеты, которые отображают данные в виде графиков и диаграмм и позволяют детализировать данные, сгруппированные по различным параметрам (например, по API-прокси, IP-адресу или коду состояния HTTP).

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

Панели мониторинга аналитики

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

Эта панель мониторинга включает диаграммы для:

• Общий трафик — общее количество запросов API, полученных Edge для среды API в организации.
• Успешность запросов — общее количество запросов, завершившихся успешным ответом. Ответы с ошибками не учитываются.
• Ошибки трафика — общее количество всех неудачных запросов к API, то есть запросов, не получивших ответа. В подсчет включаются как ошибки прокси (на стороне Apigee), так и ошибки целевого сервера (бэкэнд-сервисы).
• Среднее количество запросов в секунду (TPS) — среднее число запросов к API и полученных ответов в секунду.

В число дополнительных предопределенных панелей мониторинга входят:

• Производительность кэша
• вовлеченность разработчиков
• Использование устройства
• Анализ кодов ошибок
• Геокарта
• Анализ задержки
• Целевая производительность
• состав транспортного потока

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

Пользовательские отчеты

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

При создании пользовательского отчета вы выбираете данные, которые хотите увидеть (метрики), группируете данные осмысленным образом (измерения) и, при необходимости, ограничиваете возвращаемые данные на основе определенных характеристик данных (фильтрация).

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

• Столбец — Каждый API-прокси представлен отдельным столбцом:

  

• Строка — Каждый API-прокси представлен отдельной строкой:

  

Дополнительную информацию см. в разделе «Создание и управление пользовательскими отчетами» .

API аналитики

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

Вот пример вызова API для получения аналитических данных для API-прокси:

curl  https://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \
-u email:password

В результате выполнения этого вызова возвращается:

• Сумма запросов (количество сообщений) на каждый API-прокси
• В течение 24 часов
• Сгруппировано по часам

Параметр запроса timeRange задает период времени в следующем формате:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

Обратите внимание на %20 перед HH:MM . Параметр timeRange требует наличия закодированного в URL-формате пробела перед HH:MM или символа + , например: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM .

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

Экспорт аналитических данных в Google Cloud

Вы можете использовать API управления Edge для экспорта всех аналитических данных за целый день из Edge в собственное хранилище данных, например, Google Cloud Storage или BigQuery . Затем вы можете воспользоваться мощными возможностями запросов и машинного обучения, предлагаемыми Google Cloud BigQuery и TensorFlow, для проведения собственного анализа данных.

Для получения более подробной информации см. раздел «Экспорт данных из аналитических инструментов» .

Как мне поделиться данными с разработчиками приложений?

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

Разработчиков приложений волнует не только качество их приложений, но и API. Порталы для разработчиков на базе Drupal включают дополнительную страницу «Производительность приложения» , предназначенную для предоставления разработчикам приложений доступа к важным метрикам их приложений. Эта страница предоставляет разработчикам информацию о:

• Ошибки: Какие ошибки API наблюдаются в моем приложении?
• Производительность: Медленно ли работает API в данный момент? Какие методы API обычно работают медленно или работают медленно в данный момент?
• Доступность: API в данный момент работает или не работает?
• Квота: Есть ли у вашего API квота? И как разработчик приложения, насколько хорошо я справляюсь с выполнением квоты?

Для получения более подробной информации см.:

• Drupal 7 : Отображение аналитики использования приложения
• Drupal 8 : Мониторинг приложений
• Встроенный портал : недоступен

Кроме того, вы можете делиться аналитическими данными со своими разработчиками следующим образом:

• Создание пользовательских отчетов и их предоставление разработчикам вашего приложения. Дополнительную информацию см. в разделе «Создание пользовательских отчетов» .
• Использование API управления Edge позволяет собирать данные за более длительный период времени для обмена ими с разработчиками приложений в автономном режиме. Дополнительную информацию см. в разделе «Использование API метрик для измерения производительности программ API» .

Как мне получить полные аналитические данные?

Что мы подразумеваем под полной аналитикой? Например, вы можете создать API-прокси, и Edge будет собирать аналитические данные об этом прокси. Но как насчет метрик для разработчика или приложения, которые обращались к API-прокси? Если Edge не знает, кто совершил вызов API, он не сможет собрать эти данные.

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

1. Создайте один или несколько продуктов API , представляющих собой группу прокси-серверов API вместе с тарифным планом. См. раздел «Управление продуктами API» .
2. Зарегистрируйте разработчиков приложений в Edge. См. раздел «Регистрация разработчиков приложений» .
3. Регистрируйте приложения и генерируйте ключи API для ваших разработчиков. См. раздел «Регистрация приложений и управление ключами API» .
4. Добавьте в свои API-прокси политики безопасности , которые проверяют ключи API и/или токены безопасности. См. следующие разделы: Политика проверки ключа API , Политика OAuthV2 и Политика проверки JWT .
5. Если вы используете Edge Microgateway , убедитесь, что у вас включен плагин аналитики (он включен по умолчанию). Если плагин аналитики отключен, Edge Microgateway не будет отправлять аналитические данные в Edge Analytics.

Следующие руководства помогут вам выполнить необходимые шаги для просмотра аналитики для разработчиков и приложений: Защита API с помощью ключей API и Защита API с помощью OAuth .

Сравните аналитику API и мониторинг API.

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

Одно из главных отличий мониторинга API от аналитики API заключается в механизме оповещений, встроенном в мониторинг API. В случае оповещений вы указываете пороговое значение кода состояния HTTP (2xx/4xx/5xx), задержки или кода ошибки, превышение которого запускает уведомление для вашей оперативной группы. Уведомления могут отправляться по различным каналам, таким как электронная почта, Slack, пейджеры или веб-хуки, что позволяет немедленно реагировать на проблемы.

Более подробное сравнение этих сервисов см. в разделе «Сравнение мониторинга API с Edge API Analytics» .

Более подробная информация

• Использование аналитических панелей мониторинга
• Создавайте и управляйте пользовательскими отчетами.
• Используйте API метрик.
• Анализ содержимого сообщений API с помощью пользовательской аналитики.