Функции логирования данных#

1. Функции логирования данных (info, error, warn, debug, trace)#

Функции используются для записи лог-сообщений. Могут принимать от одного до четырех аргументов, что позволяет гибко настраивать записываемые данные. В случае если необязательный из аргументов не определен, то значение этого аргумента в логе будет отображаться значение Undefined. Каждая из функций формирует лог с сообщением в JSON-формате на одноименный уровень логирования.

События уровней trace и debug не рекомендуется включение в Промышленной среде.

Варианты написания функции:

• info;

• Info;

• INFO;

• error;

• Error;

• ERROR;

• warn;

• Warn;

• WARN;

• debug;

• Debug;

• DEBUG;

• trace;

• Trace;

• TRACE.

Синтаксис#

info(message)
info(message, eventId)
Info(message, eventId, sourceTopic)
INFO(message, eventId, sourceTopic, targetTopic)

error(message)
error(message, eventId)
Error(message, eventId, sourceTopic)
ERROR(message, eventId, sourceTopic, targetTopic)

warn(message)
warn(message, eventId)
Warn(message, eventId, sourceTopic)
WARN(message, eventId, sourceTopic, targetTopic)

debug(message)
debug(message, eventId)
Debug(message, eventId, sourceTopic)
DEBUG(message, eventId, sourceTopic, targetTopic)

trace(message)
trace(message, eventId)
Trace(message, eventId, sourceTopic)
TRACE(message, eventId, sourceTopic, targetTopic)

Аргументы#

1. message — cтрока, содержащая сообщение для логирования (обязательный параметр!).

2. eventId — ID события; если не указан, устанавливается значение «Undefined» (необязательный параметр).

3. sourceTopic — строка, указывающая имя исходного топика, откуда пришло событие; если не указан, устанавливается значение «Undefined» (необязательный параметр).

4. targetTopic — строка, указывающая имя целевого топика, куда направляется событие; если не указан, устанавливается значение «Undefined» (необязательный параметр).

Примеры использования функции «info»#

1. Базовое использование: Info(«log_message»)

   Результат:

{
    "timeStamp": "2020-09-17T16:35:51.040+03:00",
    "eventId": "Undefined",
    "sourceTopic": "Undefined",
    "targetTopic": "Undefined",
    "message": "log_message"
    }

2. С указанием идентификатора события: Info(«log_message», 5i)

   Результат:

{
    "timeStamp": "2020-09-17T16:35:51.040+03:00",
    "eventId": "5",
    "sourceTopic": "Undefined",
    "targetTopic": "Undefined",
    "message": "log_message"
    }

3. С указанием идентификатора события и исходного топика: Info(«log_message», 5i, «Topic_1»)

   Результат:

 {
    "timeStamp": "2020-09-17T16:35:51.040+03:00",
    "eventId": "5",
    "sourceTopic": "Topic_1",
    "targetTopic": "Undefined",
    "message": "log_message"
    }

4. С указанием идентификатора события, исходного и целевого топиков: Info(«log_message», 5i, «Topic_1», «Topic_2»)

   Результат:

{
    "timeStamp": "2020-09-17T16:35:51.040+03:00",
    "eventId": "5",
    "sourceTopic": "Topic_1",
    "targetTopic": "Topic_2",
    "message": "log_message"
    }

Использования функций «error», «warn», «debug», «trace» выполняется аналогично функции «info».