Session Log Output Format
1. Introduction
The unblu on-premise server logs information about sessions to the filesystem. The log file contains detailed information about the sessions and uses a JSON format. Sessions are written to the log when they are terminated. For session logs to enabled, a log output directory must be configured (see com.unblu.logging.outputDirectory). The session log can be enabled/disabled by configuration (see com.unblu.logging.sessionLogEnabled).
2. Log file format
For every session a single line id written to the session log. Every line consists of a prolog (date, time and session id) and the JSON string holding the details about the session.
The sections below describe the data types that are used in the JSON format. SessionStatisticEntry is the main data type that represents a session.
2.1. SessionStatisticEntry
Main data type, represents a session.
Key | Description |
|---|---|
terminator_name | Name of the participant who terminated the session |
terminator_message | Message additionally set upon session termination. |
id | Unique id of the SessionStatisticsEntry |
account_id | Unique id of the account to which this entry belongs. |
owner_id | User id of the creator of the session. |
type | Type of Account. |
start | DateTime when a co-browsing session has been started. |
end | DateTime when a co-browsing session has been terminated. |
terminator_id | User id of the participant who terminated the session. Can be a system id if it was terminated by timeout. |
termination_reason | Whether the session has been terminated by the creator, the guest or a timeout. |
participations | Array of ParticipationStatisticEntry objects. |
windows | Array of WindowStatisticEntry objects. |
chat_protocols | Array of ChatProtocolStatisticEntry objects (always empty if chat is disabled). |
2.2. ParticipationStatisticEntry
Represents a user participating in the session.
Key | Description |
|---|---|
user_name | Name of participant |
remote_ip | Client ip of the participant if available. |
runtime_system | Runtime System information from the participants client. |
id | Unique id of the ParticipationStatisticEntry. |
user_id | User id of the participant. |
type | Type of the participant. Can be either OWNER or GUEST. |
start | DateTime when the participant joined the session. |
end | DateTime when the participant left the session |
additional_info | Additional information about the participant. |
navigation_control_period | Array NavigationControlPeriodStatisticEntry objects. |
3. NavigationControlPeriodStatisticEntry
Represents a time span a particular participation was in control of the session.
Key | Description |
|---|---|
id | Unique id of the NavigationControlPeriodStatisticEntry. |
start | DateTime when the pariticpant acquired the navigation control. |
end | DateTime when the participant released the navigation control. |
4. WindowStatisticEntry
Represents a browser window within the co-browsing session.
Key | Description |
|---|---|
id | Unique id of the WindowStatisticEntry. |
opener_id | User id of the participant who opened the browsing window (i.e. tab). |
start | DateTime when the browsing window has been opened. |
end | DateTime when the browsing window has been closed. |
page_impressions | Array PageImpressionStatisticEntry objects. |
5. PageImpressionStatisticEntry
Represents a page impression within a browser window.
| Key | Description |
|---|---|
| url | Url of the navigated page. |
| id | Unique id of the PageImpressionStatisticEntry. |
| start | DateTime when page view started. |
| end | DateTime when page view ended. |
6. ChatProtocolStatisticEntry
Represents a chat message.
| Key | Description |
|---|---|
message_number | Current number of message. |
| sender_name | Name of the sender of the chat message. |
| message | Message text sent. |
| id | Unique id of the ChatProtocolStatisticEntry. |
| sender_id | User id of message sender. |
| time | Timestamp when the message has been sent. |
7. Further Reading
General information about logging Unblu Server Logging