Chapter 3. Logging
Prev   Next

Chapter 3. Logging

Table of Contents

1. Log event structure
2. Logged events
2.1. Application events
2.2. Protocol events

1. Log event structure

Events are written to log file in following format: Component:Date:Time:Attributes

Table 3.1. Structure of event

Event partDescription
Componentcomponent name
Datedate of event in format YYYYMMDD
Timetime of event in format hhmmss
AttributesEvent attributes. Attributes are stored in following binary format: $numberOfAttributes:(${attributeNameSize}:${attributeName}:${attributeValueSize}:${attributeValue})numberOfAttributes

Attribute value is utf8 encoded string


Example: Protocol.IFrame.Start:20071113:011753:2:6:fileId:8:00000001:8:fileSize:5:12345

Table 3.2. Decoded example

Event partvalue
ComponentProtocol.IFrame.Start
Date20071113
Time1:53:17
Attributes2 attributes, fileId=00000001, fileSize=12345


2. Logged events

2.1. Application events

Following application events are logged

2.1.1. Application.Start

Component name: Application.Start

Event description: Tahiti was started

Attributes:

repository

Path to the active repository

user

Name of the user

Example: 

Application.Start:20071121:085732:2:10:repository88:C:\Documents and Settings\pyta.LIGHTCOMP\Application Data\LightComp\Tahiti\4.0\test.frnk4:user1:a20:Application started.

2.1.2. Application.Stop

Component name: Application.Stop

Event type: Tahiti was stopped

Attributes: none

Example: 

Application.Stop:20071113:011753:0:

2.1.3. Application.Connected

Component name: Application.Connected

Event description: Connection to server was created

Attributes: none

Example: 

Application.Connected:20071113:011753:0:

2.1.4. Application.Disconnected

Component name: Application.Disconnected

Event description: Connection to server was lost

Attributes: none

Example: 

Application.Disconnected:20071113:011753:0:

2.2. Protocol events

Following protocol layer events are logged:

2.2.1. Protocol.PushDocument

Component name: Protocol.PushDocument

Event description: PushDocument message was received

Attributes: attributes are defined in the protocol definition. Document attributes are stored with prefix attribute_. Page specific attributes are stored with prefix page_Number_.

Example: 

Protocol.PushDocument:20071119:210131:10:22:attribute_BusinessYear0:27:attribute_Document.readonly1:020:attribute_FileNumber10:100000000016:attribute_Period0:10:documentId36:a21d00a0-dc2c-46e9-951e-db64cf05b61b12:documentType14:BookKeeping_II15:documentVersion1:19:page_1_id36:282446df-5cea-43dd-adfa-dde39b75979615:page_1_mimetype8:TEXT/XML13:serverVersion0:18:Received document.

2.2.2. Protocol.Recv.DataFrame.Begin

Component name: Protocol.Recv.DataFrame.Begin

Event description: Start to receive incoming data frame

Attributes:

frameId

Frame id - used to pair begin and end of frame

frameSize

Size of the frame in bytes

frameType

Type of frame - 0,1,2

Example: 

Protocol.Recv.DataFrame.Begin:20071119:210131:3:7:frameId1:49:frameSize4:20069:frameType1:029:Received begin of data frame.

2.2.3. Protocol.Recv.DataFrame.End

Component name: Protocol.Recv.DataFrame.End

Event description: Incoming frame was successfully received

Attributes:

frameId

Frame id.

Example: 

Protocol.Recv.DataFrame.End:20071119:210131:1:7:frameId1:427:Received end of data frame.

2.2.4. Protocol.Page.Received

Component name: Protocol.Page.Received

Event description: Incoming frame was successfully received

Attributes:

frameId

Frame id.

pageId

Page id.

Example: 

Protocol.Page.Received:20071119:210140:3:7:frameId2:106:pageId36:282446df-5cea-43dd-adfa-dde39b7597968:pageSize3:79814:Received page.

2.2.5. Protocol.Send.DataFrame.Begin

Component name: Protocol.Recv.DataFrame.Begin

Event description: Sending outgoing frame

Attributes:

frameId

Frame id - used to pair begin and end of frame

frameSize

Size of the frame in bytes

frameType

Type of frame - 0,1,2

Example: 

Protocol.Send.DataFrame.Begin:20071119:210131:3:7:frameId1:49:frameSize4:20069:frameType1:019:Sending data frame.

2.2.6. Protocol.Send.DataFrame.End

Component name: Protocol.Send.DataFrame.End

Event description: Outgoing frame was successfully sent.

Attributes:

frameId

Frame id.

Example: 

Protocol.Send.DataFrame.End:20071119:210131:1:7:frameId1:420:Data frame was sent.

2.2.7. Protocol.SaveDocument

Component: Protocol.SaveDocument

Event description: SaveDocument message was sent to server

Attributes: ticker,documentId,version,"all document's attributes","all file ids, name of every file id attribute is 'fileId'"

Example:

Protocol.SaveDocument:20071113:011753:5:6:ticker:8:ticker_1:10:documentId:10:9876543210:7:version:1:1:7:CPS_CPU:10:2007123456:6:fileId:00000001

2.2.8. Protocol.ReceivedDocument

Component name: Protocol.ReceivedDocument

Event description: message receivedDocument was received

Attributes: documentId, version

Example: 

Protocol.ReceivedDocument:20071113:011753:2:10:documentId:10:9876543210:7:version:1:1

2.2.9. Protocol.ErrorReceivedDocument

Component name: Protocol.ErrorReceivedDocument

Event description: message errorReceivedDocument was received

Attributes: documentId,version,reason

Example: 

Protocol.ErrorReceivedDocument:20071113:011753:3:10:documentId:10:9876543210:7:version:1:1:6:reason:1:2
Prev   Next
Chapter 2. Communication Home Chapter 4. Architecture