Freigeben über

logging_utilities Modul

  • Referenz

Hilfsprogrammmodul für die Protokollierung.

Functions

function_debug_log_wrapped

Hinzufügen eines Protokollwrappers für die Transformatorklassenfunktion.

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

Parameter

Name Beschreibung
log_level
Standardwert: 10

get_logger

Erstellen der Protokollierung mit Telemetriehook.

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

Parameter

Name Beschreibung
namespace

Der Namespace für die Protokollierung.

Standardwert: None
filename

Protokolldateiname

Standardwert: None
verbosity

Protokollierungsausführlichkeit

Standardwert: 10
extra_handlers

Zusätzliche Handler, die ggf. an die Protokollierung angefügt werden sollen.

Standardwert: None
component_name

Komponentenname

Standardwert: None

Gibt zurück

Typ Beschreibung

Protokollierung, falls Protokolldateiname und Namespace angegeben wurden. Andernfalls keine Protokollierung.

is_exception_stacktrace_loggable 

is_exception_stacktrace_loggable() -> bool

is_non_automl_exception_allowed 

is_non_automl_exception_allowed(exception: BaseException) -> bool

Parameter

Name Beschreibung
exception
Erforderlich

is_path_allowed 

is_path_allowed(exception_path: str) -> bool

Parameter

Name Beschreibung
exception_path
Erforderlich

is_stdlib_module

Ermitteln, ob es sich um ein Modul handelt, das mit Python bereitgestellt wird.

is_stdlib_module(exception_path: str) -> bool

Parameter

Name Beschreibung
exception_path
Erforderlich

log_activity

Protokollieren des Aktivitätsstatus mit Dauer.

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

Parameter

Name Beschreibung
logger
Erforderlich

Protokollierungstool
activity_name
Erforderlich

Aktivitätsname
activity_type
Erforderlich

Aktivitätstyp
custom_dimensions
Erforderlich

Benutzerdefinierte Dimensionen.

log_system_info

Protokollieren von CPU-, Arbeitsspeicher- und Betriebssysteminformationen.

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

Parameter

Name Beschreibung
logger
Erforderlich

Protokollierungsobjekt
prefix_message
Erforderlich

Zeichenfolge, die im Protokoll als Präfix verwendet wird.

Gibt zurück

Typ Beschreibung

Keine

log_traceback

Protokollieren von Ausnahmeablaufverfolgungen.

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

Parameter

Name Beschreibung
exception
Erforderlich

Die zu protokollierende Ausnahme.
logger
Erforderlich

Die zu verwendende Protokollierung.
override_error_msg

Die anzuzeigende Meldung. Überschreibt die aktuelle Fehlermeldung (error_msg).

Standardwert: None
is_critical

Bei „is_critical“ verwendet die Protokollierung „log.critical“. Andernfalls wird „log.error“ verwendet.

Standardwert: True
tb

Die Rückverfolgung, die für die Protokollierung verwendet werden soll. Ohne Angabe wird die an die Ausnahme angefügte Rückverfolgung verwendet.

Standardwert: None

mark_package_exceptions_as_loggable 

mark_package_exceptions_as_loggable(module: module) -> None

Parameter

Name Beschreibung
module
Erforderlich

mark_path_as_loggable 

mark_path_as_loggable(path: str) -> None

Parameter

Name Beschreibung
path
Erforderlich

mark_path_as_not_loggable 

mark_path_as_not_loggable(path: str) -> None

Parameter

Name Beschreibung
path
Erforderlich

remove_blacklisted_logging_keys_from_dict

Rekursives Entfernen des Schlüssels aus einem Wörterbuch.

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

Parameter

Name Beschreibung
dict_obj
Erforderlich

remove_blacklisted_logging_keys_from_json_str

Rekursives Entfernen des Schlüssels aus einer JSON-Zeichenfolge und Zurückgeben eines JSON-Zeichenfolge.

remove_blacklisted_logging_keys_from_json_str(json_str: str) -> str

Parameter

Name Beschreibung
json_str
Erforderlich