Общие сведения

При работе приложения Dashboards TN логируются события двух типов: действия, выполняемые сервисами приложения и действия, выполняемые в приложении. Действия в приложении записываются отдельно для действий системы и для действий пользователей.

Логирование действий сервиса

Управление логированием

Логированием действий сервиса можно управлять отдельно для каждого сервиса, посредством следующих параметров.

  • LOG_LVL – уровень логирования. Параметр принимает значения:
    • 0 – Panic level
    • 1 – Fatal level
    • 2 – Error level
    • 3 – Warning level
    • 4 – Info level
    • 5 – Debug level
    • 6 – Trace level
      По умолчанию используется значение «5».
  • LOG_PATH – файл, в который записываются логи. Если приложение установлено через Docker-установку, то файл создается в контейнере сервиса. По умолчанию используется значение «/tmp/{ИМЯ_СЕРВИСА}.log».
  • LOG_WITH_RESPONSE – логирование тела полученного ответа. Параметр доступен только для сервисов Manager и Dashboard. По умолчанию используется значение «false».

 Логирование действий в приложении

Управление логированием

Для сбора и хранения логов действий в приложении отвечает сервис приложения Logstash. Управлять сервисом можно посредством следующих параметра:

  • POLYMATICA_LOGSTASH_REPOSITORY_PATH – директория хранения логов. По умолчанию используется значение «/usr/share/polymatica/platform/logstash/». Если приложение установлено через Docker-установку, то директория создается в контейнере сервиса.
  • POLYMATICA_LOGSTASH_PIPELINE_CONFIG_PATH – директория с файлом конфигурации. По умолчанию используется значение «/etc/polymatica/platform/service/logstash/». Если приложение установлено через Docker-установку, то директория создается в контейнере сервиса.

Ротация файлов

Действия в приложении логируются отдельно для действий системы и для действий пользователей в файлы:

  • POLYMATICA_LOGSTASH_REPOSITORY_PATH/system_log.log – для логов действий системы;
  • POLYMATICA_LOGSTASH_REPOSITORY_PATH/user_log.log – для логов действий пользователей.

Чтобы настроить ротацию, необходимо задать параметры ротации в файле POLYMATICA_LOGSTASH_PIPELINE_CONFIG_PATH/pipeline-config.json. Если приложение установлено через Docker-установку, то файл создается в контейнере сервиса. Для настройки ротации файла логов действий системы параметры нужно задать для записи

{
	"name": "file",
	"tag": "system_log",
	"format": {
		"name": "ltsv"
	}
}

Для настройки ротации файла логов действий пользователя параметры нужно задать для записи

{
	"name": "file",
	"tag": "user_log",
	"format": {
		"name": "ltsv"
	}
}

Ротация файлов управляется следующими параметрами.

  • max_size – размер файла в мегабайтах. По достижении заданного размера создается новый файл. По умолчанию используется значение «100».
  • max_backups – максимальное количество сохраняемых при ротации предыдущих файлов. Когда значение параметра больше нуля, по достижении max_size создается файл {имя_файла}-{метка времени}.log. При превышении max_backups файл с самой ранней меткой удаляется. По умолчанию используется значение «3».
  • max_age –  время хранения сохраняемых при ротации предыдущих файлов в днях. Когда значение параметра больше нуля, и значение max_backups больше нуля, при превышении max_age меткой времени файла, файл удаляется. По умолчанию используется значение «28».
  • compress – архивация сохраняемых при ротации предыдущих файлов. По умолчанию используется значение «true».

Получение файлов через интерфейс приложения

Вы можете скачать все хранящиеся в POLYMATICA_LOGSTASH_REPOSITORY_PATH файлы через интерфейс приложения, со страницы приложения /setting/logs. Для доступа к странице у вас должна быть роль суперпользователя или роль с доступом к логированию действий.

Чтобы скачать файлы, кликните на странице кнопку «Скачать логи». По клику формируется и автоматически скачивается архив с файлами. Формирование архива для скачивания может занять некоторое время.


Кнопка «Скачать логи» на странице приложения «Логи» модуля «Менеджер»

Подробнее о странице «Логи» см. Руководство пользователя модуля Manager, страница «Руководство пользователя/Настройки/Логи».

Отправка логов по HTTP и HTTPS

Вы можете настроить автоматическую отправку файлов логов действий системы и пользователей с использованием POST-запросов.

Чтобы настроить автоматическую отправку, необходимо задать параметры отправки в файле конфигурации POLYMATICA_LOGSTASH_PIPELINE_CONFIG_PATH/pipeline-config.json. Если приложение установлено через Docker-установку, то файл создается в контейнере сервиса.

Для настройки отправки по протоколу HTTP, добавьте в массив "outputs" запись вида:

{
    "name": "http",
    "tag": "файл_логов",
    "host": "хост",
    "port": "порт",
    "uri": "метод",
    "format": {
        "name": "json"
    }
}

Для настройки отправки по протоколу HTTPS, добавьте в массив "outputs" запись вида:

{
    "name": "http",
    "scheme": "https"
    "tag": "файл_логов",
    "host": "хост",
    "port": "порт",
    "uri": "метод",
    "format": {
        "name": "json"
    }
}

где файл_логов – определяет отправляемый файл и принимает значения "system_log" или "user_log";

       хост – IP-адрес или DNS-имя хоста;

       порт – номер порта;

       метод – метод сервиса, который следует вызвать.

Пример записи:

{
    "name": "http",
    "tag": "user_log",
    "host": "192.168.10.201"
    "port": "9180"
    "uri": "/castlemock/mock/rest/project/JYdd1Z/application/vPIsVb/user_log",
    "format": {
        "name": "json"
    }
}
  • Нет меток