Моніторинг метрик публічного API

🌐 Цей документ доступний українською та англійською мовами. Використовуйте перемикач у правому верхньому куті, щоб змінити версію.

1. Загальний опис дашборду

Платформа має Grafana-дашборд, призначений для моніторингу показників виконання і кількості запитів до публічних точок інтеграції від неавтентифікованих користувачів і сторонніх систем.

expose public api 4

Технічний адміністратор реєстру може користуватися даними з дашборду для відстеження динаміки й стану показників. Ці дані можуть допомогти у визначенні потреби в оптимізації налаштувань, таких як коригування лімітів на запити.

2. Доступ до дашборду

Щоб переглянути дашборд, виконайте наступні кроки:

  1. Увійдіть до адміністративної панелі Control Plane.

  2. Оберіть ваш реєстр > Редагувати > Швидкі посилання.

    Детальніше про швидкі посилання див. на сторінці Швидкі посилання до сервісів реєстру.

  3. Перейдіть за посиланням до вебінтерфейсу моніторингу Платформи — Grafana.

    grafana bpms 1

  4. Виконайте вхід за допомогою опції Sign in with OAuth.

    grafana bpms 2

  5. На боковій панелі зліва оберіть Manage > Dashboards > Go to folder.

    grafana bpms 3

  6. У рядку пошуку знайдіть Public API Kong Metrics, натисніть namespace та оберіть ваш реєстр.

    expose public api 8

3. Перегляд метрик дашборду

Для моніторингу продуктивності та відстежування запитів до вашого API, використовуйте дашборд метрик. Постійний моніторинг цих метрик допоможе вам виявити можливі проблеми в роботі API та вчасно реагувати на них.

Оберіть публічну точку, за якою потрібно переглянути метрики. Це можна зробити у розділі полі public endpoint. Оберіть усі створені точки або конкретні.

expose public api 9

  • Секція Request rate показує кількість запитів по кожній точці інтеграції.

    • Total requests per second (RPS) відображає загальний обсяг запитів за секунду до API.

    • RPS per route аналізує обсяг запитів для кожного роута окремо.

    expose public api 4

  • Секції Requests by status code (2xx, 4xx, 5xx та other) показують статистику успішних запитів, помилок клієнта, помилок сервера та інших кодів відповіді.

    expose public api 10

  • Секція Latencies визначає час відгуку сервера на запити.

    • Request time per route вказує середній час відгуку сервера для кожного роута окремо.

      expose public api 11

    • Kong Proxy latency per route показує затримку між часом отримання запита сервером і надсиланням його відповіді.

      expose public api 11 1

    • Upstream time across per route визначає час, який потрібен серверу для обробки запита і отримання відповіді від upstream-сервісу.

      expose public api 11 2