feat: add experimental LoggerConfigurator

Author: herin049

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py

@@ -22,11 +22,20 @@
 import threading
 import traceback
 import warnings
+from _weakrefset import WeakSet
 from dataclasses import dataclass, field
 from os import environ
 from threading import Lock
 from time import time_ns
-from typing import Any, Callable, Tuple, Union, cast, overload  # noqa
+from typing import (  # noqa
+    Any,
+    Callable,
+    Sequence,
+    Tuple,
+    Union,
+    cast,
+    overload,
+)
 
 from typing_extensions import deprecated
 
@@ -51,7 +60,10 @@
 )
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.util import ns_to_iso_str
-from opentelemetry.sdk.util.instrumentation import InstrumentationScope
+from opentelemetry.sdk.util.instrumentation import (
+    InstrumentationScope,
+    _InstrumentationScopePredicateT,
+)
 from opentelemetry.semconv._incubating.attributes import code_attributes
 from opentelemetry.semconv.attributes import exception_attributes
 from opentelemetry.trace import (
@@ -637,6 +649,15 @@ def flush(self) -> None:
             thread.start()
 
 
+@dataclass
+class LoggerConfig:
+    is_enabled: bool = True
+
+    @classmethod
+    def default(cls) -> "LoggerConfig":
+        return LoggerConfig()
+
+
 class Logger(APILogger):
     def __init__(
         self,
@@ -648,6 +669,7 @@ def __init__(
         instrumentation_scope: InstrumentationScope,
         *,
         logger_metrics: LoggerMetrics,
+        logger_config: LoggerConfig,
     ):
         super().__init__(
             instrumentation_scope.name,
@@ -659,6 +681,17 @@ def __init__(
         self._multi_log_record_processor = multi_log_record_processor
         self._instrumentation_scope = instrumentation_scope
         self._logger_metrics = logger_metrics
+        self._logger_config = logger_config
+
+    def _is_enabled(self) -> bool:
+        return self._logger_config.is_enabled
+
+    def set_logger_config(self, logger_config: LoggerConfig) -> None:
+        self._logger_config = logger_config
+
+    @property
+    def instrumentation_scope(self):
+        return self._instrumentation_scope
 
     @property
     def resource(self):
@@ -681,6 +714,8 @@ def emit(
         """Emits the :class:`ReadWriteLogRecord` by setting instrumentation scope
         and forwarding to the processor.
         """
+        if not self._is_enabled():
+            return
         # If a record is provided, use it directly
         if record is not None:
             if not isinstance(record, ReadWriteLogRecord):
@@ -715,6 +750,42 @@ def emit(
         self._multi_log_record_processor.on_emit(writable_record)
 
 
+LoggerConfiguratorT = Callable[[InstrumentationScope], LoggerConfig]
+LoggerConfiguratorRulesT = Sequence[
+    tuple[_InstrumentationScopePredicateT, LoggerConfig]
+]
+
+
+def default_logger_configurator(
+    _logger_scope: InstrumentationScope,
+) -> LoggerConfig:
+    return LoggerConfig.default()
+
+
+def disable_logger_configurator(
+    _logger_scope: InstrumentationScope,
+) -> LoggerConfig:
+    return LoggerConfig(is_enabled=False)
+
+
+class RuleBasedLoggerConfigurator:
+    def __init__(
+        self,
+        *,
+        rules: LoggerConfiguratorRulesT,
+        default_config: LoggerConfig,
+    ):
+        self._rules = rules
+        self._default_config = default_config
+
+    def __call__(self, meter_scope: InstrumentationScope) -> LoggerConfig:
+        for predicate, meter_config in self._rules:
+            if predicate(meter_scope):
+                return meter_config
+        # by default return default config
+        return self._default_config
+
+
 class LoggerProvider(APILoggerProvider):
     def __init__(
         self,
@@ -725,6 +796,7 @@ def __init__(
         | None = None,
         *,
         meter_provider: MeterProvider | None = None,
+        logger_configurator: LoggerConfiguratorT | None = None,
     ):
         if resource is None:
             self._resource = Resource.create({})
@@ -738,11 +810,14 @@ def __init__(
         )
         disabled = environ.get(OTEL_SDK_DISABLED, "")
         self._disabled = disabled.lower().strip() == "true"
+        self._logger_configurator = logger_configurator
         self._at_exit_handler = None
         if shutdown_on_exit:
             self._at_exit_handler = atexit.register(self.shutdown)
         self._logger_cache = {}
         self._logger_cache_lock = Lock()
+        self._active_loggers = WeakSet()
+        self._active_loggers_lock = Lock()
 
     @property
     def resource(self):
@@ -755,16 +830,14 @@ def _get_logger_no_cache(
         schema_url: str | None = None,
         attributes: _ExtendedAttributes | None = None,
     ) -> Logger:
+        scope = InstrumentationScope(name, version, schema_url, attributes)
+
         return Logger(
             self._resource,
             self._multi_log_record_processor,
-            InstrumentationScope(
-                name,
-                version,
-                schema_url,
-                attributes,
-            ),
+            scope,
             logger_metrics=self._logger_metrics,
+            logger_config=self._logger_configurator(scope),
         )
 
     def _get_logger_cached(
@@ -797,9 +870,16 @@ def get_logger(
                 schema_url=schema_url,
                 attributes=attributes,
             )
-        if attributes is None:
-            return self._get_logger_cached(name, version, schema_url)
-        return self._get_logger_no_cache(name, version, schema_url, attributes)
+        logger = (
+            self._get_logger_cached(name, version, schema_url)
+            if attributes is None
+            else self._get_logger_no_cache(
+                name, version, schema_url, attributes
+            )
+        )
+        with self._active_loggers_lock:
+            self._active_loggers.add(logger)
+        return logger
 
     def add_log_record_processor(
         self, log_record_processor: LogRecordProcessor
@@ -812,6 +892,24 @@ def add_log_record_processor(
             log_record_processor
         )
 
+    def set_logger_configurator(
+        self, *, logger_configurator: LoggerConfiguratorT
+    ):
+        """Set a new LoggerConfigurator for this LoggerProvider.
+
+        Setting a new LoggerConfigurator will result in the configurator being called
+        for each outstanding Logger and for any newly created loggers thereafter.
+        Therefore, it is important that the provided function returns quickly.
+        """
+        self._logger_configurator = logger_configurator
+        with self._active_loggers_lock:
+            for logger in self._active_loggers:
+                if not isinstance(logger, Logger):
+                    continue
+                logger.set_logger_config(
+                    self._logger_configurator(logger.instrumentation_scope)
+                )
+
     def shutdown(self) -> None:
         """Shuts down the log processors."""
         self._multi_log_record_processor.shutdown()

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py

@@ -814,15 +814,3 @@ def channel_credential_provider() -> grpc.ChannelCredentials:
 This is an experimental environment variable and the name of this variable and its behavior can
 change in a non-backwards compatible way.
 """
-
-OTEL_PYTHON_METER_CONFIGURATOR = "OTEL_PYTHON_METER_CONFIGURATOR"
-"""
-.. envvar:: OTEL_PYTHON_METER_CONFIGURATOR
-
-The :envvar:`OTEL_PYTHON_METER_CONFIGURATOR` environment variable allows users to set a
-custom Meter Configurator function.
-Default: opentelemetry.sdk.metrics._internal._default_meter_configurator
-
-This is an experimental environment variable and the name of this variable and its behavior can
-change in a non-backwards compatible way.
-"""