Опис системи логування

Доступ до логів

Доступ до логів організовано за рахунок АПІ:

// Доступ до логів за назвою логу
GET /logger-file/<log_name>/<YYYY>-<MM>-<DD>.log

// Достпу до теки перегляду логів
GET /logger-file/<log_name>/<YYYY>-<MM>-<DD>.log

Доступ до логів організовано у два способи:

1. Перехід до теки логів
2. Перехід до конкретного логу

У варіанті 1 ми отримуємо доступ до директорії з браузера і можемо далі нею рухатись, як у звичайному провіднику:

У варіанті 2 ми отримаємо прямий доступ до записів логу і можемо їх переглядати:

Призначення та доступ

Назва логу	Доступ	Призначення
acccess restricted	GET /logger-file//acccess restricted	Логує усі операції, де було обмежено доступ користувача
auth	GET /logger-file//auth	Логує усі операції авторизації
auth/error	GET /logger-file//auth/error	Логує помилки запиту на сервіс авторизації
auth/oauth	GET /logger-file//auth/oauth	Лог операцій виконаних за схемою OAuth
auth/sync	GET /logger-file//auth/sync	?
auth/sync_error	GET /logger-file//auth/sync_error	?
auth/verify	GET /logger-file//auth/verify	Лог роботи підсистеми підтвердження електронної адреси
auto_send_email	GET /logger-file//auto_send_email	Лог автоматичної розсилки повідомлень
autoindex	GET /logger-file//autoindex	?
cdm.data.api	GET /logger-file//cdm.data.api	?
cron	GET /logger-file//cron	Лог роботи планувальників системи
cyce error	GET /logger-file//cyce error	?
data_storage	GET /logger-file//data_storage	Лог змін за день у табличці edesb.module_data_storage
ecp-log	GET /logger-file//ecp-log	Лог операцій з ЕЦП через сервіс роботи з ними
ecp-log/develop	GET /logger-file//ecp-log/develop	Лог операцій розшифровки даних користувача, отриманих від id.gov.ua
ecp-log/sign	GET /logger-file//ecp-log/sign	Лог операцій підпису за допомогою ЕЦП через сервіс
ecp-log-error	GET /logger-file//ecp-log-error	Лог помилок при виконанні операцій з ЕЦП через сервіс
ecp-log-security	GET /logger-file//ecp-log-security	Лог, який логує намагання авторизації з підробленими даними ЕЦП
email	GET /logger-file//email	Лог відправки електронних повідомлень системою
error	GET /logger-file//error	Логи помилок системи. Вони розподіляються за основними кодами
exec	GET /logger-file//exec	Логи виконання консольних команд
exportTable	GET /logger-file//exportTable	Лог операцій вивантаження даних у таблицю
filenotfound	GET /logger-file//filenotfound	Логи помилок про незнаходження файлу у системі
format/error	GET /logger-file//format/error	Логи помилок в операціях перетворення формату даних
format/pdf	GET /logger-file//format/pdf	Логи формування pdf документів системою
helper/pdf	GET /logger-file//helper/pdf	Логи хелпера, який формує pdf з шаблону
index	GET /logger-file//index	?
init	GET /logger-file//init	?
injection/file	GET /logger-file//injection/file	?
injection/sql	GET /logger-file//injection/sql	Лог sql ін'єкцій, за допомогою яких намагались взламати систему
injection/xss	GET /logger-file//injection/xss	Лог xss ін'єкцій, за допомогою яких намагались взламати систему
integrations/autoDesCult	GET /logger-file//integrations/autoDesCult	?
integrations/diia	GET /logger-file//integrations/diia	?
integrations/diia_request	GET /logger-file//integrations/diia_request	?
integrations/diia_status_appl_api	GET /logger-file//integrations/diia_status_appl_api	?
integrations/drfo_trembita	GET /logger-file//integrations/drfo_trembita	?
integrations/drrp	GET /logger-file//integrations/drrp	Логи взаємодії з ДРРП
integrations/drrp_soap	GET /logger-file//integrations/drrp_soap	?
integrations/dzk	GET /logger-file//integrations/dzk	Логи взаємодії з ДЗК АПІ
integrations/dzk_wms	GET /logger-file//integrations/dzk_wms	Логи взаємодії з ДЗК ВМС шаром
integrations/edr	GET /logger-file//integrations/edr	Логи взаємодії з ЄДР
integrations/edr_trembita	GET /logger-file//integrations/edr_trembita	?
integrations/mvs_trembita	GET /logger-file//integrations/mvs_trembita	?
integrations/nais	GET /logger-file//integrations/nais	Логи взаємодії з НАІС
integrations/notary_search	GET /logger-file//integrations/notary_search	?
integrations/notary_search_done	GET /logger-file//integrations/notary_search_done	?
integrations/ovd	GET /logger-file//integrations/ovd	Логи взаємодії з ОВД
integrations/projdocTaskAppeal	GET /logger-file//integrations/projdocTaskAppeal	?
integrations/propertyright	GET /logger-file//integrations/propertyright	?
integrations/soap_drrp	GET /logger-file//integrations/soap_drrp	?
integrations/superset	GET /logger-file//integrations/superset	?
integrations/trembita	GET /logger-file//integrations/trembita	?
integrations/unzr_trembita	GET /logger-file//integrations/unzr_trembita	?
interface	GET /logger-file//interface	Логи доступу до інтерфейсу з правами адміністратора
map	GET /logger-file//map	Логи мапи
method	GET /logger-file//method	?
metric	GET /logger-file//metric	Логи статусу завантаження системи
misc/loadTemplate	GET /logger-file//misc/loadTemplate	Логи завантаження шаблонів
notfound	GET /logger-file//notfound	Лог компонентів, які не може знайти
notification	GET /logger-file//notification	?
notification/sent	GET /logger-file//notification/sent	?
notification/error	GET /logger-file//notification/error	?
pdfbase64	GET /logger-file//pdfbase64	Логи роботи helper pdfToBase64ImgHelper
public-api	GET /logger-file//public-api	?
public-api-error	GET /logger-file//public-api-error	?
request	GET /logger-file//request	Лог виклику системних АПІ
s3	GET /logger-file//s3	Лог віддаленого сховища S3
select/error	GET /logger-file//select/error	?
select/getSelect	GET /logger-file//select/getSelect	?
select/nocache	GET /logger-file//select/nocache	?
select/skip	GET /logger-file//select/skip	?
select/suggest	GET /logger-file//select/suggest	?
select/update	GET /logger-file//select/update	?
services/edesb.property_right_api	GET /logger-file//services/edesb.property_right_api	?
services/sync-edesb2edra	GET /logger-file//services/sync-edesb2edra	Логи синхронизації ЄДССБ та ЄДРА
services/sync-edesb2matching	GET /logger-file//services/sync-edesb2matching	?
signed	GET /logger-file//signed	Тека підписаних логів
start	GET /logger-file//start	?
suggest/len6	GET /logger-file/suggest/len6	?
suggest/update	GET /logger-file//suggest/update
upload/invalid_pdf	GET /logger-file//upload/invalid_pdf	Логи завантаження невалідних pdf документів. Невалідними вважаються усі документи, які не відповідають стандарту ISO 32000-2:2020
upload/pdf	GET /logger-file//upload/pdf	Логи завантаження валідних pdf документів
uservices/data_land	GET /logger-file//uservices/data_land	?
util/moderation	GET /logger-file//util/moderation	?
util/syncDrrpSmp	GET /logger-file//util/syncDrrpSmp	?
xss/updateblock	GET /logger-file//xss/updateblock	?
xss/updateform	GET /logger-file//xss/updateform	?

Налаштування підпису логів

У системі налаштований автоматичний підпис вказаних у налаштуваннях файлів логів. Підписані логи потрапляють у директорію log/signed/<назва логу>. Цей процес запускається кожень день об 23:30, або відповідно до вказаних налаштувань у <configServer.json> (Документація з описом).

Сервіс перевіряє чи існує вже підпис до файлу і, якщо не існує, запускає процес підпису, за результатами якого у відповідній директорії формується файл підпису з розширенням .p7s та копія самого логу. Описаний вище процес виконується для всіх файлів логів, які є у вказаних директоріях зберігання відповідно до налаштувань. Перевірити їх наявність можна викликавши АПІ

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

Для того, щоб обрати, якою печаткою будуть підписуватись логи, потрібно вказати місце підпису log, як наведено нижче на зображені

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

Перегляд логів через систему

Усі логи системи можна перевірити за допомогою АПІ <адреса>/logger-file//. При переході за наведеним вище посиланням відкривається перегляд директорії логів, де можна переглянути усі логи системи, а також відповідні їм підписані логи, якщо підпис для цих логів налаштовано.

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

Налаштування логування змін у таблицях БД

Для налаштування логування змін у таблицях БД, потрібно перейти у налаштування Налаштування логування та вписати через кому назви табличок із назвою схеми у форматі <назва_схеми.назва_таблиці> у відповідне поле, як показано на малюнку нижче

Ці логи можна переглянути за посиланням

Налаштування логування дій у інтерфейсах

Для налаштування логування інтерфейсів, потрібно перейти у налаштування Налаштування логування та вписати через кому назви інтерфейсів у відповідне поле, як показано на малюнку нижче

Ці логи можна переглянути за посиланням