Log Reference

Logs are generated by system processes to record important system information when the system is running.

By viewing and analyzing logs, maintenance engineers can learn about the status of each process in the system. When the system is running abnormally, they can locate and rectify the fault based on logs.

Table 6-135 describes log levels.

For example, the current SMU security log file is named in SMU#Device code_security.log format.

• When the log file size reaches the maximum, the system automatically archives the log file into an SMU#Device code_security_YYYYMMDDHHMMSS.log file and generates another log file.

  In the preceding information, YYYYMMDDHHMMSS indicates the time when the last log is recorded in the original file.

• When the total number of log files reaches the maximum, the system automatically compresses the log file that is generated earliest into a .zip package and moves the package to the log file backup directory /opt/Backup/logback.

  Both the current and historical log files are counted.

• When the log file backup directory /opt/Backup/logback occupies 10 GB, the system automatically deletes the earliest log file from the directory.

• Security logs of non-debug levels are recorded in the following format:

  Date and time|Log level|User account|Client IP address|Static log information|Operation result|Additional log information

  Fields are separated with vertical bars (|). Table 6-139 describes these fields in the preceding format.

  Table 6-139 Fields in the log format

  Field	Description	Example
  Date and time	Date and time when logs are generated. The value is in the format of YYYY-MM-DDThh:mm:ss.s"s"s"+|-Hh:Mm Euler IVS. The value of YYYY-MM-DDThh:mm:ss indicates the year, month, day, hour, minute, and second. Letter T is the abbreviation of Time and is used as a separator. The value of s"s"s" indicates the millisecond and is a three-digit decimal number ranging from 000 to 999. This part is optional and is not required when the time accuracy is not in milliseconds. The value of +|- indicates the offset from the Coordinated Universal Time (UTC). If the local time is earlier than the UTC time, the value of +|- is +; otherwise, the value is -. The value of Hh indicates the hour offset from the UTC time and is a two-digit decimal number ranging from 00 to 13. The value of Mm indicates the minute offset from the UTC time and is a two-digit decimal number ranging from 00 to 59. Euler IVS: unified identifier of the OS.	2023-03-06T11:09:34.371+08:00 Euler IVS
  Log level	Level of generated logs.	Error
  User account	Account of the user performing the current operation.	admin
  Client IP address	Client IP address.	192.168.10.10
  Static log information	Information about the operation being performed.	UserLogin
  Operation result	Result of the performed operation.	failed
  Additional log information	A string that records the dynamic content in logs in addition to static log information, including key input and output parameters.	User name or password error

  Example:

  2023-03-06T11:09:34.371+08:00 Euler IVS - - -|Info|admin|192.168.10.10|UserLogin|failed|Error_Code=30899109100000;User name or password error.

  This log is generated at 11:09:34 371 on March 6, 2023, which is 8 hours earlier than the UTC time, when the admin user's login fails due to incorrect user name or password.

• For details about the format of security logs at the debug level, see Debug Log.

• Operation logs of non-debug levels are recorded in the following format:

  Date and time|Log level|User account|Client IP address|Operation object|Static log information|Operation result|Additional log information

  Fields are separated with vertical bars (|). Table 6-140 describes these fields in the preceding format.

  Table 6-140 Fields in the log format

  Field	Description	Example
  Date and time	Date and time when logs are generated. The value is in the format of YYYY-MM-DDThh:mm:ss.s"s"s"+|-Hh:Mm Euler IVS. The value of YYYY-MM-DDThh:mm:ss indicates the year, month, day, hour, minute, and second. Letter T is the abbreviation of Time and is used as a separator. The value of s"s"s" indicates the millisecond and is a three-digit decimal number ranging from 000 to 999. This part is optional and is not required when the time accuracy is not in milliseconds. The value of +|- indicates the offset from the UTC. If the local time is earlier than the UTC time, the value of +|- is +; otherwise, the value is -. The value of Hh indicates the hour offset from the UTC time and is a two-digit decimal number ranging from 00 to 13. The value of Mm indicates the minute offset from the UTC time and is a two-digit decimal number ranging from 00 to 59. Euler IVS: unified identifier of the OS.	2023-03-06T11:09:34.371+08:00 Euler IVS
  Log level	Level of generated logs.	Info
  User account	Account of the user performing the current operation.	admin
  Client IP address	Client IP address.	192.168.10.10
  Operation object	Function module corresponding to the current operation.	LocalIP
  Static log information	Information about the operation being performed.	View Video Record
  Operation result	Result of the performed operation.	successful
  Additional log information	A string that records the dynamic content in logs in addition to static log information, including key input and output parameters.	-

  Example:

  2023-03-07T19:33:57.221+08:00 Euler IVS - - - |  Error|admin|192.168.1.225|LocalIP|local ip set|failed|Error_Code=30899159116001;

  This log is generated at 19:33:57 221 on March 3, 2023, which is 8 hours earlier than the UTC time, when the admin user failed to change the device IP address and received an error code.

• For details about the format of operation logs at the debug level, see Debug Log.

• Run logs of non-debug levels are recorded in the following format:

  Date and time|Log level|Thread ID|Static log information|Session ID|Operation result|Code file|Line number

  Fields are separated with vertical bars (|). Table 6-141 describes these fields in the preceding format.

  Table 6-141 Fields in the log format

  Field	Description	Example
  Date and time	Date and time when logs are generated. The value is in the format of YYYY-MM-DDThh:mm:ss.s"s"s"+|-Hh:Mm Euler IVS. The value of YYYY-MM-DDThh:mm:ss indicates the year, month, day, hour, minute, and second. Letter T is the abbreviation of Time and is used as a separator. The value of s"s"s" indicates the millisecond and is a three-digit decimal number ranging from 000 to 999. This part is optional and is not required when the time accuracy is not in milliseconds. The value of +|- indicates the offset from the UTC. If the local time is earlier than the UTC time, the value of +|- is +; otherwise, the value is -. The value of Hh indicates the hour offset from the UTC time and is a two-digit decimal number ranging from 00 to 13. The value of Mm indicates the minute offset from the UTC time and is a two-digit decimal number ranging from 00 to 59. Euler IVS: unified identifier of the OS.	2023-03-06T11:09:34.371+08:00 Euler IVS
  Log level	Level of generated logs.	Info
  Thread ID	Thread ID generated in logs.	TID:0xFFFF217B5180
  Static log information	A string that records the static content in logs.	User login success
  Session ID.	A string that records the session ID.	TRACEID:0x000007DC
  Log operation result.	Result of the performed operation.	Login success
  Code file	Code file where the current log is located.	xxx.cpp
  Line number	Number of the line where the current log is located.	315

  Example:

  2023-03-06T15:24:17.809+08:00 Euler IVS - - - |   Info|TID:0xFFFF217B5180|User login success|TRACEID:0x000007DC|Login success|UserLogin.cpp|315

  This log, whose thread ID is 0xFFFF217B5180, indicates a successful login to the device, and is recorded in line 315 in the UserLogin.cpp file.

• For details about the format of run logs at the debug level, see Debug Log.

• Interface logs of non-debug levels are recorded in the following format:

  Date and time|Interface type|Interface name|Log level|ID of the module invoking an interface|ID of the module receiving data in an interface|Interface ID|Operation content|Operation result|Additional log information

  Fields are separated with vertical bars (|). Table 6-142 describes these fields in the preceding format.

  Table 6-142 Fields in the log format

  Field	Description	Example
  Date and time	Date and time when logs are generated. The value is in the format of YYYY-MM-DDThh:mm:ss.s"s"s"+|-Hh:Mm Euler IVS. The value of YYYY-MM-DDThh:mm:ss indicates the year, month, day, hour, minute, and second. Letter T is the abbreviation of Time and is used as a separator. The value of s"s"s" indicates the millisecond and is a three-digit decimal number ranging from 000 to 999. This part is optional and is not required when the time accuracy is not in milliseconds. The value of +|- indicates the offset from the UTC. If the local time is earlier than the UTC time, the value of +|- is +; otherwise, the value is -. The value of Hh indicates the hour offset from the UTC time and is a two-digit decimal number ranging from 00 to 13. The value of Mm indicates the minute offset from the UTC time and is a two-digit decimal number ranging from 00 to 59. Euler IVS: unified identifier of the OS.	2023-03-06T11:09:34.371+08:00 Euler IVS
  Interface type	Interface type, including NSS, ONVIF, GBT28181, and RESTful.	NSS
  Interface name	Interface name.	NSS_DEV_STATUS_REPORT_REQ
  Log level	Level of generated logs.	Info
  ID of the module invoking an interface	ID of the module invoking an interface.	DCG#a8793b72b911407a8da2d7042fa8b247
  ID of the module receiving data in an interface	ID of the module receiving data in an interface.	SCU#a8793b72b911407a8da2d7042fa8b247
  Interface ID	ID used in interface messages, which is generated on the initial device, component, or module used in the service process and forwarded in messages to the next device, component, or module until the service process ends.	00000DCGqMsg20230308104426000053
  Operation content	Content of the current operation.	dcg send device status report to scu
  Additional log information	A string that records the dynamic content in logs in addition to the operation content, including key input and output parameters.	-

  Example:

  2023-03-08T10:44:26.629+08:00 Euler IVS - - - |NSS|NSS_DEV_STATUS_REPORT_REQ|   Info|DCG#a8793b72b911407a8da2d7042fa8b247|SCU#a8793b72b911407a8da2d7042fa8b247|00000DCGqMsg20230308104426000053|dcg send device status report to scu|

  This log is generated at 10:44:26 629 on March 8, 2023, which is 8 hours earlier than the UTC time, when the DCG sent a device status query to the SCU. The interface name is NSS_DEV_STATUS_REPORT_REQ.

• For details about the format of interface logs at the debug level, see Debug Log.

Debug-level logs, regardless of types (operation/run/security), are provided for maintenance engineers to locate and analyze faults.

Rules for recording debug-level logs are as follows:

• The debug-level log format contains fields such as the time, name of a file containing codes, line number, debug information, and module identifier.
• Function names, input parameters, and return values are recorded for functions.
• Input parameters, output parameters, and return values are recorded in Parameter name=Parameter value format. Multiple name-value pairs are separated with commas (,).

  Example:

  2023-03-08 16:40:52.659+08:00[   Info|TID:0x7EC29DD0E0|RtnCode:0x000C]    jovision_common.cpp:00556 channelAbilityofSoundLightAlarm TraceID:NULL|cameraCode[01464484031282240101], sound[0] light[0] soundlight[0]
  2023-03-08 16:40:52.658+08:00[  Debug|TID:0x7F9E1540E0|RtnCode:0x003E]    NSSP.cpp:00947  TraceID:0x02003ED6|recv MSG 0x914c from net elem(20105)

• Information about entry and exit of simple functions is not necessarily recorded in debug-level logs. However, if information about entry of functions is recorded, information about exit of functions must also be recorded.
• SQL statements generated in SQL debug logs are the same as those executed in program development codes. Users can copy corresponding SQL statements to the database SQL terminal to query or modify data.
• Logs are generated for all types of messages sent from outside the IVS platform.
• Descriptions contained in debug-level log files must be short and simple.
• Periodic debug-level logs are recorded only when data changes or exceptions occur.
• Debug-level log files contain run logs at all levels. When the debug-level log function is disabled, run logs at non-debug levels are recorded only in run log files. When the debug-level log function is enabled, run logs at non-debug levels are recorded in run log files and run logs at all other levels (such as EMERGENCY, ERROR, WARN, and INFO levels) are recorded in debug log files.