Session Log Format

WARNING: The session log file is deprecated and will not be supported in future versions. Use Statistics instead. Statistics are also accessible via the Web API.

The collaboration server logs information about collaboration sessions to the file system. The log file contains detailed information about the sessions and uses a JSON format. Sessions are written to the log only after they have been terminated. To enable session logs you must configure a log output directory. (See com.unblu.logging.outputDirectory). The session log can be enabled/disabled using com.unblu.logging.sessionLogEnabled.

Log File Format

For every session a single line gets written to the session log. Every line consists of a 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.

SessionStatisticEntry

Main data type, represents a Collaboration 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.
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.
participants Array of ParticipantStatisticEntry objects.
windows Array of WindowStatisticEntry objects.
chat_protocols Array of ChatProtocolStatisticEntry objects (always empty if chat is disabled).

ParticipationStatisticEntry

KEY DESCRIPTION
remote_ip Not always available.
runtime_system Runtime System information from the participant's client.
id Unique id of the ParticipationStatisticEntry.
type Type of participant. Can be either OWNER or GUEST.
start DateTime when the participant joined the session.
end DateTime when the participant left the session.
navigation_control_period Array NavigationControlPeriodStatisticEntry objects.
web_session_id ID of the web session that participation has used. Can be associated to the session id context information in the main log.
remote_ip_hash Pseudonymization of a remote user.

ParticipantStatisticEntry

Represents a user participating in the session.

KEY DESCRIPTION
participant_id ID associated with the participant.
session_id Unique session ID.
user_id Unique user ID.
user_display_name User display name.
first_name First name of participant.
last_name Last name of participant.
user_name Full name of user.
authorization_role Authorization role.
session_rating Session rating.
team_id Unique ID associated with a team.
team_name Name associated with team.
additional_info Additional information.

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 participant acquired the navigation control.
end DateTime when the participant released the navigation control.

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 was been opened.
end DateTime when the browsing window was closed.
page_impressions Array PageImpressionStatisticEntry objects.

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.

ChatProtocolStatisticEntry

Represents a chat message.

KEY DESCRIPTION
message_number Current number of message.
sender_name Name of the sender of the chat message. (Used if no value in sender_first_name and sender_last_name.)
session_id Unique session ID
sender_first_name First name of chat message sender.
sender_last_name Last name of chat message sender.
message Message text sent.
id Unique id of the ChatProtocolStatisticEntry.
sender_id User id of message sender.
time Timestamp when the message was sent.

Further Reading

General information about logging: Logging.

  • deployonprem

results matching ""

    No results matching ""