Logging

August 8, 2026 ยท View on GitHub

For usage related information, see logging usage.

The logging modules are used for sending log events to the peer.

It is generally used for sending client log messages to the server, but it can also be used in the opposite direction.

The prefix for all packets and capabilities is logging.

ComponentLink
clientxpra.client.subsystem.logging
client connectionnone
serverxpra.server.subsystem.logging

The server exposes two flags using the remote-logging capability prefix:

  • receive if the server is able to receive log events from the client
  • send if the server is able to send its log events to the client
Packet TypeArgumentsDirection
logging-eventlevel : integer
message : string or list of strings
time : integer
both
logging-controlaction : string, only either start or stopclient to server

The logging-event packets can be sent to the server if it exposes the receive capability, or sent from the server to the client following a start logging-control request.