bdd-trace 0.5.3__tar.gz → 0.5.5__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {bdd_trace-0.5.3 → bdd_trace-0.5.5}/PKG-INFO +1 -1
- {bdd_trace-0.5.3 → bdd_trace-0.5.5}/pyproject.toml +1 -1
- {bdd_trace-0.5.3 → bdd_trace-0.5.5}/src/bdd_trace/log.py +28 -16
- {bdd_trace-0.5.3 → bdd_trace-0.5.5}/src/bdd_trace/trace.py +15 -2
- {bdd_trace-0.5.3 → bdd_trace-0.5.5}/README.md +0 -0
- {bdd_trace-0.5.3 → bdd_trace-0.5.5}/src/bdd_trace/__init__.py +0 -0
- {bdd_trace-0.5.3 → bdd_trace-0.5.5}/src/bdd_trace/py.typed +0 -0
@@ -5,21 +5,25 @@ from queue import Queue
|
|
5
5
|
|
6
6
|
from opentelemetry.sdk._logs import LoggingHandler
|
7
7
|
|
8
|
-
from
|
8
|
+
from .trace import Profile, _get_profile
|
9
9
|
|
10
10
|
_log_queue: Queue | None = None
|
11
11
|
_log_listener: QueueListener | None = None
|
12
12
|
|
13
13
|
|
14
14
|
def setup_logging(
|
15
|
-
profile: Profile,
|
16
15
|
modules: list[str],
|
16
|
+
profile: Profile | None = None,
|
17
17
|
level: str | int = INFO,
|
18
18
|
enable_console_log: bool = True,
|
19
19
|
trace_id_format: str = "%(asctime)s|%(levelname)s|%(name)s|%(otelTraceID)s|%(message)s",
|
20
20
|
no_trace_id_format: str = "%(asctime)s|%(levelname)s|%(name)s|%(message)s",
|
21
21
|
extra_handlers: list[Handler] | None = None,
|
22
22
|
) -> None:
|
23
|
+
profile = _get_profile(profile)
|
24
|
+
if profile is None:
|
25
|
+
raise ValueError("profile is not set")
|
26
|
+
|
23
27
|
global _log_queue, _log_listener
|
24
28
|
if _log_queue is not None or _log_listener is not None:
|
25
29
|
raise RuntimeError("logging is already setup")
|
@@ -28,10 +32,14 @@ def setup_logging(
|
|
28
32
|
root_logger.handlers = []
|
29
33
|
|
30
34
|
_log_queue = Queue(1000)
|
35
|
+
log_process_handlers = extra_handlers or []
|
36
|
+
|
31
37
|
for module in modules:
|
32
|
-
_setup_module_logger(level, module)
|
38
|
+
origin_handlers = _setup_module_logger(level, module)
|
39
|
+
for handler in origin_handlers:
|
40
|
+
handler.addFilter(ModulePrefixFilter([module]))
|
41
|
+
log_process_handlers.append(handler)
|
33
42
|
|
34
|
-
log_process_handlers = extra_handlers or []
|
35
43
|
if enable_console_log:
|
36
44
|
format = trace_id_format if profile != Profile.NO_TRACE else no_trace_id_format
|
37
45
|
console_handler = _create_console_handler(modules, format)
|
@@ -52,26 +60,28 @@ def stop_logging() -> None:
|
|
52
60
|
_log_queue = None
|
53
61
|
|
54
62
|
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
self.module_prefixes_with_dot: tuple[str, ...] = tuple(f"{prefix}." for prefix in module_prefixes)
|
63
|
+
class ModulePrefixFilter:
|
64
|
+
def __init__(self, module_prefixes: list[str]):
|
65
|
+
self.module_prefixes: set[str] = set(module_prefixes)
|
66
|
+
self.module_prefixes_with_dot: tuple[str, ...] = tuple(f"{prefix}." for prefix in module_prefixes)
|
60
67
|
|
61
|
-
|
62
|
-
|
68
|
+
def filter(self, record: LogRecord) -> bool:
|
69
|
+
return record.name in self.module_prefixes or record.name.startswith(self.module_prefixes_with_dot)
|
63
70
|
|
71
|
+
|
72
|
+
class SingleLineFormatter(Formatter):
|
73
|
+
def formatMessage(self, record: LogRecord) -> str:
|
74
|
+
return super().formatMessage(record).replace("\n", " ").replace("\r", "")
|
75
|
+
|
76
|
+
|
77
|
+
def _create_console_handler(modules: list[str], format: str) -> Handler:
|
64
78
|
handler = StreamHandler(sys.stderr)
|
65
79
|
handler.setFormatter(Formatter(format))
|
66
80
|
handler.addFilter(ModulePrefixFilter(modules))
|
67
81
|
return handler
|
68
82
|
|
69
83
|
|
70
|
-
def _setup_module_logger(level: str | int, module: str) ->
|
71
|
-
class SingleLineFormatter(Formatter):
|
72
|
-
def formatMessage(self, record: LogRecord) -> str:
|
73
|
-
return super().formatMessage(record).replace("\n", " ").replace("\r", "")
|
74
|
-
|
84
|
+
def _setup_module_logger(level: str | int, module: str) -> list[Handler]:
|
75
85
|
logger = getLogger(module)
|
76
86
|
logger.setLevel(level)
|
77
87
|
logger.propagate = False
|
@@ -81,4 +91,6 @@ def _setup_module_logger(level: str | int, module: str) -> None:
|
|
81
91
|
raise RuntimeError("log queue is not initialized")
|
82
92
|
handler = QueueHandler(queue)
|
83
93
|
handler.setFormatter(SingleLineFormatter())
|
94
|
+
origin_handlers = logger.handlers
|
84
95
|
logger.handlers = [handler]
|
96
|
+
return origin_handlers or []
|
@@ -12,6 +12,7 @@ class Profile(str, Enum):
|
|
12
12
|
PROD = "prod"
|
13
13
|
|
14
14
|
|
15
|
+
_TRACE_PROFILE_KEY = "BDD_TRACE_PROFILE"
|
15
16
|
_TRACES_EXPORTER_KEY = "traces_exporter"
|
16
17
|
_METRICS_EXPORTER_KEY = "metrics_exporter"
|
17
18
|
_LOGS_EXPORTER_KEY = "logs_exporter"
|
@@ -73,9 +74,9 @@ def init_trace(
|
|
73
74
|
for key, value in kwargs.items():
|
74
75
|
_set_env(key, value)
|
75
76
|
|
76
|
-
if profile:
|
77
|
+
if profile := _get_profile(profile):
|
77
78
|
if profile == Profile.NO_TRACE:
|
78
|
-
logger.
|
79
|
+
logger.info("NO_TRACE profile is set, skip auto instrumentation")
|
79
80
|
return
|
80
81
|
for key, value in _profile_config[profile].items():
|
81
82
|
_set_env(key, value)
|
@@ -95,6 +96,18 @@ def init_trace(
|
|
95
96
|
auto_instrumentation.initialize()
|
96
97
|
|
97
98
|
|
99
|
+
def _get_profile(profile: Profile | None) -> Profile | None:
|
100
|
+
if profile:
|
101
|
+
return profile
|
102
|
+
profile_env = os.getenv(_TRACE_PROFILE_KEY)
|
103
|
+
if profile_env:
|
104
|
+
try:
|
105
|
+
return Profile(profile_env)
|
106
|
+
except ValueError:
|
107
|
+
raise ValueError(f"invalid profile from env {_TRACE_PROFILE_KEY}: {profile_env}")
|
108
|
+
return None
|
109
|
+
|
110
|
+
|
98
111
|
def _set_env(key: str, value: str | None) -> None:
|
99
112
|
if value is None:
|
100
113
|
return
|
File without changes
|
File without changes
|
File without changes
|