logging_utilities Módulo

Módulo de utilidad para el registro.

Funciones

function_debug_log_wrapped

Agregue el contenedor de registros alrededor de la función de clase del transformador.

function_debug_log_wrapped(log_level: int = 10) -> Callable[[Callable[[...], Any]], Callable[[...], Any]]

Parámetros

Nombre	Description
log_level	Valor predeterminado: 10

get_logger

Cree el registrador con el enlace de telemetría.

get_logger(namespace: str | None = None, filename: str | None = None, verbosity: int = 10, extra_handlers: List[Handler] | None = None, component_name: str | None = None) -> Logger

Parámetros

Nombre	Description
namespace	El espacio de nombres para el registrador. Valor predeterminado: None
filename	El nombre del archivo de registro. Valor predeterminado: None
verbosity	El nivel de detalle de registro. Valor predeterminado: 10
extra_handlers	Cualquier controlador adicional que se asocian al registrador. Valor predeterminado: None
component_name	nombre de componente Valor predeterminado: None

Devoluciones

Tipo	Description
	El registrador, si se proporcionan el nombre del archivo de registro y el espacio de nombres; de lo contrario, el registrador null.

is_exception_stacktrace_loggable

is_exception_stacktrace_loggable() -> bool

is_non_automl_exception_allowed

is_non_automl_exception_allowed(exception: BaseException) -> bool

Parámetros

Nombre	Description
exception Requerido

is_path_allowed

is_path_allowed(exception_path: str) -> bool

Parámetros

Nombre	Description
exception_path Requerido

is_stdlib_module

Determine si se trata de un módulo incluido con Python.

is_stdlib_module(exception_path: str) -> bool

Parámetros

Nombre	Description
exception_path Requerido

log_activity

Registre el estado de la actividad con la duración.

log_activity(logger: Logger, activity_name: str, activity_type: str | None = None, custom_dimensions: Dict[str, Any] | None = None) -> Iterator[Any | None]

Parámetros

Nombre	Description
logger Requerido	logger
activity_name Requerido	El nombre de la actividad.
activity_type Requerido	El tipo de actividad.
custom_dimensions Requerido	Las dimensiones personalizadas.

log_system_info

Registre información de la CPU, memoria y el sistema operativo.

log_system_info(logger: Logger, prefix_message: str = '') -> None

Parámetros

Nombre	Description
logger Requerido	El objeto del registrador.
prefix_message Requerido	La cadena que está en el prefijo en el registro

Devoluciones

Tipo	Description
	None

log_traceback

Registro de seguimientos de excepciones.

log_traceback(exception: BaseException, logger: Logger | LoggerAdapter | None, override_error_msg: str | None = None, is_critical: bool | None = True, tb: Any | None = None) -> None

Parámetros

Nombre	Description
exception Requerido	Excepción que se va a registrar.
logger Requerido	El registrador que se va a usar.
override_error_msg	El mensaje que se va a mostrar y que invalidará el mensaje de error actual. Valor predeterminado: None
is_critical	Si is_critical, el registrador usará log.critical; de lo contrario, log.error. Valor predeterminado: True
tb	El seguimiento que se usará para el registro; si no se proporciona, se usa el asociado a la excepción. Valor predeterminado: None

mark_package_exceptions_as_loggable

mark_package_exceptions_as_loggable(module: module) -> None

Parámetros

Nombre	Description
module Requerido

mark_path_as_loggable

mark_path_as_loggable(path: str) -> None

Parámetros

Nombre	Description
path Requerido

mark_path_as_not_loggable

mark_path_as_not_loggable(path: str) -> None

Parámetros

Nombre	Description
path Requerido

remove_blacklisted_logging_keys_from_dict

Quite de forma recursiva la clave de dict.

remove_blacklisted_logging_keys_from_dict(dict_obj: Dict[str, Any]) -> None

Parámetros

Nombre	Description
dict_obj Requerido

remove_blacklisted_logging_keys_from_json_str

Quite de forma recursiva la clave de json str y devuelva str json.

remove_blacklisted_logging_keys_from_json_str(json_str: str) -> str

Parámetros

Nombre	Description
json_str Requerido