12 показателей мониторинга, которые обеспечат успех вашей стратегии API

Команда китайского сообщества открытого исходного кода провела свою первую прямую трансляцию, рассказывая историю китайского сообщества открытого исходного кода во имя обмена».

Автор оригинала: Эндрю Стифел из F5

Исходная ссылка: 12 индикаторов мониторинга для обеспечения успешной стратегии API.

Источник перепечатки: сообщество открытого исходного кода NGINX.

Единственное официальное китайское сообщество NGINX, расположенное на nginx.org.cn.

Поскольку компании внедряют методы проектирования , ориентированные на API, для создания современных приложений, измерение эксплуатационных характеристик и ценности этих API становится обязательным. Создание структуры, которая четко определяет метрики API и связывает их с ключевыми показателями эффективности (KPI), является одним из наиболее важных шагов к обеспечению успешной стратегии API.

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

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

Грубо говоря, существует три широкие категории показателей API, которые компании могут отслеживать, и разные категории показателей отражают разные проблемы:

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

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

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

Индикаторы эксплуатации и технического обслуживания

На начальных этапах операционные показатели часто являются первыми показателями, которые необходимо измерить. Это тактические метрики, которые дают представление о том, как работает ваш API. Операционные показатели обычно не являются KPI. Но они могут помочь вам измерить качество и производительность программного обеспечения, которое создает ваша команда, и предоставить ранние индикаторы новых проблем или помочь вам детализировать и выявить проблемы, которые могут повлиять на ключевые показатели эффективности.

Вы можете отслеживать различные операционные показатели в зависимости от команды и ответственности.

Команда инфраструктуры

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

Ключевые показатели для инфраструктурных команд, таких как операции платформы, включают:

Время безотказной работы . Даже один из самых основных показателей, время безотказной работы является золотым стандартом измерения доступности услуг. Это часто связано с соглашением об уровне обслуживания (SLA).
Использование ЦП и памяти . Отслеживание использования ресурсов вашего шлюза API имеет решающее значение для определения того, когда вам может потребоваться масштабирование вашего экземпляра. Он также может служить индикатором раннего предупреждения о надвигающемся сбое или резком росте использования из-за ошибок.
Общий процент проходов и ошибок . Измерение того, как часто API вызывает код состояния ошибки HTTP (не 200), может помочь вам понять, насколько подвержен ошибкам ваш API. Этот составной показатель предоставляет информацию, которая поможет вам оценить общее качество API, которые ваша команда запускает в производство.

команда приложения

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

Команды приложений должны измерять следующие показатели:

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

См. главы 3–5 электронной книги O'Reilly «Освоение архитектуры API от NGINX» для более глубокого понимания операций API, а также ключевых показателей эффективности и показателей, которые имеют решающее значение для вашего бизнеса.

показатели внедрения

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

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

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

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

Показатели продукта

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

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

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

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

Пожалуйста, обратитесь к главам 3–5 «Освоение архитектуры API» для более глубокого понимания жизненного цикла продуктов API, включая ключевые показатели эффективности бизнеса и эксплуатации.

Заключение

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

NGINX позволяет визуализировать десятки важных индикаторов API. Вы можете просматривать метрики в реальном времени и исторические показатели и легко экспортировать их в предпочитаемое вами решение для мониторинга производительности приложений (или APM) или для анализа данных.

Единственное официальное китайское сообщество NGINX, расположенное на nginx.org.cn.

Дополнительная техническая информация о NGINX, интерактивные вопросы и ответы, серии курсов и ресурсы для мероприятий: Официальный сайт сообщества открытого исходного кода WeChat |