Skip to content
Swiss federal authorities

Log Files

Logging framework🔗

The sedex-Client’s logging is based on the open source logging library named Logback.

Normally the logging configuration does not need to be adjusted. However, if you need to change the location, the rotation type or the size of the log files, you can do this in the configuration files according to the logback configuration syntax. You can find the documentation at logback.qos.ch/documentation.html

The logging configuration files can be found in the following folder:

OS-based installation:
<sedex_home>/conf/logging-configuration/

Container-based:
<sedex-data>/conf/logging-configuration/

Every component of the sedex-Client has its own logging configuration file in this folder.

  • sedex Controller

sedex-controller-logging-configuration.xml

  • sedex Adapter

sedex-messaging-logging-configuration.xml

  • sedex Web Service Proxy

sedex-wsproxy-logging-configuration.xml

Accessing the Log Files of the sedex-Client via logs subdirectory🔗

The logs of the sedex-Client are available as files from the logs subdirectories.

The log files should be monitored and analyzed

The logs of the sedex-Client provide detailed information about running processes and important events. The log files should be monitored and analyzed - especially in case of errors.

  • logs/controller/controller-technical.log: technical log for the main component of the sedex-Client
  • logs/adapter/adapter-technical.log: technical log for the sedex messaging component (for sending/receiving sedex messages)
  • logs/wsproxy/wsproxy-technical.log: technical log for the sedex Webservice Proxy component (for secure access to Web services)
  • logs/error-log.csv: business log with important error events
  • logs/receive-log.csv: business log of received sedex messages
  • logs/send-log.csv: business log of sent sedex messages
  • logs/wsproxy-access-log.csv: business log of secure Web service calls through sedex Webservice Proxy

Log files rotation

The log files in <sedex-home>/logs are automatically rotated when they reach a certain size. Older logs are renamed and numbered consecutively.

Log Files when using the Docker Image🔗

Accessing the Log via Log Files🔗

When using the Docker image, the sedex-Client logs are written to specific files within subdirectories of the permanent data storage "sedex-data"

The following example lists the content of the logs folder:

$ cd /sedex-data/logs
$ ls
adapter  controller  wsproxy  error-log.csv  receive-log.csv  send-log.csv  wsproxy-access-log.csv

Accessing the Log via Container Logs🔗

When using the Docker image, the logs of the sedex-Client can be retrieved using the standard container logs mechanism.

The log files should be monitored and analyzed

The logs of the sedex-Client provide detailed information about running processes and important events. The log files should be monitored and analyzed - especially in case of errors.

The combined sedex-Client logs are written to the standard output stdout and thus can be accessed using the standard container mechanisms for logs.

The following example shows how to continuously display the logs using docker logs command:

$ docker logs sedex-client --follow
14:21:27 INFO Adapterlog - 14:21:27 DEBUG ThrottlingPriorityMessageScheduler - No new messages in outbox. Skipping scheduling of messages to be sent.
14:21:57 INFO Adapterlog - 14:21:57 DEBUG ThrottlingPriorityMessageScheduler - Begin scheduling of messages
14:21:57 INFO Adapterlog - 14:21:57 DEBUG ThrottlingPriorityMessageScheduler - No new messages in outbox. Skipping scheduling of messages to be sent.
14:22:27 INFO Adapterlog - 14:22:27 DEBUG ThrottlingPriorityMessageScheduler - Begin scheduling of messages
14:22:27 INFO Adapterlog - 14:22:27 DEBUG ThrottlingPriorityMessageScheduler - No new messages in outbox. Skipping scheduling of messages to be sent.
14:22:57 INFO Adapterlog - 14:22:57 DEBUG ThrottlingPriorityMessageScheduler - Begin scheduling of messages
14:22:57 INFO Adapterlog - 14:22:57 DEBUG ThrottlingPriorityMessageScheduler - No new messages in outbox. Skipping scheduling of messages to be sent.
[...]