pythonjsonlogger.orjson 🔗

JSON Formatter using orjson

CLASS	DESCRIPTION
`OrjsonFormatter`	JSON formatter using orjson for encoding.

FUNCTION	DESCRIPTION
`orjson_default`	orjson default encoder function for non-standard types

OrjsonFormatter 🔗

OrjsonFormatter(
    *args,
    json_default: Optional[Callable] = orjson_default,
    json_indent: bool = False,
    **kwargs
)

JSON formatter using orjson for encoding.

PARAMETER	DESCRIPTION
`args`	see BaseJsonFormatter DEFAULT: `()`
`json_default`	a function for encoding non-standard objects TYPE: `Optional[Callable]` DEFAULT: `orjson_default`
`json_indent`	indent output with 2 spaces. TYPE: `bool` DEFAULT: `False`
`kwargs`	see BaseJsonFormatter DEFAULT: `{}`

METHOD	DESCRIPTION
`add_fields`	Extract fields from a LogRecord for logging
`format`	Formats a log record and serializes to json
`formatException`	Format and return the specified exception information.
`formatStack`	Format and return the specified stack information.
`jsonify_log_record`	Returns a json string of the log data.
`parse`	Parses format string looking for substitutions
`process_log_record`	Custom processing of the data to be logged.
`serialize_log_record`	Returns the final representation of the data to be logged

add_fields(
    log_data: Dict[str, Any],
    record: LogRecord,
    message_dict: Dict[str, Any],
) -> None

Extract fields from a LogRecord for logging

This method can be overridden to implement custom logic for adding fields.

PARAMETER	DESCRIPTION
`log_data`	data that will be logged TYPE: `Dict[str, Any]`
`record`	the record to extract data from TYPE: `LogRecord`
`message_dict`	dictionary that was logged instead of a message. e.g `logger.info({"is_this_message_dict": True})` TYPE: `Dict[str, Any]`

Changed in 4.0: log_record renamed to log_data

format(record: LogRecord) -> str

Formats a log record and serializes to json

PARAMETER	DESCRIPTION
`record`	the record to format TYPE: `LogRecord`

formatException(ei) -> Union[str, list[str]]

Format and return the specified exception information.

If exc_info_as_array is set to True, This method returns an array of strings.

formatStack(stack_info) -> Union[str, list[str]]

Format and return the specified stack information.

If stack_info_as_array is set to True, This method returns an array of strings.

jsonify_log_record(log_data: LogData) -> str

Returns a json string of the log data.

parse() -> List[str]

Parses format string looking for substitutions

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

You can support custom styles by overriding this method.

RETURNS	DESCRIPTION
`List[str]`	list of fields to be extracted and serialized

process_log_record(log_data: LogData) -> LogData

Custom processing of the data to be logged.

Child classes can override this method to alter the log record before it is serialized.

PARAMETER	DESCRIPTION
`log_data`	incoming data TYPE: `LogData`

Changed in 4.0: log_record renamed to log_data

serialize_log_record(log_data: LogData) -> str

Returns the final representation of the data to be logged

PARAMETER	DESCRIPTION
`log_data`	the data TYPE: `LogData`

Changed in 4.0: log_record renamed to log_data

orjson_default(obj: Any) -> Any

orjson default encoder function for non-standard types