Producing a Session Log

• Producing a Session Log
  • Overview
    • Logs from the Debugger Logger (java logging)
    • Logs from the Trace Logger (legacy logging)
    • Contacting Datamine Support
  • Process
    • Viewing Logs from the Debugger Logger (java logging)
      • Log Aggregator's Base URL
      • Starting and Stopping the Debug Logger
    • Viewing Trace Logs (from legacy logging)

Overview

System logs are used to assist developers analyse and resolve the issue if something inadvertently goes wrong with CCLAS 6. Refer to Getting Help for CCLAS.

Logs from the Debugger Logger (java logging)

CCLAS 6 now uses the logging capabilities of Java to collect, standardise and consolidate log data from different sources into a centralised platform, allowing for streamlined log analysis and correlation.

Logs from the Trace Logger (legacy logging)

The original logging of system activities in CCLAS 6 shows a log of all activities on the system, not just for the current user. This type of logging is still available.

Contacting Datamine Support

You should always contact Datamine Support if you have an issue. Do not contact individual members of Datamine for support because your issue may not be responded to in a timely manner if that person is unavailable.

Datamine provides global support for CCLAS 6. If you are a licensed CCLAS 6 user, you can request support via the Support Portal (https://www.dataminesoftware.com/support/).

• Name of site
• Name of contact person for this issue and the contact details
• Name of application with the issue
• Time at which the issue occurred or was noticed
• The application involved, for example, CCSCHM, CCREGN
• A detailed description of the issue and what the expected results should have been
• A detailed description of any related incident, for example, server failure
• Actions taken to resolve the issue, if any
• The current status of the system
• Screen captures
• Reports, if relevant,
• Trace log which captures steps and actions performed by the current user that resulted in the error in the CCLAS 6 application.

Process

Viewing Logs from the Debugger Logger (java logging)

The debug logger uses a log aggregator to capture and write logs to an Elasticsearch repository using the user's session ID.

Elasticsearch organises data into documents, which are JSON-based units of information representing entities. Documents are grouped into indices, similar to databases, based on their characteristics. Elasticsearch uses inverted indices, a data structure that maps words to their document locations, for an efficient search. Elasticsearch’s distributed architecture enables the rapid search and analysis of massive amounts of data with almost real-time performance.

Log Aggregator's Base URL

The log aggregator's base URL is defined by the mandatory user.trace.base.url start up property, default false, and points to the Elasticstack repository on the CCLAS 6 server that contains the logs.

Example base URL:

user.trace.base.url=https://cclas-kibana.cclasenv.cclas-dm.net/app/discover#/view/8e81cba1-67d2-4037-a234-019b896a602b?_g=(time:(from:now-24h,to:now))&_a=(columns:!(environment,'@timestamp',message),index:d2c21828-c554-4491-9a5d-53eaf51f5332,query:(language:kuery,query:'message:"user-trace-id={USER_TRACE_ID}"'),sort:!(!('@timestamp',desc)))

Your LIMS administrator will set this up.

The User Trace Base URL can be viewed in your System Messages on your CCLAS 6 Home page. Refer to Using the Home Page.

This base URL contains a USER_TRACE_ID placeholder for the search criteria. When the debug logger is active, logs are written to the Elasticsearch repository with the USER_TRACE_ID placeholder replaced by the user's session ID.

Starting and Stopping the Debug Logger

On starting and stopping the debug logger, the Debug Logger popup displays the User Trace ID and the User Trace URL. The URL can be copied and pasted into a browser to access the Elasticsearch repository so that you can navigate the Elastic Stack using the Kibana user interface, to easily view your session logs that equate to the activity undertaken in the session capture.

Note: If the user.trace.base.url property is missing, then the Debug Logger popup will not display the User Trace URL.

View a debugger log (to see logs for the current user)

Viewing Trace Logs (from legacy logging)

The trace log allows logs for a session to be viewed, but contains logs for all current users.

View a trace log (to see logs for all users)