Condividi tramite

logging_utilities Modulo

  • Riferimento

Modulo di utilità per la registrazione.

Funzioni

function_debug_log_wrapped

Aggiungere il wrapper dei log intorno alla funzione di classe trasformatore.

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

Parametri

Nome Descrizione
log_level
Valore predefinito: 10

get_logger

Creare il logger con l'hook di 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

Parametri

Nome Descrizione
namespace

Spazio dei nomi per il logger

Valore predefinito: None
filename

nome file di log

Valore predefinito: None
verbosity

registrazione dettagliata

Valore predefinito: 10
extra_handlers

eventuali gestori aggiuntivi da collegare al logger

Valore predefinito: None
component_name

nome componente

Valore predefinito: None

Restituisce

Tipo Descrizione

logger se il nome del file di log e lo spazio dei nomi vengono forniti altrimenti null logger

is_exception_stacktrace_loggable 

is_exception_stacktrace_loggable() -> bool

is_non_automl_exception_allowed 

is_non_automl_exception_allowed(exception: BaseException) -> bool

Parametri

Nome Descrizione
exception
Necessario

is_path_allowed 

is_path_allowed(exception_path: str) -> bool

Parametri

Nome Descrizione
exception_path
Necessario

is_stdlib_module

Determinare se si tratta di un modulo fornito con Python.

is_stdlib_module(exception_path: str) -> bool

Parametri

Nome Descrizione
exception_path
Necessario

log_activity

Registrare lo stato dell'attività con durata.

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

Parametri

Nome Descrizione
logger
Necessario

logger
activity_name
Necessario

nome attività
activity_type
Necessario

tipo di attività
custom_dimensions
Necessario

dimensioni personalizzate

log_system_info

Registrare le informazioni sulla cpu, sulla memoria e sul sistema operativo.

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

Parametri

Nome Descrizione
logger
Necessario

Oggetto logger
prefix_message
Necessario

stringa che nel prefisso nel log

Restituisce

Tipo Descrizione

Nessuno

log_traceback

Tracce delle eccezioni di log.

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

Parametri

Nome Descrizione
exception
Necessario

Eccezione da registrare.
logger
Necessario

Logger da usare.
override_error_msg

Messaggio da visualizzare che eseguirà l'override del error_msg corrente.

Valore predefinito: None
is_critical

Se is_critical, il logger userà log.critical, in caso contrario log.error.

Valore predefinito: True
tb

Traceback da usare per la registrazione; se non specificato, viene usato quello associato all'eccezione.

Valore predefinito: None

mark_package_exceptions_as_loggable 

mark_package_exceptions_as_loggable(module: module) -> None

Parametri

Nome Descrizione
module
Necessario

mark_path_as_loggable 

mark_path_as_loggable(path: str) -> None

Parametri

Nome Descrizione
path
Necessario

mark_path_as_not_loggable 

mark_path_as_not_loggable(path: str) -> None

Parametri

Nome Descrizione
path
Necessario

remove_blacklisted_logging_keys_from_dict

Rimuovere in modo ricorsivo la chiave da una dict.

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

Parametri

Nome Descrizione
dict_obj
Necessario

remove_blacklisted_logging_keys_from_json_str

Rimuovere in modo ricorsivo la chiave da un str json e restituire un str json.

remove_blacklisted_logging_keys_from_json_str(json_str: str) -> str

Parametri

Nome Descrizione
json_str
Necessario