Update doc and cleanup tests

Author: xrmx

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

@@ -90,7 +90,7 @@
 class LoggingInstrumentor(BaseInstrumentor):  # pylint: disable=empty-docstring
     __doc__ = f"""An instrumentor for stdlib logging module.
 
-    This instrumentor injects tracing context into logging records and optionally sets the global logging format to the following:
+    This instrumentor optionally injects tracing context into logging records and sets the global logging format to the following:
 
     .. code-block::
 
@@ -99,6 +99,8 @@ class LoggingInstrumentor(BaseInstrumentor):  # pylint: disable=empty-docstring
         def log_hook(span: Span, record: LogRecord):
             if span and span.is_recording():
                 record.custom_user_attribute_from_log_hook = "some-value"
+                span_ctx = span.get_span_context()
+                record.from_sampled_span = span_ctx.trace_flags.sampled
 
     Args:
         tracer_provider: Tracer provider instance that can be used to fetch a tracer.

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

@@ -101,9 +101,10 @@ def test_trace_context_injection_with_log_correlation_from_env_var(self):
         LoggingInstrumentor().uninstrument()
         LoggingInstrumentor().instrument()
         with self.tracer.start_as_current_span("s1") as span:
-            span_id = format(span.get_span_context().span_id, "016x")
-            trace_id = format(span.get_span_context().trace_id, "032x")
-            trace_sampled = span.get_span_context().trace_flags.sampled
+            span_ctx = span.get_span_context()
+            span_id = format(span_ctx.span_id, "016x")
+            trace_id = format(span_ctx.trace_id, "032x")
+            trace_sampled = span_ctx.trace_flags.sampled
             self.assert_trace_context_injected(
                 span_id, trace_id, trace_sampled
             )
@@ -112,9 +113,10 @@ def test_trace_context_injection_with_log_correlation_instrument_arg(self):
         LoggingInstrumentor().uninstrument()
         LoggingInstrumentor().instrument(set_logging_format=True)
         with self.tracer.start_as_current_span("s1") as span:
-            span_id = format(span.get_span_context().span_id, "016x")
-            trace_id = format(span.get_span_context().trace_id, "032x")
-            trace_sampled = span.get_span_context().trace_flags.sampled
+            span_ctx = span.get_span_context()
+            span_id = format(span_ctx.span_id, "016x")
+            trace_id = format(span_ctx.trace_id, "032x")
+            trace_sampled = span_ctx.trace_flags.sampled
             self.assert_trace_context_injected(
                 span_id, trace_id, trace_sampled
             )
@@ -197,9 +199,10 @@ def test_log_hook_with_set_logging_format(self):
             log_hook=log_hook,
         )
         with self.tracer.start_as_current_span("s1") as span:
-            span_id = format(span.get_span_context().span_id, "016x")
-            trace_id = format(span.get_span_context().trace_id, "032x")
-            trace_sampled = span.get_span_context().trace_flags.sampled
+            span_ctx = span.get_span_context()
+            span_id = format(span_ctx.span_id, "016x")
+            trace_id = format(span_ctx.trace_id, "032x")
+            trace_sampled = span_ctx.trace_flags.sampled
             with self.caplog.at_level(level=logging.INFO):
                 logger = logging.getLogger("test logger")
                 logger.info("hello")