Сервіс baf-log-to-mssql

Про проект

Цей проект розроблений для автоматизації процесу переносу даних із журналу реєстрації 1С (BAF) до бази даних Microsoft SQL Server.

Основна мета проекту — забезпечити зручне, швидке та гнучке отримання даних логів за допомогою SQL-запитів або через REST API, що значно ефективніше за стандартні засоби перегляду журналу реєстрації в середовищі 1С.

Базовий URL

Всі запити виконуються відносно кореневої адреси розгорнутого сервісу (за замовчуванням http://localhost:8080).

---

1. Контролер статусу (StatusController)

Використовується для перевірки працездатності сервісу та перегляду останніх логів у пам'яті.

Отримати статус сервісу

• URL: /api/status
• Метод: GET
• Приклад відповіді:

  {
    "status": "UP",
    "timestamp": "2024-04-11T12:00:00",
    "serviceName": "baf-log-to-mssql",
    "recentLogs": [
      {
        "timestamp": "2024-04-11T11:55:00",
        "level": "INFO",
        "message": "Migration started..."
      }
    ]
  }

---

2. Контролер довідників (DictionaryController)

Надає доступ до допоміжних таблиць (користувачі, комп'ютери, події тощо), що використовуються в системі логування.

Отримати список користувачів

• URL: /api/dictionaries/users
• Метод: GET

Отримати типи подій

• URL: /api/dictionaries/event-names
• Метод: GET

Отримати список комп'ютерів

• URL: /api/dictionaries/computers
• Метод: GET

Отримати список додатків

• URL: /api/dictionaries/applications
• Метод: GET

Отримати метадані

• URL: /api/dictionaries/metadata
• Метод: GET

Отримати рівні важливості (Severity Levels)

• URL: /api/dictionaries/severity-levels
• Метод: GET

Отримати всі словники одним запитом

• URL: /api/dictionaries/all
• Метод: GET
• Опис: Повертає об'єкт, що містить усі вищеперелічені списки.

---

3. Контролер логів (LogController)

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

Отримання записів журналу

• URL: /api/logs
• Метод: GET
• Параметри фільтрації:
  • page / size — параметри пагінації (за замовчуванням 0 та 50).
  • search — рядок для текстового пошуку за коментарем, даними, іменами користувачів, комп'ютерів тощо.
  • from / to — часовий діапазон у форматі ISO (наприклад, 2024-04-11T10:00:00).
  • userIds, computerIds, appIds, eventIds, severityIds — масиви ідентифікаторів для точної фільтрації за довідниками.

---

Приклади використання (cURL)

Перевірка статусу: bash curl -X GET http://localhost:8080/api/status

Отримання всіх користувачів: bash curl -X GET http://localhost:8080/api/dictionaries/users

Отримання записів журналу: bash curl -X GET http://localhost:8080/api/logs?page=0&size=20&search=error