bdd-trace 0.3.1__tar.gz → 0.4.0__tar.gz

{bdd_trace-0.3.1 → bdd_trace-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bdd-trace
-Version: 0.3.1
+Version: 0.4.0
 Summary: BDD项目日志和追踪SDK
 Author: 蔡涛
 Author-email: 蔡涛 <caitao@zhejianglab.cn>

{bdd_trace-0.3.1 → bdd_trace-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
   name = "bdd-trace"
-  version = "0.3.1"
+  version = "0.4.0"
   description = "BDD项目日志和追踪SDK"
   readme = "README.md"
   authors = [{ name = "蔡涛", email = "caitao@zhejianglab.cn" }]

bdd_trace-0.4.0/src/bdd_trace/__init__.py

@@ -0,0 +1,4 @@
+from .log import setup_logging, stop_logging
+from .trace import Profile, init_trace
+
+__all__ = ["init_trace", "Profile", "setup_logging", "stop_logging"]

bdd_trace-0.4.0/src/bdd_trace/log.py

@@ -0,0 +1,80 @@
+import sys
+from logging import INFO, Formatter, Handler, LogRecord, StreamHandler, getLogger
+from logging.handlers import QueueHandler, QueueListener
+from queue import Queue
+
+from opentelemetry.sdk._logs import LoggingHandler
+
+from bdd_trace.trace import Profile
+
+_log_queue: Queue | None = None
+_log_listener: QueueListener | None = None
+
+
+def setup_logging(
+    profile: Profile,
+    modules: list[str],
+    level: str | int = INFO,
+    trace_id_format: str = "%(asctime)s|%(levelname)s|%(name)s|%(otelTraceID)s|%(message)s",
+    no_trace_id_format: str = "%(asctime)s|%(levelname)s|%(name)s|%(message)s",
+) -> None:
+    global _log_queue, _log_listener
+    if _log_queue is not None or _log_listener is not None:
+        raise RuntimeError("logging is already setup")
+
+    root_logger = getLogger()
+    root_logger.handlers = []
+
+    _log_queue = Queue(1000)
+    for module in modules:
+        _setup_module_logger(level, module)
+
+    format = trace_id_format if profile == Profile.NO_TRACE else no_trace_id_format
+    console_handler = _create_console_handler(modules, format)
+    log_process_handlers = [console_handler]
+    if profile != Profile.NO_TRACE:
+        otel_handler = LoggingHandler()
+        log_process_handlers.append(otel_handler)
+
+    _log_listener = QueueListener(_log_queue, *log_process_handlers)
+    _log_listener.start()
+
+
+def stop_logging() -> None:
+    global _log_queue, _log_listener
+    if _log_listener is not None:
+        _log_listener.stop()
+    _log_listener = None
+    _log_queue = None
+
+
+def _create_console_handler(modules: list[str], format: str) -> Handler:
+    class ModulePrefixFilter:
+        def __init__(self, module_prefixes: list[str]):
+            self.module_prefixes: set[str] = set(module_prefixes)
+            self.module_prefixes_with_dot: tuple[str, ...] = tuple(f"{prefix}." for prefix in module_prefixes)
+
+        def filter(self, record: LogRecord) -> bool:
+            return record.name in self.module_prefixes or record.name.startswith(self.module_prefixes_with_dot)
+
+    handler = StreamHandler(sys.stderr)
+    handler.setFormatter(Formatter(format))
+    handler.addFilter(ModulePrefixFilter(modules))
+    return handler
+
+
+def _setup_module_logger(level: str | int, module: str) -> None:
+    class SingleLineFormatter(Formatter):
+        def formatMessage(self, record: LogRecord) -> str:
+            return super().formatMessage(record).replace("\n", " ").replace("\r", "")
+
+    logger = getLogger(module)
+    logger.setLevel(level)
+    logger.propagate = False
+
+    queue = _log_queue
+    if queue is None:
+        raise RuntimeError("log queue is not initialized")
+    handler = QueueHandler(queue)
+    handler.setFormatter(SingleLineFormatter())
+    logger.handlers = [handler]

bdd_trace-0.4.0/src/bdd_trace/trace.py

@@ -0,0 +1,108 @@
+import logging
+import os
+from enum import Enum
+
+from opentelemetry.instrumentation import auto_instrumentation
+
+
+class Profile(str, Enum):
+    NO_TRACE = "no_trace"
+    DEV = "dev"
+    TEST = "test"
+    PROD = "prod"
+
+
+_TRACES_EXPORTER_KEY = "traces_exporter"
+_METRICS_EXPORTER_KEY = "metrics_exporter"
+_LOGS_EXPORTER_KEY = "logs_exporter"
+_EXPORTER_OTLP_ENDPOINT_KEY = "exporter_otlp_endpoint"
+_EXPORTER_OTLP_INSECURE_KEY = "exporter_otlp_insecure"
+_SERVICE_NAME_KEY = "service_name"
+_PYTHON_FASTAPI_EXCLUDE_URLS_KEY = "python_fastapi_excluded_urls"
+_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST_KEY = "instrumentation_http_capture_headers_server_request"
+
+_default_envs = {
+    _TRACES_EXPORTER_KEY: "otlp",
+    _METRICS_EXPORTER_KEY: "otlp",
+    _LOGS_EXPORTER_KEY: "otlp",
+    _PYTHON_FASTAPI_EXCLUDE_URLS_KEY: "/healthCheck",
+    _INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST_KEY: "X-User-Id,X-Conversation-From",
+    _EXPORTER_OTLP_INSECURE_KEY: "true",
+}
+
+_profile_config = {
+    Profile.DEV: {
+        _TRACES_EXPORTER_KEY: "console",
+        _METRICS_EXPORTER_KEY: "console",
+        _LOGS_EXPORTER_KEY: "console",
+        _EXPORTER_OTLP_ENDPOINT_KEY: None,
+    },
+    Profile.TEST: {
+        _TRACES_EXPORTER_KEY: "otlp",
+        _METRICS_EXPORTER_KEY: "otlp",
+        _LOGS_EXPORTER_KEY: "otlp",
+        _EXPORTER_OTLP_ENDPOINT_KEY: "http://otel-sls-collector:4317",
+    },
+    Profile.PROD: {
+        _TRACES_EXPORTER_KEY: "otlp",
+        _METRICS_EXPORTER_KEY: "otlp",
+        _LOGS_EXPORTER_KEY: "otlp",
+        _EXPORTER_OTLP_ENDPOINT_KEY: "http://otel-sls-collector:4317",
+    },
+}
+
+logger = logging.getLogger(__name__)
+
+
+def init_trace(
+    *,
+    service_name: str | None = None,
+    profile: Profile | None = None,
+    exporter_otlp_endpoint: str | None = None,
+    **kwargs,
+) -> None:
+    # 设置环境变量，优先级：环境变量 > 参数 > profile 配置 > 默认配置
+    for key, value in kwargs.items():
+        _set_env(key, value)
+
+    if profile:
+        if profile == Profile.NO_TRACE:
+            logger.debug("NO_TRACE profile is set, skip auto instrumentation")
+            return
+        for key, value in _profile_config[profile].items():
+            _set_env(key, value)
+    elif exporter_otlp_endpoint:
+        _set_env(_EXPORTER_OTLP_ENDPOINT_KEY, exporter_otlp_endpoint)
+    else:
+        raise ValueError("either profile or exporter_otlp_endpoint is required")
+
+    if service_name:
+        _set_env(_SERVICE_NAME_KEY, service_name)
+    elif _get_env(_SERVICE_NAME_KEY) is None:
+        raise ValueError("service_name is required")
+
+    for key, value in _default_envs.items():
+        _set_env(key, value)
+
+    auto_instrumentation.initialize()
+
+
+def _set_env(key: str, value: str | None) -> None:
+    if value is None:
+        return
+
+    env_key = _convert_to_env_key(key)
+    if existing_value := os.getenv(env_key):
+        logger.info(f"existing env {env_key}={existing_value}")
+    else:
+        logger.debug(f"set env {env_key}={value}")
+        os.environ[env_key] = value
+
+
+def _get_env(key: str) -> str | None:
+    env_key = _convert_to_env_key(key)
+    return os.getenv(env_key)
+
+
+def _convert_to_env_key(key: str) -> str:
+    return f"OTEL_{key.upper()}"

bdd_trace-0.3.1/src/bdd_trace/__init__.py

@@ -1,3 +0,0 @@
-from .trace import Profile, init_trace
-
-__all__ = ["init_trace", "Profile"]

bdd_trace-0.3.1/src/bdd_trace/trace.py

@@ -1,116 +0,0 @@
-import logging
-import os
-from enum import Enum
-
-from opentelemetry.instrumentation import auto_instrumentation
-from opentelemetry.sdk._logs import LoggingHandler
-
-
-class Profile(str, Enum):
-    NO_TRACE = "no_trace"
-    DEV = "dev"
-    TEST = "test"
-    PROD = "prod"
-
-
-TRACES_EXPORTER_KEY = "traces_exporter"
-METRICS_EXPORTER_KEY = "metrics_exporter"
-LOGS_EXPORTER_KEY = "logs_exporter"
-EXPORTER_OTLP_ENDPOINT_KEY = "exporter_otlp_endpoint"
-EXPORTER_OTLP_INSECURE_KEY = "exporter_otlp_insecure"
-SERVICE_NAME_KEY = "service_name"
-PYTHON_FASTAPI_EXCLUDE_URLS_KEY = "python_fastapi_excluded_urls"
-INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST_KEY = "instrumentation_http_capture_headers_server_request"
-
-default_envs = {
-    TRACES_EXPORTER_KEY: "otlp",
-    METRICS_EXPORTER_KEY: "otlp",
-    LOGS_EXPORTER_KEY: "otlp",
-    PYTHON_FASTAPI_EXCLUDE_URLS_KEY: "/healthCheck",
-    INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST_KEY: "X-User-Id,X-Conversation-From",
-    EXPORTER_OTLP_INSECURE_KEY: "true",
-}
-
-profile_config = {
-    Profile.DEV: {
-        TRACES_EXPORTER_KEY: "console",
-        METRICS_EXPORTER_KEY: "console",
-        LOGS_EXPORTER_KEY: "console",
-        EXPORTER_OTLP_ENDPOINT_KEY: None,
-    },
-    Profile.TEST: {
-        TRACES_EXPORTER_KEY: "otlp",
-        METRICS_EXPORTER_KEY: "otlp",
-        LOGS_EXPORTER_KEY: "otlp",
-        EXPORTER_OTLP_ENDPOINT_KEY: "http://otel-sls-collector:4317",
-    },
-    Profile.PROD: {
-        TRACES_EXPORTER_KEY: "otlp",
-        METRICS_EXPORTER_KEY: "otlp",
-        LOGS_EXPORTER_KEY: "otlp",
-        EXPORTER_OTLP_ENDPOINT_KEY: "http://otel-sls-collector:4317",
-    },
-}
-
-logger = logging.getLogger(__name__)
-
-
-def init_trace(
-    *,
-    service_name: str | None = None,
-    profile: Profile | None = None,
-    exporter_otlp_endpoint: str | None = None,
-    **kwargs,
-) -> None:
-    # 设置环境变量，优先级：环境变量 > 参数 > profile 配置 > 默认配置
-    for key, value in kwargs.items():
-        _set_env(key, value)
-
-    if profile:
-        if profile == Profile.NO_TRACE:
-            logger.debug("NO_TRACE profile is set, skip auto instrumentation")
-            return
-        for key, value in profile_config[profile].items():
-            _set_env(key, value)
-    elif exporter_otlp_endpoint:
-        _set_env(EXPORTER_OTLP_ENDPOINT_KEY, exporter_otlp_endpoint)
-    else:
-        raise ValueError("either profile or exporter_otlp_endpoint is required")
-
-    if service_name:
-        _set_env(SERVICE_NAME_KEY, service_name)
-    elif _get_env(SERVICE_NAME_KEY) is None:
-        raise ValueError("service_name is required")
-
-    for key, value in default_envs.items():
-        _set_env(key, value)
-
-    auto_instrumentation.initialize()
-
-    _setup_logger_handler()
-
-
-def _set_env(key: str, value: str | None) -> None:
-    if value is None:
-        return
-
-    env_key = _convert_to_env_key(key)
-    if existing_value := os.getenv(env_key):
-        logger.info(f"existing env {env_key}={existing_value}")
-    else:
-        logger.debug(f"set env {env_key}={value}")
-        os.environ[env_key] = value
-
-
-def _get_env(key: str) -> str | None:
-    env_key = _convert_to_env_key(key)
-    return os.getenv(env_key)
-
-
-def _convert_to_env_key(key: str) -> str:
-    return f"OTEL_{key.upper()}"
-
-
-def _setup_logger_handler() -> None:
-    otel_handler = LoggingHandler()
-    logging.getLogger().addHandler(otel_handler)