structlog_sentry_logger._config
ο
Module Contentsο
Classesο
Functionsο
|
|
A custom processor for structlog for Cloud Logging compatibility. |
|
Convenience function to get the local logging configuration dictionary,. |
|
|
Builds logfile handler configs. |
|
|
|
Convenience function that returns a logger. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Attributesο
CamelCase alias for structlog_sentry_logger.get_logger. |
|
- class structlog_sentry_logger._config.Config[source]ο
- stdlib_logging_config_already_configured = Falseο
- use_orjson = Trueο
- structlog_sentry_logger._config.add_line_number_and_func_name(logger, method, event_dict)[source]ο
- Parameters:
logger (Any) β
method (str) β
event_dict (structlog.types.EventDict) β
- Return type:
structlog.types.EventDict
- structlog_sentry_logger._config.add_severity_field_from_level_if_in_cloud_environment(logger, method, event_dict)[source]ο
A custom processor for structlog for Cloud Logging compatibility.
Since Cloud Logging infers log levels from the severity key, simply duplicates level to the severity field in the loggerβs event dictionary.
- Parameters:
logger (Any) β
method (str) β
event_dict (structlog.types.EventDict) β
- Return type:
structlog.types.EventDict
- structlog_sentry_logger._config.get_config_dict()[source]ο
Convenience function to get the local logging configuration dictionary,.
e.g., to help configure loggers from other libraries.
Returns: The logging configuration dictionary that would be used to configure the Python logging library component of the logger
- Return type:
- structlog_sentry_logger._config.get_dev_local_filename_handler(module_name)[source]ο
Builds logfile handler configs.
Before building the logfile handler configurations, this function attempts to initialize the log directory in the (inferred) application root directory. If this fails (for example, if the directory is read-only), it will fall back to a platform-specific temp directory. If this too fails, it will exit without creating the logfile handler configuration.
- Args:
module_name: the name of the calling module which will be incorporated in the logfile file name to provide better log provenance.
Returns: logfile handler configurations if log directories are writeable, else None
- structlog_sentry_logger._config.get_logger(name=None)[source]ο
Convenience function that returns a logger.
Returns: A proxy that creates a correctly configured logger bound to the __name__ of the calling module
- Parameters:
name (str | None) β
- Return type:
Any
- structlog_sentry_logger._config.get_namespaced_module_name(__file__)[source]ο
- Parameters:
__file__ (pathlib.Path | str) β
- Return type:
- structlog_sentry_logger._config.mkdir_logs_dir(log_data_dir)[source]ο
- Parameters:
log_data_dir (pathlib.Path) β
- Return type:
- structlog_sentry_logger._config.serializer(*args, default=None, option=orjson.OPT_NON_STR_KEYS | orjson.OPT_SORT_KEYS)[source]ο
- structlog_sentry_logger._config.serializer_bytes(*args, default=None, option=orjson.OPT_NON_STR_KEYS | orjson.OPT_SORT_KEYS)[source]ο
- structlog_sentry_logger._config.set_logging_config(module_name)[source]ο
- Parameters:
module_name (str) β
- Return type:
None
- structlog_sentry_logger._config.ROOT_DIRο
- structlog_sentry_logger._config.SentryBreadcrumbJsonProcessorο
- structlog_sentry_logger._config.getLoggerο
CamelCase alias for structlog_sentry_logger.get_logger.
- structlog_sentry_logger._config.gitο