Description

The LogConsoleTool is a workbench tool to display a console dedicated to the BtibService log system. It displays live logs of the selected LogGroups.

It provides the following features:

  • Listens to all open stations from the workbench: it is therefore possible to choose the LogGroups located in different stations
  • Displays the logs in real time
  • Offers filter and log search tools
  • Offers more details on a log
  • Its configuration is saved in the options when closed correctly. When next opened, it will try to reload this configuration.

 

Implementation

Select the Tools menu in the Workbench menu bar and then "Log Console Tool"

 

By default, all open stations in the Workbench are listened to and, for each station, all its Log Groups.

It is possible to specify only certain stations or Log Groups. To do this, deselect the option "Always show all available Log Groups".

 

Operation

The tool is divided into three main parts:

  • Space dedicated to the console display:
    • Filter (top left): to filter the logs displayed according to a character string
    • Severity (to the right of the filter): to filter the displayed logs according to their severity (choose the maximum severity you want to display)
    • Pause: to pause the console. When the button is clicked again, the logs received during the pause will all be displayed and the console will resume the real time display
    • Show / Hide configuration (top right): allows the LogGroups configuration to be hidden
  • Space dedicated to configuration:
    • Refresh (to the right below the Show / Hide Config button): Refreshes the console to retrieve new connected stations and new LogGroups created
    • Clear config: reset the Logs Groups configuration to zero, i.e. listen to all stations but no LogGroup
    • Delete log list: deletes all the logs recorded by the console. Note that deleted Logs can no longer be read
    • Stations: filters stations to be listened to and sorts available LogGroups
    • Log Groups: filters the LogGroups whose logs will be displayed by the console
  • Table dedicated to the logs:
    • From the top right of the table, it is possible to:
      • export the table
      • show / hide columns
    • It is possible to sort each column in alphabetical order by clicking on the column name

The tool allows you to find the elements that generated the log by double clicking on the cells of the following columns to open a new workbench tab:

  • Origin: points to the component that sent the log
  • Source: points to the source component of the log-related operation
  • Target: points to the target component of the log-related operation

 

The tool also makes it possible to follow the propagation of the Log through the column "Steps". To open the popup, just click on the double chevron of the associated cell (far right). It is then possible to follow the path of the components that interacted with the log.