pi_portal.modules.configuration.logging.formatters.json

JsonFormatter class.

class pi_portal.modules.configuration.logging.formatters.json.JsonFormatter(trace_id, *args, **kwargs)

JSON log formatter.

Parameters:

• trace_id (str) – The unique uuid for this process instance.

• args (Any) –

• kwargs (Any) –

add_fields(log_record, record, message_dict)

Add custom fields to the base JsonFormatter.

Parameters:

• log_record (Dict[str, Any]) – The Python object that will be converted to JSON.

• record (LogRecord) – The Python LogRecord object generated.

• message_dict (Dict[str, Optional[str]]) – The existing message fields configuration.

Return type:

None

converter()

localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,

tm_sec,tm_wday,tm_yday,tm_isdst)

Convert seconds since the Epoch to a time tuple expressing local time. When ‘seconds’ is not passed in, convert the current time instead.

format(record)

Formats a log record and serializes to json

formatException(ei)

Format and return the specified exception information as a string.

This default implementation just uses traceback.print_exception()

formatStack(stack_info)

This method is provided as an extension point for specialized formatting of stack information.

The input data is a string as returned from a call to traceback.print_stack(), but with the last trailing newline removed.

The base implementation just returns the value passed in.

formatTime(record, datefmt=None)

Return the creation time of the specified LogRecord as formatted text.

This method should be called from format() by a formatter which wants to make use of a formatted time. This method can be overridden in formatters to provide for any specific requirement, but the basic behaviour is as follows: if datefmt (a string) is specified, it is used with time.strftime() to format the creation time of the record. Otherwise, an ISO8601-like (or RFC 3339-like) format is used. The resulting string is returned. This function uses a user-configurable function to convert the creation time to a tuple. By default, time.localtime() is used; to change this for a particular formatter instance, set the ‘converter’ attribute to a function with the same signature as time.localtime() or time.gmtime(). To change it for all formatters, for example if you want all logging times to be shown in GMT, set the ‘converter’ attribute in the Formatter class.

jsonify_log_record(log_record)

Returns a json string of the log record.

parse()

Parses format string looking for substitutions

This method is responsible for returning a list of fields (as strings) to include in all log messages.

process_log_record(log_record)

Override this method to implement custom logic on the possibly ordered dictionary.

serialize_log_record(log_record)

Returns the final representation of the log record.

usesTime()

Check if the format uses the creation time of the record.