diff --git a/CHANGELOG.md b/CHANGELOG.md index 11e553b147..6a65be4a97 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - `opentelemetry-propagator-ot-trace` Add OT Trace Propagator ([#302](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/302)) +- `opentelemetry-instrumentation-logging` Added logging instrumentation to enable log - trace correlation. + ([#345](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/345)) ### Removed - Remove `component` span attribute in instrumentations. diff --git a/docs/instrumentation/logging/logging.rst b/docs/instrumentation/logging/logging.rst new file mode 100644 index 0000000000..630750a028 --- /dev/null +++ b/docs/instrumentation/logging/logging.rst @@ -0,0 +1,7 @@ +OpenTelemetry Logging Instrumentation +===================================== + +.. automodule:: opentelemetry.instrumentation.logging + :members: + :undoc-members: + :show-inheritance: diff --git a/instrumentation/opentelemetry-instrumentation-logging/LICENSE b/instrumentation/opentelemetry-instrumentation-logging/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-logging/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/instrumentation/opentelemetry-instrumentation-logging/MANIFEST.in b/instrumentation/opentelemetry-instrumentation-logging/MANIFEST.in new file mode 100644 index 0000000000..aed3e33273 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-logging/MANIFEST.in @@ -0,0 +1,9 @@ +graft src +graft tests +global-exclude *.pyc +global-exclude *.pyo +global-exclude __pycache__/* +include CHANGELOG.md +include MANIFEST.in +include README.rst +include LICENSE diff --git a/instrumentation/opentelemetry-instrumentation-logging/README.rst b/instrumentation/opentelemetry-instrumentation-logging/README.rst new file mode 100644 index 0000000000..856c7c6d3f --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-logging/README.rst @@ -0,0 +1,21 @@ +OpenTelemetry logging integration +================================= + +|pypi| + +.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-logging.svg + :target: https://pypi.org/project/opentelemetry-instrumentation-logging/ + +Installation +------------ + +:: + + pip install opentelemetry-instrumentation-logging + + +References +---------- + +* `OpenTelemetry logging integration `_ +* `OpenTelemetry Project `_ diff --git a/instrumentation/opentelemetry-instrumentation-logging/setup.cfg b/instrumentation/opentelemetry-instrumentation-logging/setup.cfg new file mode 100644 index 0000000000..d89f241785 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-logging/setup.cfg @@ -0,0 +1,53 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +[metadata] +name = opentelemetry-instrumentation-logging +description = OpenTelemetry Logging instrumentation +long_description = file: README.rst +long_description_content_type = text/x-rst +author = OpenTelemetry Authors +author_email = cncf-opentelemetry-contributors@lists.cncf.io +url = https://github.com/open-telemetry/opentelemetry-python-contrib/tree/master/instrumentation/opentelemetry-instrumentation-logging +platforms = any +license = Apache-2.0 +classifiers = + Development Status :: 4 - Beta + Intended Audience :: Developers + License :: OSI Approved :: Apache Software License + Programming Language :: Python + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.5 + Programming Language :: Python :: 3.6 + Programming Language :: Python :: 3.7 + Programming Language :: Python :: 3.8 + +[options] +package_dir= + =src +packages=find_namespace: +install_requires = + opentelemetry-api == 1.0.0.dev0 + opentelemetry-instrumentation == 0.19.dev0 + +[options.extras_require] +test = + opentelemetry-test == 0.19.dev0 + +[options.packages.find] +where = src + +[options.entry_points] +opentelemetry_instrumentor = + logging = opentelemetry.instrumentation.logging:LoggingInstrumentor diff --git a/instrumentation/opentelemetry-instrumentation-logging/setup.py b/instrumentation/opentelemetry-instrumentation-logging/setup.py new file mode 100644 index 0000000000..3bebc496ef --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-logging/setup.py @@ -0,0 +1,31 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +import os + +import setuptools + +BASE_DIR = os.path.dirname(__file__) +VERSION_FILENAME = os.path.join( + BASE_DIR, + "src", + "opentelemetry", + "instrumentation", + "logging", + "version.py", +) +PACKAGE_INFO = {} +with open(VERSION_FILENAME) as f: + exec(f.read(), PACKAGE_INFO) + +setuptools.setup(version=PACKAGE_INFO["__version__"]) diff --git a/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/__init__.py b/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/__init__.py new file mode 100644 index 0000000000..64fb1a4cf5 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/__init__.py @@ -0,0 +1,115 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# pylint: disable=no-value-for-parameter,no-member,no-name-in-module + +import logging # pylint: disable=import-self +from os import environ + +from opentelemetry.instrumentation.instrumentor import BaseInstrumentor +from opentelemetry.instrumentation.logging.constants import ( + _MODULE_DOC, + DEFAULT_LOGGING_FORMAT, +) +from opentelemetry.instrumentation.logging.environment_variables import ( + OTEL_PYTHON_LOG_CORRELATION, + OTEL_PYTHON_LOG_FORMAT, + OTEL_PYTHON_LOG_LEVEL, +) +from opentelemetry.trace import ( + INVALID_SPAN, + INVALID_SPAN_CONTEXT, + get_current_span, + get_tracer_provider, +) + +__doc__ = _MODULE_DOC + +LEVELS = { + "debug": logging.DEBUG, + "info": logging.INFO, + "warning": logging.WARNING, + "error": logging.ERROR, +} + + +class LoggingInstrumentor(BaseInstrumentor): # pylint: disable=empty-docstring + __doc__ = """An instrumentor for stdlib logging module. + + This instrumentor injects tracing context into logging records and optionally sets the global logging format to the following: + + .. code-block:: + + {default_logging_format} + + See `BaseInstrumentor` + """.format( + default_logging_format=DEFAULT_LOGGING_FORMAT + ) + + _factory_registered = False + _is_instrumented = False + + def _instrument(self, **kwargs): + LoggingInstrumentor._is_instrumented = True + service_name = "" + provider = kwargs.get("tracer_provider", None) or get_tracer_provider() + resource = provider.resource if provider else None + if resource: + service_name = resource.attributes.get("service.name") + + old_factory = logging.getLogRecordFactory() + if not LoggingInstrumentor._factory_registered: + LoggingInstrumentor._factory_registered = True + + def record_factory(*args, **kwargs): + record = old_factory(*args, **kwargs) + if not LoggingInstrumentor._is_instrumented: + return record + + record.otelSpanID = "" + record.otelTraceID = "" + record.otelServiceName = service_name + + span = get_current_span() + if span != INVALID_SPAN: + ctx = span.get_span_context() + if ctx != INVALID_SPAN_CONTEXT: + record.otelSpanID = format(ctx.span_id, "016x") + record.otelTraceID = format(ctx.trace_id, "032x") + return record + + logging.setLogRecordFactory(record_factory) + + set_logging_format = kwargs.get( + "set_logging_format", + environ.get(OTEL_PYTHON_LOG_CORRELATION, "false").lower() + == "true", + ) + + if set_logging_format: + log_format = kwargs.get( + "logging_format", environ.get(OTEL_PYTHON_LOG_FORMAT, None) + ) + log_format = log_format or DEFAULT_LOGGING_FORMAT + + log_level = kwargs.get( + "log_level", LEVELS.get(environ.get(OTEL_PYTHON_LOG_LEVEL)) + ) + log_level = log_level or logging.INFO + + logging.basicConfig(format=log_format, level=log_level) + + def _uninstrument(self, **kwargs): + LoggingInstrumentor._is_instrumented = False diff --git a/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/constants.py b/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/constants.py new file mode 100644 index 0000000000..32daa7cfde --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/constants.py @@ -0,0 +1,121 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# 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 service.name=%(otelServiceName)s] - %(message)s" + + +_MODULE_DOC = """ +The OpenTelemetry ``logging`` integration automatically injects tracing context into log statements. + +The integration patches the standard library logging module to automatically inject tracing context into log record objects +and optionally calls ``logging.basicConfig()`` to set a logging format with placeholders for span ID, trace ID and service name. + +The following keys are injected into the patched log record objects: + +- ``otelSpanID`` +- ``otelTraceID`` +- ``otelServiceName`` + +The integration uses the following logging format by default: + +.. code-block:: + + {default_logging_format} + +Enable trace context injection +------------------------------ + +The integration is opt-in and must be enabled explicitly by setting the environment variable ``OTEL_PYTHON_LOG_CORRELATION`` to ``true``. + +The integration always patches the logging module to inject tracing context into the log record objects. Setting ``OTEL_PYTHON_LOG_CORRELATION`` to ``true`` +calls ``logging.basicConfig()`` to set a logging format that actually makes use of the injected variables. + + +Environment variables +--------------------- + +OTEL_PYTHON_LOG_CORRELATION +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This env var must be set to ``true`` in order to enable trace context injection into logs by calling ``logging.basicConfig()`` and +setting a logging format that makes use of the injected tracing variables. + +The default value is ``false``. + +OTEL_PYTHON_LOG_FORMAT +^^^^^^^^^^^^^^^^^^^^^^ + +This env var can be used to instruct the instrumentation to use a custom logging format. + +The default value is: + +.. code-block:: + + {default_logging_format} + + +OTEL_PYTHON_LOG_LEVEL +^^^^^^^^^^^^^^^^^^^^^ + +This env var can be used to set a custom logging level. + +The default value is ``info``. + +Options are: + +- ``info`` +- ``error`` +- ``debug`` +- ``warning`` + +Manually calling logging.basicConfig +------------------------------------ + +``logging.basicConfig()`` can be called to set a global logging level and format. Only the first ever call has any effect on the global logger. +Any subsequent calls have no effect and do not override a previously configured global logger. This integration calls ``logging.basicConfig()`` for you +when ``OTEL_PYTHON_LOG_CORRELATION`` is set to ``true``. It uses the format and level specified by ``OTEL_PYTHON_LOG_FORMAT`` and ``OTEL_PYTHON_LOG_LEVEL`` +environment variables respectively. + +If you code or some other library/framework you are using calls logging.basicConfig before this integration is enabled, then this integration's logging +format will not be used and log statements will not contain tracing context. For this reason, you'll need to make sure this integration is enabled as early +as possible in the service lifecycle or your framework is configured to use a logging format with placeholders for tracing context. This can be acheived by +adding the following placeholders to your logging format: + +.. code-block:: + + %(otelSpanID)s %(otelTraceID)s %(otelServiceName)s + + + +API +----- + +.. code-block:: python + + from opentelemetry.instrumentation.logging import LoggingInstrumentor + + LoggingInstrumentor().instrument(set_logging_format=True) + + +Note +----- + +If you do not set ``OTEL_PYTHON_LOG_CORRELATION`` to ``true`` but instead set the logging format manually or through your framework, you must ensure that this +integration is enabled before you set the logging format. This is important because unless the integration is enabled, the tracing context variables +are not injected into the log record objects. This means any attempted log statements made after setting the logging format and before enabling this integration +will result in KeyError exceptions. Such exceptions are automatically swallowed by the logging module and do not result in crashes but you may still lose out +on important log messages. +""".format( + default_logging_format=DEFAULT_LOGGING_FORMAT +) diff --git a/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/environment_variables.py b/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/environment_variables.py new file mode 100644 index 0000000000..394689265f --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/environment_variables.py @@ -0,0 +1,17 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +OTEL_PYTHON_LOG_CORRELATION = "OTEL_PYTHON_LOG_CORRELATION" +OTEL_PYTHON_LOG_FORMAT = "OTEL_PYTHON_LOG_FORMAT" +OTEL_PYTHON_LOG_LEVEL = "OTEL_PYTHON_LOG_LEVEL" diff --git a/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/version.py b/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/version.py new file mode 100644 index 0000000000..9194ed4a33 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/version.py @@ -0,0 +1,15 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +__version__ = "0.19.dev0" diff --git a/instrumentation/opentelemetry-instrumentation-logging/tests/__init__.py b/instrumentation/opentelemetry-instrumentation-logging/tests/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/instrumentation/opentelemetry-instrumentation-logging/tests/test_logging.py b/instrumentation/opentelemetry-instrumentation-logging/tests/test_logging.py new file mode 100644 index 0000000000..ae2ffa18c9 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-logging/tests/test_logging.py @@ -0,0 +1,133 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import logging +from unittest import mock + +import pytest + +from opentelemetry.instrumentation.logging import ( # pylint: disable=no-name-in-module + DEFAULT_LOGGING_FORMAT, + LoggingInstrumentor, +) +from opentelemetry.test.test_base import TestBase +from opentelemetry.trace import get_tracer + + +class TestLoggingInstrumentor(TestBase): + @pytest.fixture(autouse=True) + def inject_fixtures(self, caplog): + self.caplog = caplog # pylint: disable=attribute-defined-outside-init + + def setUp(self): + super().setUp() + LoggingInstrumentor().instrument() + self.tracer = get_tracer(__name__) + + def tearDown(self): + super().tearDown() + LoggingInstrumentor().uninstrument() + + def assert_trace_context_injected(self, span_id, trace_id): + with self.caplog.at_level(level=logging.INFO): + logger = logging.getLogger("test logger") + logger.info("hello") + self.assertEqual(len(self.caplog.records), 1) + record = self.caplog.records[0] + self.assertEqual(record.otelSpanID, span_id) + self.assertEqual(record.otelTraceID, trace_id) + 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) + + def test_trace_context_injection_without_span(self): + self.assert_trace_context_injected("", "") + + @mock.patch("logging.basicConfig") + def test_basic_config_called(self, basic_config_mock): + LoggingInstrumentor().uninstrument() + LoggingInstrumentor().instrument() + self.assertFalse(basic_config_mock.called) + LoggingInstrumentor().uninstrument() + + env_patch = mock.patch.dict( + "os.environ", {"OTEL_PYTHON_LOG_CORRELATION": "true"} + ) + env_patch.start() + LoggingInstrumentor().instrument() + basic_config_mock.assert_called_with( + format=DEFAULT_LOGGING_FORMAT, level=logging.INFO + ) + env_patch.stop() + + @mock.patch("logging.basicConfig") + def test_custom_format_and_level_env(self, basic_config_mock): + LoggingInstrumentor().uninstrument() + LoggingInstrumentor().instrument() + self.assertFalse(basic_config_mock.called) + LoggingInstrumentor().uninstrument() + + env_patch = mock.patch.dict( + "os.environ", + { + "OTEL_PYTHON_LOG_CORRELATION": "true", + "OTEL_PYTHON_LOG_FORMAT": "%(message)s %(otelSpanID)s", + "OTEL_PYTHON_LOG_LEVEL": "error", + }, + ) + env_patch.start() + LoggingInstrumentor().instrument() + basic_config_mock.assert_called_with( + format="%(message)s %(otelSpanID)s", level=logging.ERROR + ) + env_patch.stop() + + @mock.patch("logging.basicConfig") + def test_custom_format_and_level_api( + self, basic_config_mock + ): # pylint: disable=no-self-use + LoggingInstrumentor().uninstrument() + LoggingInstrumentor().instrument( + set_logging_format=True, + logging_format="%(message)s span_id=%(otelSpanID)s", + log_level=logging.WARNING, + ) + basic_config_mock.assert_called_with( + format="%(message)s span_id=%(otelSpanID)s", level=logging.WARNING + ) + + def test_uninstrumented(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) + + LoggingInstrumentor().uninstrument() + + self.caplog.clear() + 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") + with self.caplog.at_level(level=logging.INFO): + logger = logging.getLogger("test logger") + logger.info("hello") + self.assertEqual(len(self.caplog.records), 1) + record = self.caplog.records[0] + self.assertFalse(hasattr(record, "otelSpanID")) + self.assertFalse(hasattr(record, "otelTraceID")) + self.assertFalse(hasattr(record, "otelServiceName"))