open-telemetry
/
opentelemetry-python-contrib
mirror of https://github.com/open-telemetry/opentelemetry-python-contrib.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add otelTraceSampled to instrumetation-logging (#1773) 

* Add otelTraceSampled to instrumetation-logging

* Updated code with black

* Added to CHANGELOG.md

---------

Co-authored-by: Srikanth Chekuri <srikanth.chekuri92@gmail.com>
This commit is contained in:
Nahian-Al Hasan 2023-05-04 02:36:25 +10:00 committed by GitHub
parent 46e4b1da44
commit 890e5dd9b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -22,7 +22,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Make ASGI request span attributes available for `start_span`.
([#1762](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1762))
- `opentelemetry-instrumentation-celery` Add support for anonymous tasks.
([#1407](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1407)
([#1407](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1407))
- `opentelemetry-instrumentation-logging` Add `otelTraceSampled` to instrumetation-logging
([#1773](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1773))
### Fixed

2
instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/__init__.py
View File

@ -94,6 +94,7 @@ class LoggingInstrumentor(BaseInstrumentor): # pylint: disable=empty-docstring
record.otelSpanID = "0"
record.otelTraceID = "0"
record.otelTraceSampled = False
nonlocal service_name
if service_name is None:
@ -113,6 +114,7 @@ class LoggingInstrumentor(BaseInstrumentor): # pylint: disable=empty-docstring
if ctx != INVALID_SPAN_CONTEXT:
record.otelSpanID = format(ctx.span_id, "016x")
record.otelTraceID = format(ctx.trace_id, "032x")
record.otelTraceSampled = ctx.trace_flags.sampled
if callable(LoggingInstrumentor._log_hook):
try:
LoggingInstrumentor._log_hook( # pylint: disable=E1102

5
instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/constants.py
View File

@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
DEFAULT_LOGGING_FORMAT = "%(asctime)s %(levelname)s [%(name)s] [%(filename)s:%(lineno)d] [trace_id=%(otelTraceID)s span_id=%(otelSpanID)s resource.service.name=%(otelServiceName)s] - %(message)s"
DEFAULT_LOGGING_FORMAT = "%(asctime)s %(levelname)s [%(name)s] [%(filename)s:%(lineno)d] [trace_id=%(otelTraceID)s span_id=%(otelSpanID)s resource.service.name=%(otelServiceName)s trace_sampled=%(otelTraceSampled)s] - %(message)s"
_MODULE_DOC = """
@ -27,6 +27,7 @@ The following keys are injected into log record objects by the factory:
- ``otelSpanID``
- ``otelTraceID``
- ``otelServiceName``
- ``otelTraceSampled``
The integration uses the following logging format by default:
@ -113,7 +114,7 @@ adding the following placeholders to your logging format:
.. code-block::
%(otelSpanID)s %(otelTraceID)s %(otelServiceName)s
%(otelSpanID)s %(otelTraceID)s %(otelServiceName)s %(otelTraceSampled)s

20
instrumentation/opentelemetry-instrumentation-logging/tests/test_logging.py
View File

@ -62,6 +62,7 @@ class TestLoggingInstrumentorProxyTracerProvider(TestBase):
self.assertEqual(record.otelSpanID, "0")
self.assertEqual(record.otelTraceID, "0")
self.assertEqual(record.otelServiceName, "")
self.assertEqual(record.otelTraceSampled, False)
def log_hook(span, record):
@ -82,7 +83,7 @@ class TestLoggingInstrumentor(TestBase):
super().tearDown()
LoggingInstrumentor().uninstrument()
def assert_trace_context_injected(self, span_id, trace_id):
def assert_trace_context_injected(self, span_id, trace_id, trace_sampled):
with self.caplog.at_level(level=logging.INFO):
logger = logging.getLogger("test logger")
logger.info("hello")
@ -90,16 +91,20 @@ class TestLoggingInstrumentor(TestBase):
record = self.caplog.records[0]
self.assertEqual(record.otelSpanID, span_id)
self.assertEqual(record.otelTraceID, trace_id)
self.assertEqual(record.otelTraceSampled, trace_sampled)
self.assertEqual(record.otelServiceName, "unknown_service")
def test_trace_context_injection(self):
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")
self.assert_trace_context_injected(span_id, trace_id)
trace_sampled = span.get_span_context().trace_flags.sampled
self.assert_trace_context_injected(
span_id, trace_id, trace_sampled
)
def test_trace_context_injection_without_span(self):
self.assert_trace_context_injected("0", "0")
self.assert_trace_context_injected("0", "0", False)
@mock.patch("logging.basicConfig")
def test_basic_config_called(self, basic_config_mock):
@ -163,6 +168,7 @@ class TestLoggingInstrumentor(TestBase):
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
with self.caplog.at_level(level=logging.INFO):
logger = logging.getLogger("test logger")
logger.info("hello")
@ -171,6 +177,7 @@ class TestLoggingInstrumentor(TestBase):
self.assertEqual(record.otelSpanID, span_id)
self.assertEqual(record.otelTraceID, trace_id)
self.assertEqual(record.otelServiceName, "unknown_service")
self.assertEqual(record.otelTraceSampled, trace_sampled)
self.assertEqual(
record.custom_user_attribute_from_log_hook, "some-value"
)
@ -179,7 +186,10 @@ class TestLoggingInstrumentor(TestBase):
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")
self.assert_trace_context_injected(span_id, trace_id)
trace_sampled = span.get_span_context().trace_flags.sampled
self.assert_trace_context_injected(
span_id, trace_id, trace_sampled
)
LoggingInstrumentor().uninstrument()
@ -187,6 +197,7 @@ class TestLoggingInstrumentor(TestBase):
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
with self.caplog.at_level(level=logging.INFO):
logger = logging.getLogger("test logger")
logger.info("hello")
@ -195,3 +206,4 @@ class TestLoggingInstrumentor(TestBase):
self.assertFalse(hasattr(record, "otelSpanID"))
self.assertFalse(hasattr(record, "otelTraceID"))
self.assertFalse(hasattr(record, "otelServiceName"))
self.assertFalse(hasattr(record, "otelTraceSampled"))