logging_utilities Módulo

Módulo do utilitário para registro em log.

Funções

function_debug_log_wrapped

Adicione o wrapper de logs em volta da função de classe transformadora.

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

Parâmetros

Nome	Description
log_level	Valor padrão: 10

get_logger

Crie o agente com o gancho de telemetria.

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

Nome	Description
namespace	O namespace do agente Valor padrão: None
filename	Nome do arquivo de log Valor padrão: None
verbosity	Detalhamento do log Valor padrão: 10
extra_handlers	qualquer manipulador extra para anexar ao agente Valor padrão: None
component_name	nome de componente Valor padrão: None

Retornos

Tipo	Description
	agente se o nome e o namespace do arquivo de log forem fornecidos, caso contrário, agente nulo

is_exception_stacktrace_loggable

is_exception_stacktrace_loggable() -> bool

is_non_automl_exception_allowed

is_non_automl_exception_allowed(exception: BaseException) -> bool

Parâmetros

Nome	Description
exception Obrigatório

is_path_allowed

is_path_allowed(exception_path: str) -> bool

Parâmetros

Nome	Description
exception_path Obrigatório

is_stdlib_module

Determine se este é um módulo fornecido com o Python.

is_stdlib_module(exception_path: str) -> bool

Parâmetros

Nome	Description
exception_path Obrigatório

log_activity

Registra o status da atividade com a duração.

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

Parâmetros

Nome	Description
logger Obrigatório	agente
activity_name Obrigatório	nome da atividade
activity_type Obrigatório	tipo de atividade
custom_dimensions Obrigatório	dimensões personalizadas

log_system_info

Registra informações de CPU, memória e SO.

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

Parâmetros

Nome	Description
logger Obrigatório	objeto de agente
prefix_message Obrigatório	Cadeia de caracteres que está no prefixo no log

Retornos

Tipo	Description
	Nenhum

log_traceback

Registra rastreamentos de exceção.

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

Nome	Description
exception Obrigatório	A exceção do log.
logger Obrigatório	O agente a ser usado.
override_error_msg	A mensagem a ser exibida que substituirá a error_msg atual. Valor padrão: None
is_critical	Se is_critical, o agente usará log.critical, caso contrário, log.error. Valor padrão: True
tb	O controle a ser usado para registro em log; se não for fornecido, aquele anexado à exceção será usado. Valor padrão: None

mark_package_exceptions_as_loggable

mark_package_exceptions_as_loggable(module: module) -> None

Parâmetros

Nome	Description
module Obrigatório

mark_path_as_loggable

mark_path_as_loggable(path: str) -> None

Parâmetros

Nome	Description
path Obrigatório

mark_path_as_not_loggable

mark_path_as_not_loggable(path: str) -> None

Parâmetros

Nome	Description
path Obrigatório

remove_blacklisted_logging_keys_from_dict

Remove recursivamente a chave de um dicionário.

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

Parâmetros

Nome	Description
dict_obj Obrigatório

remove_blacklisted_logging_keys_from_json_str

Remove recursivamente a chave de um str json e retorna um json str.

remove_blacklisted_logging_keys_from_json_str(json_str: str) -> str

Parâmetros

Nome	Description
json_str Obrigatório