You are here: SwitchKit® Development Environment - Installation and Maintenance Guide > 6 Logging and Configuration Updates > Log Files

Log Files

All modules within SwitchKit generate log files. You can also generate your own log files, and have them managed by SwitchKit. Log file entries can also be displayed on the screen. By default, SwitchManager and LLC send their output to the screen as well as to the log file, while the applications write it only to the log file. The behavior of the LLC and SwitchManager can be changed through the environment variables.

The following logs are created by the SwitchKit processes at run-time:

Log | created by...
--- | ---
Alarm | SwitchManager
Maintenance | LLC, SwitchManager and each SwitchKit application
Messages | LLC (optional)
Socket | LLC (optional)
User-defined | LLC (optional)

Alarm Log

File name: alarm.log

SwitchManager generates this file. It logs all actions taken by the SwitchManager in configuring the switch, and the text of any alarm conditions that occur on the switch. If a switch software fault occurs, it is written to the alarm.log.

Maintenance Log

File name: maintenance.xxx.log

This type of log is generated by the LLC, the SwitchManager, and all applications linked with the SwitchKit API library. The actual file names are:

• maintenance-llc.PID.log

• maintenance_switchmgr.PID.log

• maintenance_appName.PID.log

• maintenance_app.PID.log

where PID is the process ID of that application.

Important! For the maintenance_app.PID.log, the outstanding message limit is 6552 per application. A warning is printed by the API when the key wrapping occurs: "App has more than 6553 outstanding messages, message collision may occur!".

Messages Log

File name: message.log

This file is generated by the LLC and shows all messages sent between the LLC and the switch, using the EXS API. The EXS API uses a hexadecimal numbering scheme. To interpret EXS API message formats, see the EXS API hexadecimal format information for each message.

The message.log includes the following abbreviations:

Abbreviation | Description
--- | ---
=> | ACK (acknowledgement) message
-> | outbound or inbound message
H REQ | LLC internal request manager
H LLC | LLC internal module
H ART | LLC internal artificial ACK, likely generated due to ACK timer expiration
H21 | External Host Application Number 21
X2001 | External Device with logical link value 2001 (200 = NodeType Call Server 1=node ID)
H | LLC Host
UNKNN | Unknown, the LLC was unable to resolve the sender. This should not happen.

Examples

Jan 29 2004 19:57:58 X2001 ->H : 00 ab 00 4d 01 00 10 01 00 03 02 09 00 05 00 00

Jan 29 2004 19:57:58 H LLC =>H REQ : 00 9e 00 00 01 00 10 01 00 03 02 08 00 05 00 00 (orig msg was 00 9e 00 00 01 )

Jan 29 2004 19:57:58 H REQ ->X2001 : 00 b5 00 00 01 01 1d 04 13 39 3a

Jan 29 2004 19:57:58 H LLC =>H REQ : 00 9f 00 01 01 00 10 (orig msg was 00 9f 00 01 01 14 )

Jan 29 2004 19:57:58 H REQ ->X2001 : 00 83 00 01 01 00 01 01 01 01

Jan 29 2004 19:26:17 H ART =>H REQ : 00 9f 00 04 01 f0 09 (orig msg was 00 9f 00 04 01 14 )

Jan 29 2004 19:06:31 UNKNN=>H1 : 00 83 00 1b 01 00 10 00 01 01 01 14 f3 00 00 43

04 01 04 00 00 01 79 02 00 00 01 01 01 06 00 00 00 00 00 00 00 00 00 00 00 00 00 00

00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00

00 00 00 f3 00 00 00 00 00 (orig msg was 00 83 00 1b 01 00 01 01 01 14 )

Socket Log

SwitchKit LLC can create and maintain a log file named, socket.log, which logs all the messages going from the CSP to the host and from the host to the CSP. This log is different from messages.log, because it logs everything that goes across the socket, prior to processing, including the length of the message.

The socket log file includes the following abbreviations:

Abbreviation | Description
--- | ---
X | CSP
1 | Logical Node ID
[10.10.156.24] | Socket IP address
H | Host

Example Socket.log

The following example socket log shows an inbound and outbound message:

Jan 11 2002 12:59:57 X1[10.10.156.24]->H : 00 ab 00 38 01 00 10 01 00 05 00 01 01 01 00 00

Jan 11 2002 12:59:57 H->X1[10.10.156.24] : 00 ab 00 38 01

For further information refer to Installing the CSA.

User-specified log files

By using the function sk_getManagedFile, you can create your own log files, to be managed by SwitchKit.

Positive acknowledgment to a message
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
Internet Protocol. Part of the TCP/IP family of protocols used to route messages and tracks the addresses of nodes.