From 5072ab87f2186d59b39d6bdcf886305b2d63a1f3 Mon Sep 17 00:00:00 2001 From: awtkns <32209255+awtkns@users.noreply.github.com> Date: Sat, 16 Sep 2023 22:31:01 -0700 Subject: [PATCH] Instrumentation for AIOKafka --- .../LICENSE | 201 ++++++++++++++++ .../README.rst | 22 ++ .../pyproject.toml | 59 +++++ .../instrumentation/kafka/__init__.py | 118 +++++++++ .../instrumentation/kafka/package.py | 16 ++ .../instrumentation/kafka/utils.py | 202 ++++++++++++++++ .../instrumentation/kafka/version.py | 15 ++ .../tests/__init__.py | 0 .../tests/test_instrumentation.py | 32 +++ .../tests/test_utils.py | 226 ++++++++++++++++++ 10 files changed, 891 insertions(+) create mode 100644 instrumentation/opentelemetry-instrumentation-aiokafka/LICENSE create mode 100644 instrumentation/opentelemetry-instrumentation-aiokafka/README.rst create mode 100644 instrumentation/opentelemetry-instrumentation-aiokafka/pyproject.toml create mode 100644 instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/__init__.py create mode 100644 instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/package.py create mode 100644 instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/utils.py create mode 100644 instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/version.py create mode 100644 instrumentation/opentelemetry-instrumentation-aiokafka/tests/__init__.py create mode 100644 instrumentation/opentelemetry-instrumentation-aiokafka/tests/test_instrumentation.py create mode 100644 instrumentation/opentelemetry-instrumentation-aiokafka/tests/test_utils.py diff --git a/instrumentation/opentelemetry-instrumentation-aiokafka/LICENSE b/instrumentation/opentelemetry-instrumentation-aiokafka/LICENSE new file mode 100644 index 0000000000..1ef7dad2c5 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-aiokafka/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 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. diff --git a/instrumentation/opentelemetry-instrumentation-aiokafka/README.rst b/instrumentation/opentelemetry-instrumentation-aiokafka/README.rst new file mode 100644 index 0000000000..dc4691c3d2 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-aiokafka/README.rst @@ -0,0 +1,22 @@ +OpenTelemetry aiokafka integration +====================================== + +|pypi| + +.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-aiokafka.svg + :target: https://pypi.org/project/opentelemetry-instrumentation-aiokafka/ + +Installation +------------ + +:: + + pip install opentelemetry-instrumentation-aiokafka + + +References +---------- + +* `OpenTelemetry aiokafka Instrumentation `_ +* `OpenTelemetry Project `_ +* `OpenTelemetry Python Examples `_ diff --git a/instrumentation/opentelemetry-instrumentation-aiokafka/pyproject.toml b/instrumentation/opentelemetry-instrumentation-aiokafka/pyproject.toml new file mode 100644 index 0000000000..125c2d6f6f --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-aiokafka/pyproject.toml @@ -0,0 +1,59 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "opentelemetry-instrumentation-aiokafka" +dynamic = ["version"] +description = "OpenTelemetry aiokafka instrumentation" +readme = "README.rst" +license = "Apache-2.0" +requires-python = ">=3.7" +authors = [ + { name = "OpenTelemetry Authors", email = "cncf-opentelemetry-contributors@lists.cncf.io" }, +] +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.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", +] +dependencies = [ + "opentelemetry-api ~= 1.5", + "opentelemetry-instrumentation == 0.42b0.dev", + "opentelemetry-semantic-conventions == 0.42b0.dev", +] + +[project.optional-dependencies] +instruments = [ + "aiokafka >= 0.8.1", +] +test = [ + "opentelemetry-instrumentation-aiokafka[instruments]", + "opentelemetry-test-utils == 0.42b0.dev", + "wrapt >= 1.0.0, < 2.0.0", +] + +[project.entry-points.opentelemetry_instrumentor] +aiokafka = "opentelemetry.instrumentation.aiokafka:AIOKafkaKafkaInstrumentor" + +[project.urls] +Homepage = "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-aiokafka" + +[tool.hatch.version] +path = "src/opentelemetry/instrumentation/aiokafka/version.py" + +[tool.hatch.build.targets.sdist] +include = [ + "/src", + "/tests", +] + +[tool.hatch.build.targets.wheel] +packages = ["src/opentelemetry"] diff --git a/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/__init__.py b/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/__init__.py new file mode 100644 index 0000000000..21acbe97fd --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/__init__.py @@ -0,0 +1,118 @@ +# 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. + +""" +Instrument aiokafka to report instrumentation-aiokafka produced and consumed messages + +Usage +----- + +..code:: python + + from opentelemetry.instrumentation.aiokafka import AIOKafkaKafkaInstrumentor + from aiokafka import AIOKafkaConsumer, AIOKafkaProducer + + # Instrument aiokafka + AIOKafkaKafkaInstrumentor().instrument() + + # report a span of type producer with the default settings + producer = AIOKafkaProducer(bootstrap_servers=['localhost:9092']) + producer.send('my-topic', b'raw_bytes') + + # report a span of type consumer with the default settings + consumer = AIOKafkaConsumer('my-topic', group_id='my-group', bootstrap_servers=['localhost:9092']) + async for message in consumer: + # process message + +The _instrument() method accepts the following keyword args: +tracer_provider (TracerProvider) - an optional tracer provider +produce_hook (Callable) - a function with extra user-defined logic to be performed before sending the message +this function signature is: +def produce_hook(span: Span, args, kwargs) +consume_hook (Callable) - a function with extra user-defined logic to be performed after consuming a message +this function signature is: +def consume_hook(span: Span, record: ConsumerRecord, args, kwargs) +for example: + +.. code: python + from opentelemetry.instrumentation.aiokafka import AIOKafkaKafkaInstrumentor + from aiokafka import AIOKafkaProducer, AIOKafkaConsumer + + def produce_hook(span, args, kwargs): + if span and span.is_recording(): + span.set_attribute("custom_user_attribute_from_produce_hook", "some-value") + def consume_hook(span, record, args, kwargs): + if span and span.is_recording(): + span.set_attribute("custom_user_attribute_from_consume_hook", "some-value") + + # instrument aiokafka with produce and consume hooks + AIOKafkaKafkaInstrumentor().instrument(produce_hook=produce_hook, consume_hook=consume_hook) + + # Using aiokafka as normal now will automatically generate spans, + # including user custom attributes added from the hooks + producer = AIOKafkaProducer(bootstrap_servers=['localhost:9092']) + await producer.send('my-topic', b'raw_bytes') + +API +___ +""" +import functools +from typing import Any, Collection + +from aiokafka import AIOKafkaConsumer, AIOKafkaProducer, ConsumerRecord +from wrapt import wrap_function_wrapper + +from opentelemetry import trace +from opentelemetry.instrumentation.instrumentor import BaseInstrumentor +from opentelemetry.instrumentation.utils import unwrap + +from .package import _instruments +from .utils import _wrap_anext, _wrap_record_processing, _wrap_send +from .version import __version__ + + +class AIOKafkaKafkaInstrumentor(BaseInstrumentor): + def instrumentation_dependencies(self) -> Collection[str]: + return _instruments + + def _instrument(self, **kwargs: Any): + """ + Instruments the kafka module + Args: + **kwargs: Optional arguments + ``tracer_provider``: a TracerProvider, defaults to global. + ``produce_hook``: a callable to be executed just before producing a message + ``consume_hook``: a callable to be executed just after consuming a message + """ + + tracer_provider = kwargs.get("tracer_provider") + produce_hook = kwargs.get("produce_hook") + consume_hook = kwargs.get("consume_hook") + + tracer = trace.get_tracer( + __name__, __version__, tracer_provider=tracer_provider + ) + + wrap_function_wrapper( + AIOKafkaProducer, "send", _wrap_send(tracer, produce_hook) + ) + wrap_function_wrapper( + AIOKafkaConsumer, + "__anext__", + _wrap_anext(tracer, consume_hook), + ) + + def _uninstrument(self, **kwargs): + unwrap(AIOKafkaProducer, "send") + unwrap(AIOKafkaConsumer, "__next__") diff --git a/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/package.py b/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/package.py new file mode 100644 index 0000000000..a0808bcb31 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/package.py @@ -0,0 +1,16 @@ +# 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. + + +_instruments = ("aiokafka >= 0.8.1",) diff --git a/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/utils.py b/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/utils.py new file mode 100644 index 0000000000..e9f28f51e0 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/utils.py @@ -0,0 +1,202 @@ +import json +from logging import getLogger +from typing import Any, Callable, Dict, List, Optional + +from aiokafka import ( + AIOKafkaClient, + AIOKafkaConsumer, + AIOKafkaProducer, + ConsumerRecord, +) +from kafka.record.abc import ABCRecord + +from opentelemetry import context, propagate, trace +from opentelemetry.propagators import textmap +from opentelemetry.semconv.trace import SpanAttributes +from opentelemetry.trace import Tracer +from opentelemetry.trace.span import Span + +_LOG = getLogger(__name__) + + +class KafkaPropertiesExtractor: + @staticmethod + def extract_bootstrap_servers(client: AIOKafkaClient) -> List[str]: + return [f"{url}:{port}" for url, port, *_ in client.hosts] + + @staticmethod + def _extract_argument( + key: str, position: int, default_value: Any, args: Any, kwargs: Any + ): + if len(args) > position: + return args[position] + return kwargs.get(key, default_value) + + @staticmethod + def extract_send_topic(args: Any, kwargs: Any): + """extract topic from `send` method arguments in KafkaProducer class""" + return KafkaPropertiesExtractor._extract_argument( + "topic", 0, "unknown", args, kwargs + ) + + @staticmethod + def extract_send_value(args: Any, kwargs: Any): + """extract value from `send` method arguments in KafkaProducer class""" + return KafkaPropertiesExtractor._extract_argument( + "value", 1, None, args, kwargs + ) + + @staticmethod + def extract_send_key(args: Any, kwargs: Any): + """extract key from `send` method arguments in KafkaProducer class""" + return KafkaPropertiesExtractor._extract_argument("key", 2, None, args, kwargs) + + @staticmethod + def extract_send_headers(args: Any, kwargs: Any): + """extract headers from `send` method arguments in KafkaProducer class""" + return KafkaPropertiesExtractor._extract_argument( + "headers", 3, None, args, kwargs + ) + + @staticmethod + def extract_send_partition(args: Any, kwargs: Any): + return KafkaPropertiesExtractor._extract_argument( + "partition", 4, None, args, kwargs + ) + + @staticmethod + def extract_client_id(client: AIOKafkaClient): + return client._client_id + + +ProduceHookT = Optional[Callable[[Span, List, Dict], None]] +ConsumeHookT = Optional[Callable[[Span, ABCRecord, List, Dict], None]] + + +class KafkaContextGetter(textmap.Getter[textmap.CarrierT]): + def get(self, carrier: textmap.CarrierT, key: str) -> Optional[List[str]]: + if carrier is None: + return None + + for item_key, value in carrier: + if item_key == key: + if value is not None: + return [value.decode()] + return None + + def keys(self, carrier: textmap.CarrierT) -> List[str]: + if carrier is None: + return [] + return [key for (key, value) in carrier] + + +class KafkaContextSetter(textmap.Setter[textmap.CarrierT]): + def set(self, carrier: textmap.CarrierT, key: str, value: str) -> None: + if carrier is None or key is None: + return + + if value: + value = value.encode() + carrier.append((key, value)) + + +_kafka_getter = KafkaContextGetter() +_kafka_setter = KafkaContextSetter() + + +def _enrich_span( + span: Span, + bootstrap_servers: List[str], + topic: str, + partition: Optional[int], + client_id: str, +): + span.set_attributes( + { + SpanAttributes.MESSAGING_SYSTEM: "kafka", + SpanAttributes.MESSAGING_DESTINATION: topic, + SpanAttributes.MESSAGING_URL: json.dumps(bootstrap_servers), + SpanAttributes.MESSAGING_DESTINATION_KIND: "topic", + SpanAttributes.MESSAGING_KAFKA_CLIENT_ID: client_id, + } + ) + + if span.is_recording(): + if partition is not None: + span.set_attribute(SpanAttributes.MESSAGING_KAFKA_PARTITION, partition) + + +def _get_span_name(operation: str, topic: str): + return f"{topic} {operation}" + + +def _wrap_send(tracer: Tracer, produce_hook: ProduceHookT) -> Callable: + def _traced_send(func, instance: AIOKafkaProducer, args, kwargs): + headers = KafkaPropertiesExtractor.extract_send_headers(args, kwargs) + if headers is None: + headers = [] + kwargs["headers"] = headers + + topic = KafkaPropertiesExtractor.extract_send_topic(args, kwargs) + bootstrap_servers = KafkaPropertiesExtractor.extract_bootstrap_servers( + instance.client + ) + partition = KafkaPropertiesExtractor.extract_send_partition(args, kwargs) + client_id = KafkaPropertiesExtractor.extract_client_id(instance.client) + + span_name = _get_span_name("publish", topic) + with tracer.start_as_current_span( + span_name, kind=trace.SpanKind.PRODUCER + ) as span: + _enrich_span(span, bootstrap_servers, topic, partition, client_id) + propagate.inject( + headers, + context=trace.set_span_in_context(span), + setter=_kafka_setter, + ) + try: + if callable(produce_hook): + produce_hook(span, args, kwargs) + except Exception as hook_exception: # pylint: disable=W0703 + _LOG.exception(hook_exception) + + return func(*args, **kwargs) + + return _traced_send + + +def _wrap_anext( + tracer: Tracer, + consume_hook: ConsumeHookT, +) -> Callable: + # noinspection PyProtectedMember + async def _traced_anext(func, instance: AIOKafkaConsumer, args, kwargs): + record: ConsumerRecord = await func(*args, **kwargs) + bootstrap_servers = KafkaPropertiesExtractor.extract_bootstrap_servers( + instance._client + ) + client_id = KafkaPropertiesExtractor.extract_client_id(instance._client) + extracted_context = propagate.extract(record.headers, getter=_kafka_getter) + span_name = _get_span_name("receive", record.topic) + + with tracer.start_as_current_span( + span_name, + context=extracted_context, + kind=trace.SpanKind.CONSUMER, + ) as span: + new_context = trace.set_span_in_context(span, extracted_context) + token = context.attach(new_context) + _enrich_span( + span, bootstrap_servers, record.topic, record.partition, client_id + ) + + try: + if callable(consume_hook): + consume_hook(span, record, args, kwargs) + except Exception as hook_exception: + _LOG.exception(hook_exception) + context.detach(token) + + return record + + return _traced_anext diff --git a/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/version.py b/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/version.py new file mode 100644 index 0000000000..c2996671d6 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-aiokafka/src/opentelemetry/instrumentation/kafka/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.42b0.dev" diff --git a/instrumentation/opentelemetry-instrumentation-aiokafka/tests/__init__.py b/instrumentation/opentelemetry-instrumentation-aiokafka/tests/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/instrumentation/opentelemetry-instrumentation-aiokafka/tests/test_instrumentation.py b/instrumentation/opentelemetry-instrumentation-aiokafka/tests/test_instrumentation.py new file mode 100644 index 0000000000..cb4e3cce3f --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-aiokafka/tests/test_instrumentation.py @@ -0,0 +1,32 @@ +# 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. +from unittest import TestCase + +from aiokafka import AIOKafkaProducer, AIOKafkaConsumer +from wrapt import BoundFunctionWrapper + +from opentelemetry.instrumentation.aiokafka import AIOKafkaKafkaInstrumentor + + +class TestAIOKafka(TestCase): + def test_instrument_api(self) -> None: + instrumentation = AIOKafkaKafkaInstrumentor() + + instrumentation.instrument() + self.assertTrue(isinstance(AIOKafkaProducer.send, BoundFunctionWrapper)) + self.assertTrue(isinstance(AIOKafkaConsumer.__anext__, BoundFunctionWrapper)) + + instrumentation.uninstrument() + self.assertFalse(isinstance(AIOKafkaProducer.send, BoundFunctionWrapper)) + self.assertFalse(isinstance(AIOKafkaConsumer.__anext__, BoundFunctionWrapper)) diff --git a/instrumentation/opentelemetry-instrumentation-aiokafka/tests/test_utils.py b/instrumentation/opentelemetry-instrumentation-aiokafka/tests/test_utils.py new file mode 100644 index 0000000000..998a715cf4 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-aiokafka/tests/test_utils.py @@ -0,0 +1,226 @@ +from unittest import TestCase, mock + +from opentelemetry.instrumentation.aiokafka.utils import ( + KafkaPropertiesExtractor, + _create_consumer_span, + _get_span_name, + _kafka_getter, + _kafka_setter, + _wrap_next, + _wrap_send, +) +from opentelemetry.trace import SpanKind + + +class TestUtils(TestCase): + def setUp(self) -> None: + super().setUp() + self.topic_name = "test_topic" + self.args = [self.topic_name] + self.headers = [] + self.kwargs = {"partition": 0, "headers": self.headers} + + @mock.patch( + "opentelemetry.instrumentation.aiokafka.utils.KafkaPropertiesExtractor.extract_bootstrap_servers" + ) + @mock.patch( + "opentelemetry.instrumentation.aiokafka.utils.KafkaPropertiesExtractor.extract_send_partition" + ) + @mock.patch("opentelemetry.instrumentation.aiokafka.utils._enrich_span") + @mock.patch("opentelemetry.trace.set_span_in_context") + @mock.patch("opentelemetry.propagate.inject") + def test_wrap_send_with_topic_as_arg( + self, + inject: mock.MagicMock, + set_span_in_context: mock.MagicMock, + enrich_span: mock.MagicMock, + extract_send_partition: mock.MagicMock, + extract_bootstrap_servers: mock.MagicMock, + ) -> None: + self.wrap_send_helper( + inject, + set_span_in_context, + enrich_span, + extract_send_partition, + extract_bootstrap_servers, + ) + + @mock.patch( + "opentelemetry.instrumentation.aiokafka.utils.KafkaPropertiesExtractor.extract_bootstrap_servers" + ) + @mock.patch( + "opentelemetry.instrumentation.aiokafka.utils.KafkaPropertiesExtractor.extract_send_partition" + ) + @mock.patch("opentelemetry.instrumentation.aiokafka.utils._enrich_span") + @mock.patch("opentelemetry.trace.set_span_in_context") + @mock.patch("opentelemetry.propagate.inject") + def test_wrap_send_with_topic_as_kwarg( + self, + inject: mock.MagicMock, + set_span_in_context: mock.MagicMock, + enrich_span: mock.MagicMock, + extract_send_partition: mock.MagicMock, + extract_bootstrap_servers: mock.MagicMock, + ) -> None: + self.args = [] + self.kwargs["topic"] = self.topic_name + self.wrap_send_helper( + inject, + set_span_in_context, + enrich_span, + extract_send_partition, + extract_bootstrap_servers, + ) + + def wrap_send_helper( + self, + inject: mock.MagicMock, + set_span_in_context: mock.MagicMock, + enrich_span: mock.MagicMock, + extract_send_partition: mock.MagicMock, + extract_bootstrap_servers: mock.MagicMock, + ) -> None: + tracer = mock.MagicMock() + produce_hook = mock.MagicMock() + original_send_callback = mock.MagicMock() + kafka_producer = mock.MagicMock() + expected_span_name = _get_span_name("send", self.topic_name) + + wrapped_send = _wrap_send(tracer, produce_hook) + retval = wrapped_send( + original_send_callback, kafka_producer, self.args, self.kwargs + ) + + extract_bootstrap_servers.assert_called_once_with(kafka_producer) + extract_send_partition.assert_called_once_with( + kafka_producer, self.args, self.kwargs + ) + tracer.start_as_current_span.assert_called_once_with( + expected_span_name, kind=SpanKind.PRODUCER + ) + + span = tracer.start_as_current_span().__enter__.return_value + enrich_span.assert_called_once_with( + span, + extract_bootstrap_servers.return_value, + self.topic_name, + extract_send_partition.return_value, + ) + + set_span_in_context.assert_called_once_with(span) + context = set_span_in_context.return_value + inject.assert_called_once_with( + self.headers, context=context, setter=_kafka_setter + ) + + produce_hook.assert_called_once_with(span, self.args, self.kwargs) + + original_send_callback.assert_called_once_with(*self.args, **self.kwargs) + self.assertEqual(retval, original_send_callback.return_value) + + @mock.patch("opentelemetry.propagate.extract") + @mock.patch("opentelemetry.instrumentation.aiokafka.utils._create_consumer_span") + @mock.patch( + "opentelemetry.instrumentation.aiokafka.utils.KafkaPropertiesExtractor.extract_bootstrap_servers" + ) + def test_wrap_next( + self, + extract_bootstrap_servers: mock.MagicMock, + _create_consumer_span: mock.MagicMock, + extract: mock.MagicMock, + ) -> None: + tracer = mock.MagicMock() + consume_hook = mock.MagicMock() + original_next_callback = mock.MagicMock() + kafka_consumer = mock.MagicMock() + + wrapped_next = _wrap_next(tracer, consume_hook) + record = wrapped_next( + original_next_callback, kafka_consumer, self.args, self.kwargs + ) + + extract_bootstrap_servers.assert_called_once_with(kafka_consumer) + bootstrap_servers = extract_bootstrap_servers.return_value + + original_next_callback.assert_called_once_with(*self.args, **self.kwargs) + self.assertEqual(record, original_next_callback.return_value) + + extract.assert_called_once_with(record.headers, getter=_kafka_getter) + context = extract.return_value + + _create_consumer_span.assert_called_once_with( + tracer, + consume_hook, + record, + context, + bootstrap_servers, + self.args, + self.kwargs, + ) + + @mock.patch("opentelemetry.trace.set_span_in_context") + @mock.patch("opentelemetry.context.attach") + @mock.patch("opentelemetry.instrumentation.aiokafka.utils._enrich_span") + @mock.patch("opentelemetry.context.detach") + def test_create_consumer_span( + self, + detach: mock.MagicMock, + enrich_span: mock.MagicMock, + attach: mock.MagicMock, + set_span_in_context: mock.MagicMock, + ) -> None: + tracer = mock.MagicMock() + consume_hook = mock.MagicMock() + bootstrap_servers = mock.MagicMock() + extracted_context = mock.MagicMock() + record = mock.MagicMock() + + _create_consumer_span( + tracer, + consume_hook, + record, + extracted_context, + bootstrap_servers, + self.args, + self.kwargs, + ) + + expected_span_name = _get_span_name("receive", record.topic) + + tracer.start_as_current_span.assert_called_once_with( + expected_span_name, + context=extracted_context, + kind=SpanKind.CONSUMER, + ) + span = tracer.start_as_current_span.return_value.__enter__() + set_span_in_context.assert_called_once_with(span, extracted_context) + attach.assert_called_once_with(set_span_in_context.return_value) + + enrich_span.assert_called_once_with( + span, bootstrap_servers, record.topic, record.partition + ) + consume_hook.assert_called_once_with(span, record, self.args, self.kwargs) + detach.assert_called_once_with(attach.return_value) + + @mock.patch("opentelemetry.instrumentation.aiokafka.utils.KafkaPropertiesExtractor") + def test_kafka_properties_extractor( + self, + kafka_properties_extractor: mock.MagicMock, + ): + kafka_properties_extractor._serialize.return_value = None + kafka_properties_extractor._partition.return_value = "partition" + assert ( + KafkaPropertiesExtractor.extract_send_partition( + kafka_properties_extractor, self.args, self.kwargs + ) + == "partition" + ) + kafka_properties_extractor._wait_on_metadata.side_effect = Exception( + "mocked error" + ) + assert ( + KafkaPropertiesExtractor.extract_send_partition( + kafka_properties_extractor, self.args, self.kwargs + ) + is None + )