Request logging filter - MSSQL

This filter simply logs requests from the database client to the specified output, and does not change the traffic in any way.

This filter type does not take any code.


None of the parameters are required.

The parameters that can take multiple values can be separated by commas or by newlines.

File name

If specified, the logging output will be appended to this file. Keep in mind that this file is from the perspective of the Docker container: it's usually located in a shared filesystem, or in a Docker volume.

If this parameter is not specified, and the Logger name is not specified, the logging output goes to standard out.

Use timestamp

If specified, and the File name parameter is also specified, the file name will be given a timestamp representing when the logging started.

Logger name

If specified, and the File name parameter is not specified, then this logger will be used for output. The specified name can be that of a pre-existing logger, or a new logger.


If specified, this string will be used as a template for the logging output entries.

Available variables:

  • $message: the message to be logged

  • $ts: a timestamp in the format yyyy-MM-dd HH:mm:ss.SSS

  • $user: the name of the database user, if available

  • $ip: the IP address of the database client

  • $thread: the ID of the thread running this filter

Packet types

A list of packet types to log, for instance SQLBatch,RPC.

If no packet types are specified, then all packets are logged.

Client IPs

A list of IP addresses (IP4 and/or IP6) and/or regular expressions for IP addresses. If specified, only requests from these IP addresses will be logged.



A list of user names and/or regular expressions for user names. If specified, only responses for these users will be logged.


If this option is checked, the logging will be more verbose.


A Java regular expression. If specified, only messages that satisfy this expression will be logged. For instance: .*(customer_id=44|customer_id=55).*