Logger

class Logger(**properties: Any)

Superclasses: Object

Implemented Interfaces: SessionFeature

Debug logging support

Logger watches a Session and logs the HTTP traffic that it generates, for debugging purposes. Many applications use an environment variable to determine whether or not to use Logger, and to determine the amount of debugging output.

To use Logger, first create a logger with new, optionally configure it with set_request_filter, set_response_filter, and set_printer, and then attach it to a session (or multiple sessions) with add_feature.

By default, the debugging output is sent to stdout, and looks something like:

> POST /unauth HTTP/1.1
> Soup-Debug-Timestamp: 1200171744
> Soup-Debug: SoupSession 1 (0x612190), SoupMessage 1 (0x617000), GSocket 1 (0x612220)
> Host: localhost
> Content-Type: text/plain
> Connection: close

&lt; HTTP/1.1 201 Created
&lt; Soup-Debug-Timestamp: 1200171744
&lt; Soup-Debug: SoupMessage 1 (0x617000)
&lt; Date: Sun, 12 Jan 2008 21:02:24 GMT
&lt; Content-Length: 0

The Soup-Debug-Timestamp line gives the time (as a time_t) when the request was sent, or the response fully received.

The Soup-Debug line gives further debugging information about the Session, Message, and Socket involved; the hex numbers are the addresses of the objects in question (which may be useful if you are running in a debugger). The decimal IDs are simply counters that uniquely identify objects across the lifetime of the Logger. In particular, this can be used to identify when multiple messages are sent across the same connection.

Currently, the request half of the message is logged just before the first byte of the request gets written to the network (from the starting signal).

The response is logged just after the last byte of the response body is read from the network (from the got_body or got_informational signal), which means that the got_headers signal, and anything triggered off it (such as Message::authenticate) will be emitted before the response headers are actually logged.

If the response doesn’t happen to trigger the got_body nor got_informational signals due to, for example, a cancellation before receiving the last byte of the response body, the response will still be logged on the event of the finished signal.

Constructors

class Logger

classmethod new(level: LoggerLogLevel) → Logger

Creates a new Logger with the given debug level.

If you need finer control over what message parts are and aren’t logged, use set_request_filter and set_response_filter.

Parameters:: level – the debug level

Methods

class Logger

get_max_body_size() → int: Get the maximum body size for logger.

set_max_body_size(max_body_size: int) → None

Sets the maximum body size for logger (-1 means no limit).

Parameters:: max_body_size – the maximum body size to log

set_printer(printer: Callable[[...], None], *printer_data: Any) → None

Sets up an alternate log printing routine, if you don’t want the log to go to stdout.

Parameters:

printer – the callback for printing logging output
printer_data – data to pass to the callback

set_request_filter(request_filter: Callable[[...], LoggerLogLevel], *filter_data: Any) → None

Sets up a filter to determine the log level for a given request.

For each HTTP request logger will invoke request_filter to determine how much (if any) of that request to log. (If you do not set a request filter, logger will just always log requests at the level passed to new.)

Parameters:

request_filter – the callback for request debugging
filter_data – data to pass to the callback

set_response_filter(response_filter: Callable[[...], LoggerLogLevel], *filter_data: Any) → None

Sets up a filter to determine the log level for a given response.

For each HTTP response logger will invoke response_filter to determine how much (if any) of that response to log. (If you do not set a response filter, logger will just always log responses at the level passed to new.)

Parameters:

response_filter – the callback for response debugging
filter_data – data to pass to the callback

Properties

class Logger

props.level: LoggerLogLevel: The level of logging output.

props.max_body_size: int: If level is BODY, this gives the maximum number of bytes of the body that will be logged. (-1 means “no limit”.)