Fixes partial success logging to apply at only 'verbose' and 'debug' levels to avoid changing default behaviors. Apply test and formatting fixes.

Author: michaelsafyan

CHANGELOG.md

@@ -12,7 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-- OTLP exporters now log partial success responses when `OTEL_LOG_LEVEL` is set to `info`, `debug`, or `verbose`.
+- OTLP exporters now log partial success responses at `debug` level when `OTEL_LOG_LEVEL` is set to `debug` or `verbose`.
   ([#4805](https://github.com/open-telemetry/opentelemetry-python/pull/4805))
 - docs: Added sqlcommenter example
   ([#4734](https://github.com/open-telemetry/opentelemetry-python/pull/4734))

exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/_log_exporter/__init__.py

@@ -11,8 +11,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from os import environ
 import sys
+from os import environ
 from typing import Dict, Literal, Optional, Sequence, Tuple, Union
 from typing import Sequence as TypingSequence
 
@@ -113,7 +113,7 @@ def _translate_data(
     def _log_partial_success(self, partial_success):
         # Override that skips the "logging" module due to the possibility
         # of circular logic (logging -> OTLP logs export).
-        sys.stderr.write(f"Partial success:\n{partial_success}\n") 
+        sys.stderr.write(f"Partial success:\n{partial_success}\n")
 
     def export(  # type: ignore [reportIncompatibleMethodOverride]
         self,

exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/exporter.py

@@ -93,7 +93,7 @@
     OTEL_EXPORTER_OTLP_HEADERS,
     OTEL_EXPORTER_OTLP_INSECURE,
     OTEL_EXPORTER_OTLP_TIMEOUT,
-    OTEL_LOG_LEVEL
+    OTEL_LOG_LEVEL,
 )
 from opentelemetry.sdk.metrics.export import MetricExportResult, MetricsData
 from opentelemetry.sdk.resources import Resource as SDKResource
@@ -260,7 +260,7 @@ def _get_credentials(
 
 def _should_log_partial_responses():
     otel_log_level = environ.get(OTEL_LOG_LEVEL, "info").lower()
-    return otel_log_level in ["verbose", "debug", "info"]
+    return otel_log_level in ["verbose", "debug"]
 
 
 # pylint: disable=no-member
@@ -299,7 +299,9 @@ def __init__(
         self._endpoint = endpoint or environ.get(
             OTEL_EXPORTER_OTLP_ENDPOINT, "http://localhost:4317"
         )
-        self._partial_response_logging_enabled = _should_log_partial_responses()
+        self._partial_response_logging_enabled = (
+            _should_log_partial_responses()
+        )
 
         parsed_url = urlparse(self._endpoint)
 
@@ -382,10 +384,12 @@ def _translate_data(
         pass
 
     def _log_partial_success(self, partial_success):
-        logger.info(f"Partial success:\n{partial_success}")
+        logger.debug("Partial success:\n%s", partial_success)
 
     def _process_response(self, response):
-        if self._partial_response_logging_enabled and response.HasField("partial_success"):
+        if self._partial_response_logging_enabled and response.HasField(
+            "partial_success"
+        ):
             self._log_partial_success(response.partial_success)
 
     def _export(

exporter/opentelemetry-exporter-otlp-proto-grpc/tests/logs/test_otlp_logs_exporter.py

@@ -14,9 +14,8 @@
 
 # pylint: disable=too-many-lines
 
-from io import StringIO
-import sys
 import time
+from io import StringIO
 from os.path import dirname
 from unittest import TestCase
 from unittest.mock import Mock, patch
@@ -321,26 +320,26 @@ def export_log_and_deserialize(self, log_data):
         )
         return log_records
 
-    @patch.dict("os.environ", {OTEL_LOG_LEVEL: "info"})
+    @patch.dict("os.environ", {OTEL_LOG_LEVEL: "debug"})
     @patch("sys.stderr", new_callable=StringIO)
     def test_partial_success_recorded_directly_to_stderr(self, mock_stderr):
         # pylint: disable=protected-access
         exporter = OTLPLogExporter()
         exporter._client = Mock()
-        exporter._client.Export.return_value = (
-            ExportLogsServiceResponse(
-                partial_success=ExportLogsPartialSuccess(
-                    rejected_log_records=1,
-                    error_message="Log record dropped",
-                )
+        exporter._client.Export.return_value = ExportLogsServiceResponse(
+            partial_success=ExportLogsPartialSuccess(
+                rejected_log_records=1,
+                error_message="Log record dropped",
             )
         )
 
         exporter.export([self.log_data_1])
 
         self.assertIn("Partial success:\n", mock_stderr.getvalue())
         self.assertIn("rejected_log_records: 1\n", mock_stderr.getvalue())
-        self.assertIn('error_message: "Log record dropped"\n', mock_stderr.getvalue())
+        self.assertIn(
+            'error_message: "Log record dropped"\n', mock_stderr.getvalue()
+        )
 
     def test_exported_log_without_trace_id(self):
         log_records = self.export_log_and_deserialize(self.log_data_4)

exporter/opentelemetry-exporter-otlp-proto-grpc/tests/test_otlp_exporter_mixin.py

@@ -538,9 +538,9 @@ def test_permanent_failure(self):
             )
 
     @patch.dict("os.environ", {}, clear=True)
-    @patch("logging.Logger.info")
+    @patch("logging.Logger.debug")
     def test_does_not_record_partial_success_if_log_level_unset(
-        self, mock_logger_info
+        self, mock_logger_debug
     ):
         exporter = OTLPSpanExporterForTesting(insecure=True)
         # pylint: disable=protected-access
@@ -552,12 +552,12 @@ def test_does_not_record_partial_success_if_log_level_unset(
             )
         )
         exporter.export([self.span])
-        mock_logger_info.assert_not_called()
+        mock_logger_debug.assert_not_called()
 
     @patch.dict("os.environ", {OTEL_LOG_LEVEL: "off"})
-    @patch("logging.Logger.info")
+    @patch("logging.Logger.debug")
     def test_does_not_record_partial_success_if_log_level_off(
-        self, mock_logger_info
+        self, mock_logger_debug
     ):
         exporter = OTLPSpanExporterForTesting(insecure=True)
         # pylint: disable=protected-access
@@ -569,12 +569,12 @@ def test_does_not_record_partial_success_if_log_level_off(
             )
         )
         exporter.export([self.span])
-        mock_logger_info.assert_not_called()
+        mock_logger_debug.assert_not_called()
 
     @patch.dict("os.environ", {OTEL_LOG_LEVEL: "error"})
-    @patch("logging.Logger.info")
+    @patch("logging.Logger.debug")
     def test_does_not_record_partial_success_if_log_level_error(
-        self, mock_logger_info
+        self, mock_logger_debug
     ):
         exporter = OTLPSpanExporterForTesting(insecure=True)
         # pylint: disable=protected-access
@@ -586,12 +586,12 @@ def test_does_not_record_partial_success_if_log_level_error(
             )
         )
         exporter.export([self.span])
-        mock_logger_info.assert_not_called()
+        mock_logger_debug.assert_not_called()
 
     @patch.dict("os.environ", {OTEL_LOG_LEVEL: "verbose"})
-    @patch("logging.Logger.info")
+    @patch("logging.Logger.debug")
     def test_records_partial_success_if_log_level_verbose(
-        self, mock_logger_info
+        self, mock_logger_debug
     ):
         exporter = OTLPSpanExporterForTesting(insecure=True)
         # pylint: disable=protected-access
@@ -604,14 +604,14 @@ def test_records_partial_success_if_log_level_verbose(
             partial_success=partial_success
         )
         exporter.export([self.span])
-        mock_logger_info.assert_called_once_with(
-            f"Partial success:\n{partial_success}"
+        mock_logger_debug.assert_called_once_with(
+            "Partial success:\n%s", partial_success
         )
 
     @patch.dict("os.environ", {OTEL_LOG_LEVEL: "debug"})
-    @patch("logging.Logger.info")
+    @patch("logging.Logger.debug")
     def test_records_partial_success_if_log_level_debug(
-        self, mock_logger_info
+        self, mock_logger_debug
     ):
         exporter = OTLPSpanExporterForTesting(insecure=True)
         # pylint: disable=protected-access
@@ -624,14 +624,14 @@ def test_records_partial_success_if_log_level_debug(
             partial_success=partial_success
         )
         exporter.export([self.span])
-        mock_logger_info.assert_called_once_with(
-            f"Partial success:\n{partial_success}"
+        mock_logger_debug.assert_called_once_with(
+            "Partial success:\n%s", partial_success
         )
 
     @patch.dict("os.environ", {OTEL_LOG_LEVEL: "info"})
-    @patch("logging.Logger.info")
-    def test_records_partial_success_if_log_level_info(
-        self, mock_logger_info
+    @patch("logging.Logger.debug")
+    def test_does_not_record_partial_success_if_log_level_info(
+        self, mock_logger_debug
     ):
         exporter = OTLPSpanExporterForTesting(insecure=True)
         # pylint: disable=protected-access
@@ -644,6 +644,4 @@ def test_records_partial_success_if_log_level_info(
             partial_success=partial_success
         )
         exporter.export([self.span])
-        mock_logger_info.assert_called_once_with(
-            f"Partial success:\n{partial_success}"
-        )
+        mock_logger_debug.assert_not_called()

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

@@ -51,7 +51,7 @@
 .. envvar:: OTEL_LOG_LEVEL
 
 The :envvar:`OTEL_LOG_LEVEL` environment variable sets the log level used by the SDK logger.
-OTLP exporters will log partial success responses when this is set to `info`, `debug`, or `verbose`.
+OTLP exporters will log partial success responses when this is set to `debug` or `verbose`.
 Default: "info"
 """