Logging

logging_config

Logging configuration helpers for xpwebapi.

Classes:

• JsonLogFormatter –

  Format log records as one JSON object per line.

• LoggingConfig –

  Validated logging configuration.

• LoggingConfigFile –

  Top-level JSON config file schema.

Functions:

• configure_logging –

  Configure xpwebapi application and traffic logging explicitly.

• write_logging_config –

  Write a starter JSON logging config file.

JsonLogFormatter

              flowchart TD
              xpwebapi.logging_config.JsonLogFormatter[JsonLogFormatter]

              

              click xpwebapi.logging_config.JsonLogFormatter href "" "xpwebapi.logging_config.JsonLogFormatter"
            

Format log records as one JSON object per line.

LoggingConfig

              flowchart TD
              xpwebapi.logging_config.LoggingConfig[LoggingConfig]

              

              click xpwebapi.logging_config.LoggingConfig href "" "xpwebapi.logging_config.LoggingConfig"
            

Validated logging configuration.

LoggingConfigFile

              flowchart TD
              xpwebapi.logging_config.LoggingConfigFile[LoggingConfigFile]

              

              click xpwebapi.logging_config.LoggingConfigFile href "" "xpwebapi.logging_config.LoggingConfigFile"
            

Top-level JSON config file schema.

configure_logging

configure_logging(
    config_file: str | Path | None = None,
    *,
    format: Literal["text", "json"] | None = None,
    level: str | None = None,
    traffic_level: str | None = None,
    components: Mapping[str, str] | None = None,
    stream: TextIO | None = None,
) -> LoggingConfig

Configure xpwebapi application and traffic logging explicitly.

write_logging_config

write_logging_config(
    path: str | Path, *, config: LoggingConfig | None = None, overwrite: bool = False
) -> Path

Write a starter JSON logging config file.