Logs (Zenitel Connect Pro): Difference between revisions
From Zenitel Wiki
(Created page with "{{C}} In case there is an issue one can download system log file from the Zenitel Connect Pro. The file can be retrieved in the tile '''Logs''' in the '''Applications''' secti...") |
No edit summary |
||
| Line 1: | Line 1: | ||
{{C}} | {{C}} | ||
Zenitel Connect Pro (ZCP) provides four different log types: | |||
*'''Debug Log''': Covers a large section of different debug messages meant for developers. | |||
*'''System Log''': Provides log events for monitoring the health of the ZCP system. The log includes system startup and shutdown, container startup and shutdown, tone and button tests, licenses ok or failed, device status, SIP trunk status and WAMP session status. | |||
*'''Call Log''': Information about calls in the system | |||
*''' Audit Log''': Reports Generate token denied, Refresh token denied, Generate token, Refresh token. | |||
Logs can either be stored locally in the Zenitel Connect Pro file system, or sent to a remote Syslog server. The log format is according to [https://www.rfc-editor.org/rfc/rfc5424.html RFC-5424]. | |||
To configure and download logs, select the tile '''Applications''' > '''Logs'''. | |||
==Logging to Local Filesystem== | |||
Logging to the Local File System is by default disabled. To enabled logging change the relevant log type to "Log Level" = '''All'''. | |||
<table style="max-width:80%; border-style: double; border-color: #c7c7c7;"> | |||
<tr style="rowspan:2;"> | |||
<td style="display: block; vertical-align: bottom;">[[Image:ZCP FileLogs.JPG|700px]]</td> | |||
</tr> | |||
<tr> | |||
<td style='background-color:#efefef;'>Logging to Local File System</td> | |||
</tr> | |||
</table> | |||
* '''Log Level''': In syslog, log levels are categorized into eight severity levels, ranging from the most critical (0 - Emergency) to the least critical (7 - Debug). Set "Log Level" = '''All''' to log all log events. | |||
* '''Text Match''': To filter on a specific text in the log strings, add the required text in the '''Text Match''' field. Only log events that contain this text will be sent to the log. | |||
A '''Log Rotation''' mechanism prevents the logs from growing out of control. Once a day there is a check if a single log file has exceeded 200kB, or if the total amount of log files have exceeded 5MB. If so the oldest log content will be deleted. | |||
=== Downloading log files === | |||
To retrieve the log files: | |||
* Click '''Generate logs''' | * Click '''Generate logs''' | ||
* Wait a few seconds for the logs to be generated | * Wait a few seconds for the logs to be generated | ||
* Click '''Download logs''' | * Click '''Download logs'''. A zip file containing all logs will be available in the normal download directory of your PC. The file name is '''connect-logs-''' extended with the Hostname of the Zenitel Connect Pro, and date and time when the log file was generated. Example: '''connect-logs-vs-icx510-2025-02-18-11-59-15.zip''' | ||
* '''Unzip''' the downloaded file. In the folder '''zcp''' you will find the log files. These are text files that can be opened in e.g. Notepad or Notepad++. | |||
<br> | |||
==Logging to Syslog == | |||
To enable logging to an external Syslog server select "Log Target" = ''SysLog'', and select the icon [[File:ZC_PlusIcon.PNG|21px]] to add a new record. | |||
Enter the following data: | |||
* '''Name''': Any descriptive text | |||
*'''Server''': The IP address of the Syslog server | |||
*'''Port''': Normally port 514 when using UDP protocol, and 6514 when using TCP protocol | |||
*'''Protocol''': Select UDP or TCP | |||
*'''Log Stream''': Let you select which of the 4 log types; Debug, System, Call or Audit | |||
*'''Log Level''': Select Syslog severity level, or "All" | |||
*'''Text Match''': Filter on a specific text in the log string. Only log events that contain this text will be sent. | |||
<table style="max-width:80%; border-style: double; border-color: #c7c7c7;"> | |||
<tr style="rowspan:2;"> | |||
<td style="display: block; vertical-align: bottom;">[[Image:ZCP SysLogs.JPG|900px]]</td> | |||
</tr> | |||
<tr> | |||
<td style='background-color:#efefef;'>Logging to Syslog server</td> | |||
</tr> | |||
</table> | |||
[[Homepage (Zenitel Connect Pro)]] | [[Homepage (Zenitel Connect Pro)]] | ||
[[Category: Zenitel Connect Pro]] | [[Category: Zenitel Connect Pro]] | ||
Revision as of 16:18, 6 March 2025
Zenitel Connect Pro (ZCP) provides four different log types:
- Debug Log: Covers a large section of different debug messages meant for developers.
- System Log: Provides log events for monitoring the health of the ZCP system. The log includes system startup and shutdown, container startup and shutdown, tone and button tests, licenses ok or failed, device status, SIP trunk status and WAMP session status.
- Call Log: Information about calls in the system
- Audit Log: Reports Generate token denied, Refresh token denied, Generate token, Refresh token.
Logs can either be stored locally in the Zenitel Connect Pro file system, or sent to a remote Syslog server. The log format is according to RFC-5424.
To configure and download logs, select the tile Applications > Logs.
Logging to Local Filesystem
Logging to the Local File System is by default disabled. To enabled logging change the relevant log type to "Log Level" = All.
 |
| Logging to Local File System |
- Log Level: In syslog, log levels are categorized into eight severity levels, ranging from the most critical (0 - Emergency) to the least critical (7 - Debug). Set "Log Level" = All to log all log events.
- Text Match: To filter on a specific text in the log strings, add the required text in the Text Match field. Only log events that contain this text will be sent to the log.
A Log Rotation mechanism prevents the logs from growing out of control. Once a day there is a check if a single log file has exceeded 200kB, or if the total amount of log files have exceeded 5MB. If so the oldest log content will be deleted.
Downloading log files
To retrieve the log files:
- Click Generate logs
- Wait a few seconds for the logs to be generated
- Click Download logs. A zip file containing all logs will be available in the normal download directory of your PC. The file name is connect-logs- extended with the Hostname of the Zenitel Connect Pro, and date and time when the log file was generated. Example: connect-logs-vs-icx510-2025-02-18-11-59-15.zip
- Unzip the downloaded file. In the folder zcp you will find the log files. These are text files that can be opened in e.g. Notepad or Notepad++.
Logging to Syslog
To enable logging to an external Syslog server select "Log Target" = SysLog, and select the icon 
to add a new record.
Enter the following data:
- Name: Any descriptive text
- Server: The IP address of the Syslog server
- Port: Normally port 514 when using UDP protocol, and 6514 when using TCP protocol
- Protocol: Select UDP or TCP
- Log Stream: Let you select which of the 4 log types; Debug, System, Call or Audit
- Log Level: Select Syslog severity level, or "All"
- Text Match: Filter on a specific text in the log string. Only log events that contain this text will be sent.
 |
| Logging to Syslog server |