Опубликовано в Профессии

Как искать причину медленного API: план первых измерений

Фигурка через лупу рассматривает синий шар у узкого горлышка прозрачной воронки, заполненной шарами.

Время чтения: 5 мин.

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

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

Зафиксируй запрос и условия опыта

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

Повтори один и тот же запрос несколько раз, затем измени только один параметр. Например, сравни первую и глубокую страницу списка. Если одновременно меняются пользователь, фильтр, объём базы и число параллельных клиентов, разница времени не поможет выбрать причину.

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

В результате должна появиться короткая карточка опыта: запрос, условия, ожидаемый объём и способ измерения. Она пригодится для сравнения после исправления и для передачи задачи другому разработчику. Без неё легко сравнить разные случаи и объявить случайное ускорение результатом изменения.

Рука держит песочные часы рядом с синим шаром в составном наклонном желобе.

Разложи один запрос на наблюдаемые этапы

Добавь измерения вокруг существенных операций: ожидание соединения базы, SQL, внешний запрос, преобразование результата и формирование ответа. Назови операции так, чтобы по ним можно было понять действие. Десятки одинаковых событий «работа начата» почти не помогают.

OpenTelemetry описывает span как отдельную операцию внутри трассировки. Связанные spans позволяют посмотреть вложенные этапы одного запроса. Для первого исследования можно начать и с более простых измерений времени, если они имеют понятные границы и общий идентификатор.

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

Проверь, что наблюдение не создаёт собственную проблему. Запись полного тела ответа в журнал увеличивает объём работы и может раскрыть данные. Для исследования обычно полезнее размер ответа, число элементов, название операции и безопасный идентификатор запроса.

Отличи отдельный медленный случай от изменения распределения

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

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

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

Также фиксируй условия параллельной нагрузки. Один запрос в пустом окружении и тот же запрос в очереди за другими работами проверяют разные свойства. Для первых измерений достаточно небольшого контролируемого опыта, а не попытки сразу воспроизвести всю production-нагрузку.

Проверь SQL на соответствующих данных

Если время уходит в базу, сохрани конкретный запрос и безопасные значения параметров. Посмотри план, объём возвращаемых строк и операции сортировки. Добавлять индекс по названию медленного поля без изучения запроса недостаточно.

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

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

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

Рука держит синий шар сбоку узкого горлышка воронки, а прозрачные шары выпадают снизу.

Измени одну проверяемую причину

Сформулируй гипотезу так, чтобы она могла не подтвердиться. Например: «Для каждого заказа выполняется отдельный запрос клиента, поэтому число запросов растёт вместе с размером страницы». Теперь можно посчитать обращения и сравнить небольшую и большую страницу.

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

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

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

Сохрани результат как воспроизводимый разбор

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

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

Если причина остаётся неясной, на совместный разбор принеси карточку опыта и один trace вместо фразы «API тормозит». Ментор сможет проверить ход исследования и предложить следующее измерение. У тебя при этом останется материал, который можно повторить и сравнить после любого изменения.

Разбери измерения своего API

Принеси воспроизводимый запрос, условия опыта и один trace. Выбери backend-ментора, с которым можно проверить ход исследования и следующее измерение.

Выбрать ментора