Візуалізація стану запитів у Kibana при роботі реєстру

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

1. Зовнішній вигляд

Дашборд Стан запитів надає оглядову інформацію про роботу реєстру, зокрема статуси виконання зовнішніх запитів і аналіз виниклих помилок. Він дозволяє оперативно оцінювати загальний стан системи, виявляти потенційні проблеми, а також забезпечує детальний аналіз запитів до API, використання кваліфікованого електронного підпису (КЕП) і помилок у роботі різних компонентів реєстру.

Дашборд включає візуалізації для моніторингу запитів до мікросервісів, відстеження помилок у Rest API, оцінки продуктивності API Gateway, а також інструменти для динамічної фільтрації даних за мікросервісами. Завдяки зручному візуальному представленню інформації, користувачі можуть швидко ідентифікувати проблеми та вживати необхідних заходів для їх усунення.

Таблиця 1. Візуалізації дашборда
Назва візуалізації Опис

Запити до мікросервісів реєстрів

Відображає загальну кількість запитів до мікросервісів реєстрів із розподілом за HTTP-кодами відповіді та контейнерами.

Запити до API Gateway

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

Використання КЕП у реєстрі

Показує загальну кількість операцій із використанням кваліфікованого електронного підпису (КЕП), виконаних на криптосервісі, з розподілом за типом та статусом виконання.

Помилки у Rest API фабрики даних

Відображає кількість помилок, що виникли в процесі обробки запитів до Rest API фабрики даних, із деталізацією за типами винятків.

Виклики з Трембіти

Показує запити, що проходять через інтеграційну платформу "Трембіта", із розподілом за кодами відповідей.

Unexpected EOF on client connection

Візуалізує кількість помилок при неочікуваних збоях з’єднання з базою даних.

Помилки реплікації аналітичної БД

Відображає помилки реплікації аналітичної бази даних.

Фільтр для мікросервісів

Дозволяє користувачам фільтрувати дані за іменем контейнера, щоб спростити аналіз конкретного мікросервісу.
Зразки деяких візуалізацій представлені на знімках екрана нижче:
dashboard 1
Зображення 1. Запити до API Gateway, помилки в Rest API фабрики даних, та використання КЕП у реєстрі
dashboard 2
Зображення 2. Запити до мікросервісів

2. Налаштування

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

  1. Завантажте файл request-dashboard.json.

  2. Замініть у файлі всі плейсхолдери із назвою YOUR_REGISTRY_NAME на назву потрібного реєстру у пошукових запитах за допомогою зручного для вас текстового редактора. Таких плейсхолдерів наразі 8 шт.

    file prep 1

    file prep 2

    file prep 3

  3. Створіть через вебінтерфейс Kibana 2 index pattern: app-* та app-<REGISTRY-NAME>-*.

    <REGISTRY-NAME> — назва вашого реєстру. Наприклад, app-test-registry-*.
    index pattern 1
    Зображення 3. Створення index pattern. Крок 1/2
    index pattern 2
    Зображення 4. Створення index pattern. Крок 2/2

  4. Імпортуйте підготовлений на 2 кроці файл через вебінтерфейс Kibana.

    import dashboard 1

    import dashboard 2

    При імпорті оберіть відповідний index pattern для візуалізацій (app-REGISTRY-NAME-*).

    import dashboard 3

  5. Налаштуйте динамічний фільтр.

    Для правильної роботи Фільтра для мікросервісів, оновіть значення indexPattern ID. Для цього:

    1. Відкрийте візуалізацію Запити до API Gateway.

      filter setup 1

    2. Скопіюйте значення параметра index у секції kibanaSavedObjectMeta.searchSourceJSON.

      filter setup 2

    3. Відкрийте візуалізацію Фільтр для мікросервісів та змініть значення поля params.controls[0].indexPattern у секції visState на значення із попереднього пункту.

      Значення indexPattern за замовчуванням: APP-*_INDEX_ID.

      filter setup 3

      filter setup 4

      filter setup 5

  6. Натисніть Save visualization Object.

  7. У розділі Dashboard  Стан запитів ви можете переглянути стан запитів під час роботи реєстру.

    final result 1