Мониторинг в API Gateway
API Gateway собирает метрики шлюза и отправляет их в сервис Мониторинг, где можно самостоятельно настраивать необходимые дашборды и виджеты. Подробное описание и инструкции по настройке смотрите в руководстве пользователя по Мониторингу.
Просмотр графиков в сервисе Мониторинг
Чтобы перейти на дашборд API Gateway в сервисе Мониторинг:
Нажмите
и выберите Мониторинг.Внизу страницы в списке Сервисные дашборды выберите API Gateway.
В дашборде API Gateway доступны следующие графики:
Общее среднее время выполнения запросов, мс — сумма среднего времени выполнения запросов к API-шлюзу и среднего времени выполнения запросов к бэкенду.
Среднее время выполнения запросов к API-шлюзу, мс — время, которое затратил шлюз на обработку запросов от клиента.
Среднее время выполнения запросов к бэкенду, мс — время, которое затратил бэкенд на обработку запросов от клиента.
Средний размер ответа, байт — размер ответа от бэкенда в байтах.
Средний размер запроса, байт — размер запроса от клиента в байтах.
Количество запросов к бэкенду в минуту — запросы от клиента к бэкенду в минуту.
Количество запросов в минуту с кодом ответа 2хх — запросы от клиента к бэкенду, на которые бэкенд ответил кодом 2хх.
Количество запросов в минуту с кодом ответа 3хх — запросы от клиента к бэкенду, на которые бэкенд ответил кодом 3хх.
Количество запросов в минуту с кодом ответа 4хх — запросы от клиента к бэкенду, на которые бэкенд ответил кодом 4хх.
Количество запросов в минуту с кодом ответа 5хх — запросы от клиента к бэкенду, на которые бэкенд ответил кодом 5хх.
Просмотр графиков в API Gateway
Графики доступны для просмотра в сервисе API Gateway.
Чтобы отслеживать общую статистику запросов к вашим сервисам через API-шлюз, выберите шлюз и перейдите на вкладку Мониторинг.
Вы можете выбрать период сбора данных и интервал обновления графиков. По умолчанию графики отображают данные за последние два часа и обновляются каждые 30 секунд.
Метрики и лейблы
Метрики и лейблы можно использовать в API-запросах в формате Prometheus text-based exposition или в Grafana.
Метрики
Метрика — показатель, который количественно или качественно характеризует деятельность, событие или процесс. Например о количестве действий, сущностей или используемых ресурах. Каждой метрике присвоены лейблы.
В API Gateway используются общие лейблы для всех метрик и дополнительные лейблы для каждого вида метрик.
Метрики сервиса API Gateway и дополнительные лейблы для каждой метрики приведены в таблице:
Метрика |
Описание |
Дополнительные лейблы |
|---|---|---|
apigw_http_status |
Количество запросов, обработанных сервисом API Gateway с кодом ответа, указанным в лейбле code. |
code — код ответа, возвращаемый правилом при обращении к сервису API Gateway. Пример значений: 200, 201, 202, 204, 301, 302, 304, 307, 400, 401, 403, 404, 405, 422, 499, 500, 503. |
apigw_http_latency_bucket |
Категория (bucket) задержки обработки HTTP-запроса в миллисекундах. |
type — тип задержки: apigw — задержка запроса на стороне API Gateway, upstream — задержка на стороне бэкенда клиента, request — общая задержка. |
apigw_http_latency_sum |
Суммарная задержка обработки HTTP-запроса в миллисекундах. |
type — тип задержки: apigw — задержка запроса на стороне API Gateway, upstream — задержка на стороне бэкенда клиента, request — общая задержка. |
apigw_http_latency_count |
Количество попаданий в категорию (bucket) для задержки обработки HTTP-запроса. |
type — тип задержки: apigw — количество попаданий для задержки на стороне API Gateway, upstream — количество попаданий для задержки на стороне бэкенда клиента, request — общее количество попаданий. |
apigw_bandwith |
Пропускная способность в байтах для API Gateway. Тип пропускной способности определяется лейблом type. |
type: apigw — пропускная способность на стороне API Gateway, ingress — пропускная способность для входящего клиентского трафика, egress — пропускная способность для исходящего клиентского трафика. |
Лейблы
Лейбл — метка, которая присваивается каждой метрике и отражает, к какому проекту, продукту, шлюзу или другой сущности принадлежит показатель. Например, благодаря лейблам можно вывести информацию об отдельном шлюзе или правиле.
Общие лейблы сервиса API Gateway приведены в таблице:
Лейбл |
Описание |
|---|---|
apigw_id |
Идентификатор (UUID) шлюза |
apigw_name |
Название шлюза |
route_name |
Название правила |
project_id |
Идентификатор (UUID) проекта |
product_instance_id |
Идентификатор (UUID) продукта |
availability_zone |
Порядковый номер зоны доступности (az), которая обработала запрос |
Пример построения графика с помощью метрик и лейблов
С помощью метрик вы можете строить графики в Grafana.
Используйте приведенный ниже пример кода, чтобы построить график 95-го перцентиля задержки обработки HTTP-запроса.
histogram_quantile(0.95, sum(rate(apigw_http_latency_bucket{type=~"request",service=~"$service",consumer=~"$consumer",node=~"$node",api_gw_name=~"$api_gw",route_name=~"$route",availability_zone=~"$az"}[1m])) by (le))
- Просмотр графиков в сервисе Мониторинг
- Просмотр графиков в API Gateway
- Метрики и лейблы
- Пример построения графика с помощью метрик и лейблов