Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 22.1
Div
Classe2e-refDiv

Otp
Floatingfalse

Rp
Rde

Switch to the Preferences tab in the information/working area. Users who want to change the preferences need to be a member of a group, to which the role ADMIN has been assigned.

...

Click Apply to save your adjustments.

Bridge

...

Logging

xUML Service Logging

The software components of the Bridge log activities like deployments, import of node instances into a domain, firmware package uploads, etc. according the selected log level. The higher the log level the more information will be written to the log files.
The log levels in the table below are cumulative and are ordered from the lowest to the highest log level. For each log level, also the information of the lower levels is logged. When changing the log level, all future incidents will be logged according to the new settings.

Log Level
Description
NoneNo logging will be executed.
Fatal Logs only fatal errors. The component cannot continue with normal execution. Fatal errors need the intervention of an administrator to solve the problem.
Error Logs also non-fatal errors that occur during normal operation of the Bridge.
Warning Logs warnings. Warnings indicate unexpected but non-critical situations that do not interrupt normal operation.
Info Logs general information. This log level should be sufficient for normal use.
Debug and Trace Both log levels are not intended for normal use but for troubleshooting. The log level Trace will result results in more detailed logging information than log level Debug.

Logged data is stored in your Bridge DATA directory at E2E_BRIDGE_DATA/servlets/logs in several subfolders (before Bridge version 5.1.5: E2E_BRIDGE_PROG/servlets/logs). You can inspect the logged information on the Logging tab as described in Inspecting the Logging Information.

Bridge API Logging

The implementation of the Bridge API uses the Eclipse Jersey REST framework. This framework allows to configure Logging and Tracing. You can activate and configure Jersey logging and tracing via the console.properties file. This file resides in the Bridge program folder of your installation.

Console PropertyDescriptionAllowed Values
Logging
rest_api_log_level

Set this property to activate Jersey logging for the Bridge API. If this property is not set, Jersey logging is switched off.

The logging information is written to <Bridge data directory>/servlets/logs/admin/error_<current date>.log.

One of SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL.
Refer to the Jersey documentation for more information.
rest_api_log_verbosity
Configure the verbosity of the logger.HEADERS_ONLYLogs the content of the HTTP headers only. No message payload data is logged.
PAYLOAD_TEXTLogs the content of the HTTP headers as well as entity content of textual media types (default).
PAYLOAD_ANYFull verbose logging: Logs the content of HTTP headers as well as any message payload content.
Tracing
rest_api_tracing_threshold

Set this property to activate Jersey tracing for the Bridge API.If this property is not set, Jersey tracing is switched off.

The logging information is returned via the response headers.

SUMMARYLogs very basic summary information about the main request processing stages.
TRACELogs detailed information about activities in all the main request processing stages.
VERBOSEMost verbose mode that provides extended information similar to the TRACE level, however with details on entity providers (MBR/MBW) that were skipped during the provider selection phase for any reason (lower priority, pattern matching, etc). Additionally, in this mode all received request headers are echoed as part of the tracing information.
rest_api_log_tracing_on_server

Set this property to additionally write the Jersey trace to the Bridge server logs.

Note

Please note that Jersey tracing may create a huge amount of data. Do only enable this for problem solving reasons.

trueWrites the Jersey trace to <Bridge data directory>/servlets/logs/admin/error_<current date>.log. This is the same file as for the Jersey logging.
falseDo not write the logs to a file on the Bridge server (default).