Partager via

logging_utilities Module

  • Référence

Module utilitaire utilisé pour la journalisation.

Functions

function_debug_log_wrapped

Ajouter un wrapper de journaux autour de la fonction de classe de transformateur.

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

Paramètres

Nom Description
log_level
Valeur par défaut: 10

get_logger

Créer l’enregistreur d’événements avec un hook de télémétrie.

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

Paramètres

Nom Description
namespace

Espace de noms pour l’enregistreur d’événements

Valeur par défaut: None
filename

Nom du fichier journal

Valeur par défaut: None
verbosity

Verbosité de la journalisation

Valeur par défaut: 10
extra_handlers

Gestionnaires supplémentaires à attacher à l’enregistreur d’événements

Valeur par défaut: None
component_name

nom du composant

Valeur par défaut: None

Retours

Type Description

Enregistreur d’événements si le nom du fichier journal et l’espace de noms sont fournis, sinon enregistreur d’événements Null

is_exception_stacktrace_loggable 

is_exception_stacktrace_loggable() -> bool

is_non_automl_exception_allowed 

is_non_automl_exception_allowed(exception: BaseException) -> bool

Paramètres

Nom Description
exception
Obligatoire

is_path_allowed 

is_path_allowed(exception_path: str) -> bool

Paramètres

Nom Description
exception_path
Obligatoire

is_stdlib_module

Déterminer s’il s’agit d’un module fourni avec Python.

is_stdlib_module(exception_path: str) -> bool

Paramètres

Nom Description
exception_path
Obligatoire

log_activity

Consigner l’état de l’activité avec la durée.

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

Paramètres

Nom Description
logger
Obligatoire

logger
activity_name
Obligatoire

Nom de l’activité
activity_type
Obligatoire

Type d’activité
custom_dimensions
Obligatoire

Dimensions personnalisées

log_system_info

Consigner les informations sur le processeur, la mémoire et le système d’exploitation.

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

Paramètres

Nom Description
logger
Obligatoire

Objet Logger
prefix_message
Obligatoire

Chaîne située dans le préfixe du journal

Retours

Type Description

None

log_traceback

Journaliser les traces d’exception.

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

Paramètres

Nom Description
exception
Obligatoire

Exception à consigner.
logger
Obligatoire

Enregistreur d'événements à utiliser.
override_error_msg

Message à afficher pour remplacer le error_msg actuel.

Valeur par défaut: None
is_critical

Si la valeur est is_critical, l’enregistreur d’événements utilise log.critical, sinon log.error.

Valeur par défaut: True
tb

Traceback à utiliser pour la journalisation ; s’il n’est pas fourni, l’élément attaché à l’exception est utilisé.

Valeur par défaut: None

mark_package_exceptions_as_loggable 

mark_package_exceptions_as_loggable(module: module) -> None

Paramètres

Nom Description
module
Obligatoire

mark_path_as_loggable 

mark_path_as_loggable(path: str) -> None

Paramètres

Nom Description
path
Obligatoire

mark_path_as_not_loggable 

mark_path_as_not_loggable(path: str) -> None

Paramètres

Nom Description
path
Obligatoire

remove_blacklisted_logging_keys_from_dict

Supprimer de manière récursive la clé d’un dictionnaire.

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

Paramètres

Nom Description
dict_obj
Obligatoire

remove_blacklisted_logging_keys_from_json_str

Supprimer de manière récursive la clé d’une chaîne json et retourner une chaîne json.

remove_blacklisted_logging_keys_from_json_str(json_str: str) -> str

Paramètres

Nom Description
json_str
Obligatoire