反馈

logging_utilities 模块

  • 参考

用于记录的实用程序模块。

函数

function_debug_log_wrapped

在转换器类函数周围添加日志包装器。

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

参数

log_level
默认值: 10

get_logger

使用遥测挂钩创建记录器。

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

参数

namespace
默认值: None

记录器的命名空间

filename
默认值: None

日志文件名称

verbosity
默认值: 10

日志记录详细程度

extra_handlers
默认值: None

要附加到记录器的任何额外的处理程序

component_name
默认值: None

组件名

返回

如果提供了日志文件名和命名空间，则为 logger，否则为 null logger

is_exception_stacktrace_loggable 

is_exception_stacktrace_loggable() -> bool

is_non_automl_exception_allowed 

is_non_automl_exception_allowed(exception: BaseException) -> bool

参数

exception

is_path_allowed 

is_path_allowed(exception_path: str) -> bool

参数

exception_path

is_stdlib_module

确定此模块是否是 Python 随附的模块。

is_stdlib_module(exception_path: str) -> bool

参数

exception_path
必需

log_activity

记录具有持续时间的活动状态。

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

参数

logger
必需

logger

activity_name
必需

活动名称

activity_type
必需

活动类型

custom_dimensions
必需

自定义维度

log_system_info

记录 CPU、内存和 OS 信息。

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

参数

logger
必需

logger 对象

prefix_message
必需

日志中前缀中的字符串

返回

无

log_traceback

记录异常跟踪。

log_traceback(exception: BaseException, logger: Optional[Union[logging.Logger, logging.LoggerAdapter]], override_error_msg: Optional[str] = None, is_critical: Optional[bool] = True, tb: Optional[Any] = None) -> None

参数

exception
必需

要记录的异常。

logger
必需

要使用的记录器。

override_error_msg
默认值: None

要显示的消息将替代当前的 error_msg。

is_critical
默认值: True

如果为 is_critical，记录器将使用 log.critical，否则使用 log.error。

tb
默认值: None

要用于日志记录的回溯；如果未提供，则使用附加到异常的回溯。

mark_package_exceptions_as_loggable 

mark_package_exceptions_as_loggable(module: module) -> None

参数

module

mark_path_as_loggable 

mark_path_as_loggable(path: str) -> None

参数

path

mark_path_as_not_loggable 

mark_path_as_not_loggable(path: str) -> None

参数

path

remove_blacklisted_logging_keys_from_dict

以递归方式从字典中删除键。

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

参数

dict_obj

remove_blacklisted_logging_keys_from_json_str

以递归方式从 JSON 字符串中删除键并返回一个 JSON 字符串。

remove_blacklisted_logging_keys_from_json_str(json_str: str) -> str

参数

json_str