Move to our own env var for controlling autoinstrumentation

Author: xrmx

instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/__init__.py

@@ -66,6 +66,7 @@
     DEFAULT_LOGGING_FORMAT,
 )
 from opentelemetry.instrumentation.logging.environment_variables import (
+    OTEL_PYTHON_LOG_AUTO_INSTRUMENTATION,
     OTEL_PYTHON_LOG_CODE_ATTRIBUTES,
     OTEL_PYTHON_LOG_CORRELATION,
     OTEL_PYTHON_LOG_FORMAT,
@@ -211,20 +212,23 @@ def record_factory(*args, **kwargs):
         # - the sdk logging handler is enabled and we should do no nothing
         # - the sdk logging handler is not enabled and we should setup the handler by default
         # - the sdk logging handler is not enabled and the user do not want we setup the handler
-        # FIXME: we are reusing the very same env var of the sdk but probably we should be use a new one
-        logging_autoinstrumentation_env_var = (
+        sdk_autoinstrumentation_env_var = (
             environ.get(
                 "OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED", "notset"
             )
             .strip()
             .lower()
         )
-        if logging_autoinstrumentation_env_var == "true":
+        if sdk_autoinstrumentation_env_var == "true":
             _logger.warning(
                 "Disabling logging auto-instrumentation. If you have opentelemetry-instrumentation-logging "
                 "you don't need to set `OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true`"
             )
-        elif logging_autoinstrumentation_env_var == "notset":
+        elif (
+            environ.get(OTEL_PYTHON_LOG_AUTO_INSTRUMENTATION, "true")
+            .strip()
+            .lower()
+        ) == "true":
             log_code_attributes = (
                 environ.get(OTEL_PYTHON_LOG_CODE_ATTRIBUTES, "false")
                 .strip()

instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/environment_variables.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+OTEL_PYTHON_LOG_AUTO_INSTRUMENTATION = "OTEL_PYTHON_LOG_AUTO_INSTRUMENTATION"
 OTEL_PYTHON_LOG_CORRELATION = "OTEL_PYTHON_LOG_CORRELATION"
 OTEL_PYTHON_LOG_FORMAT = "OTEL_PYTHON_LOG_FORMAT"
 OTEL_PYTHON_LOG_LEVEL = "OTEL_PYTHON_LOG_LEVEL"

instrumentation/opentelemetry-instrumentation-logging/tests/test_logging.py

@@ -264,7 +264,7 @@ def test_no_op_tracer_provider(self):
         "os.environ",
         {"OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED": "true"},
     )
-    def test_handler_setup_is_disabled_if_autoinstrumentation_env_var_is_set_to_true(
+    def test_handler_setup_is_disabled_if_sdk_autoinstrumentation_env_var_is_set_to_true(
         self,
     ):
         LoggingInstrumentor().uninstrument()
@@ -291,7 +291,27 @@ def test_handler_setup_is_disabled_if_autoinstrumentation_env_var_is_set_to_true
         "os.environ",
         {"OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED": "false"},
     )
-    def test_handler_setup_is_disabled_if_autoinstrumentation_env_var_is_set_to_false(
+    def test_handler_setup_is_enabled_if_sdk_autoinstrumentation_env_var_is_set_to_false(
+        self,
+    ):
+        LoggingInstrumentor().uninstrument()
+        with self.caplog.at_level(level=logging.WARNING):
+            LoggingInstrumentor().instrument()
+
+        self.assertEqual(len(self.caplog.records), 0)
+        root_logger = logging.getLogger()
+        logging_handler_instances = [
+            handler
+            for handler in root_logger.handlers
+            if isinstance(handler, LoggingHandler)
+        ]
+        self.assertEqual(len(logging_handler_instances), 1)
+
+    @mock.patch.dict(
+        "os.environ",
+        {"OTEL_PYTHON_LOG_AUTO_INSTRUMENTATION": "false"},
+    )
+    def test_handler_setup_is_enabled_if_autoinstrumentation_env_var_is_set_to_false(
         self,
     ):
         LoggingInstrumentor().uninstrument()
@@ -307,7 +327,7 @@ def test_handler_setup_is_disabled_if_autoinstrumentation_env_var_is_set_to_fals
         ]
         self.assertEqual(logging_handler_instances, [])
 
-    def test_handler_setup_is_called_if_autoinstrumentation_env_var_is_not_set(
+    def test_handler_setup_is_called_if_autoinstrumentation_env_vars_are_not_set(
         self,
     ):
         LoggingInstrumentor().uninstrument()