From e02a0553eb84ee253c7931738c5116e0a310194a Mon Sep 17 00:00:00 2001 From: Chris Park Date: Thu, 16 Jan 2025 20:42:23 -0500 Subject: [PATCH] feat: basic instrumentation for autogen (ag2) (#1211) --- .../CHANGELOG.md | 6 + .../LICENSE | 201 ++++++++++++++++++ .../README.md | 3 + .../examples/ex.py | 60 ++++++ .../pyproject.toml | 87 ++++++++ .../instrumentation/autogen/__init__.py | 119 +++++++++++ .../instrumentation/autogen/version.py | 1 + python/tox.ini | 3 + release-please-config.json | 4 + 9 files changed, 484 insertions(+) create mode 100644 python/instrumentation/openinference-instrumentation-autogen/CHANGELOG.md create mode 100644 python/instrumentation/openinference-instrumentation-autogen/LICENSE create mode 100644 python/instrumentation/openinference-instrumentation-autogen/README.md create mode 100644 python/instrumentation/openinference-instrumentation-autogen/examples/ex.py create mode 100644 python/instrumentation/openinference-instrumentation-autogen/pyproject.toml create mode 100644 python/instrumentation/openinference-instrumentation-autogen/src/openinference/instrumentation/autogen/__init__.py create mode 100644 python/instrumentation/openinference-instrumentation-autogen/src/openinference/instrumentation/autogen/version.py diff --git a/python/instrumentation/openinference-instrumentation-autogen/CHANGELOG.md b/python/instrumentation/openinference-instrumentation-autogen/CHANGELOG.md new file mode 100644 index 000000000..f617de383 --- /dev/null +++ b/python/instrumentation/openinference-instrumentation-autogen/CHANGELOG.md @@ -0,0 +1,6 @@ +## 0.1.0 (2025-01-16) + + +### Features + +* **python:** autogen (ag2) instrumentation ([#1211]https://github.com/Arize-ai/openinference/pull/1211) diff --git a/python/instrumentation/openinference-instrumentation-autogen/LICENSE b/python/instrumentation/openinference-instrumentation-autogen/LICENSE new file mode 100644 index 000000000..0223315cc --- /dev/null +++ b/python/instrumentation/openinference-instrumentation-autogen/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/python/instrumentation/openinference-instrumentation-autogen/README.md b/python/instrumentation/openinference-instrumentation-autogen/README.md new file mode 100644 index 000000000..1c0bc8640 --- /dev/null +++ b/python/instrumentation/openinference-instrumentation-autogen/README.md @@ -0,0 +1,3 @@ +# OpenInference Autogen (ag2) Instrumentation + +EXPERIMENTAL diff --git a/python/instrumentation/openinference-instrumentation-autogen/examples/ex.py b/python/instrumentation/openinference-instrumentation-autogen/examples/ex.py new file mode 100644 index 000000000..dfef678f3 --- /dev/null +++ b/python/instrumentation/openinference-instrumentation-autogen/examples/ex.py @@ -0,0 +1,60 @@ +import os +from importlib import import_module + +import autogen +from openinference.instrumentation.autogen import AutogenInstrumentor +from opentelemetry import trace +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.trace import TracerProvider +from opentelemetry.sdk.trace.export import SimpleSpanProcessor + + +def main(): + trace_provider = TracerProvider() + + endpoint = "http://127.0.0.1:6006/v1/traces" + exporter = OTLPSpanExporter(endpoint=endpoint) + span_processor = SimpleSpanProcessor(exporter) + trace_provider.add_span_processor(span_processor) + + trace.set_tracer_provider(trace_provider) + + openai_instrumentation = import_module("openinference.instrumentation.openai") + openai_instrumentation.OpenAIInstrumentor().instrument(tracer_provider=trace_provider) + AutogenInstrumentor().instrument() + + config_list = [ + { + "model": "gpt-4o", + "api_key": os.environ["OPENAI_API_KEY"], + } + ] + + assistant = autogen.AssistantAgent( + name="assistant", + llm_config={ + "seed": 42, # seed for caching and reproducibility + "config_list": config_list, + "temperature": 0, # temperature for sampling + }, + ) + + user_proxy = autogen.UserProxyAgent( + name="user_proxy", + human_input_mode="NEVER", + max_consecutive_auto_reply=10, + is_termination_msg=lambda x: x.get("content", "").rstrip().endswith("TERMINATE"), + code_execution_config={ + "work_dir": "coding", + "use_docker": False, # set to True or an image name like "python:3" to use docker + }, + ) + + user_proxy.initiate_chat( + assistant, + message="""What date is today? Compare the year-to-date gain for META and TESLA.""", + ) + + +if __name__ == "__main__": + main() diff --git a/python/instrumentation/openinference-instrumentation-autogen/pyproject.toml b/python/instrumentation/openinference-instrumentation-autogen/pyproject.toml new file mode 100644 index 000000000..792eea179 --- /dev/null +++ b/python/instrumentation/openinference-instrumentation-autogen/pyproject.toml @@ -0,0 +1,87 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "openinference-instrumentation-autogen" +dynamic = ["version"] +description = "OpenInference Autogen Instrumentation" +readme = "README.md" +license = "Apache-2.0" +requires-python = ">=3.8, <3.13" +authors = [ + { name = "OpenInference Authors", email = "oss@arize.com" }, +] +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", +] +dependencies = [ + "opentelemetry-api", + "opentelemetry-instrumentation", + "opentelemetry-semantic-conventions", + "openinference-instrumentation>=0.1.18", + "openinference-semantic-conventions>=0.1.12", +] + +[project.optional-dependencies] +instruments = [ + "autogen >= 0.5.0", +] + +[project.urls] +Homepage = "https://github.com/Arize-ai/openinference/tree/main/python/instrumentation/openinference-instrumentation-autogen" + +[tool.hatch.version] +path = "src/openinference/instrumentation/autogen/version.py" + +[tool.hatch.build.targets.sdist] +include = [ + "/src", +] + +[tool.hatch.build.targets.wheel] +packages = ["src/openinference"] + +[tool.pytest.ini_options] +asyncio_mode = "auto" +asyncio_default_fixture_loop_scope = "function" +testpaths = [ + "tests", +] + +[tool.mypy] +strict = true +explicit_package_bases = true +exclude = [ + "examples", + "dist", + "sdist", +] + +[[tool.mypy.overrides]] +ignore_missing_imports = true +module = [ + "wrapt", +] + +[tool.ruff] +line-length = 100 +target-version = "py38" + +[tool.ruff.lint.per-file-ignores] +"*.ipynb" = ["E402", "E501"] + +[tool.ruff.lint] +select = ["E", "F", "W", "I"] + +[tool.ruff.lint.isort] +force-single-line = false diff --git a/python/instrumentation/openinference-instrumentation-autogen/src/openinference/instrumentation/autogen/__init__.py b/python/instrumentation/openinference-instrumentation-autogen/src/openinference/instrumentation/autogen/__init__.py new file mode 100644 index 000000000..be2a0f6e4 --- /dev/null +++ b/python/instrumentation/openinference-instrumentation-autogen/src/openinference/instrumentation/autogen/__init__.py @@ -0,0 +1,119 @@ +import json + +import autogen +from autogen import ConversableAgent +from opentelemetry import trace +from opentelemetry.sdk.trace import TracerProvider +from opentelemetry.trace import Context, Status, StatusCode + + +class AutogenInstrumentor: + def __init__(self): + self.tracer = trace.get_tracer(__name__) + self._original_generate = None + self._original_initiate_chat = None + + def _safe_json_dumps(self, obj): + try: + return json.dumps(obj) + except (TypeError, ValueError): + return json.dumps(str(obj)) + + def instrument(self): + self._original_generate = ConversableAgent.generate_reply + self._original_initiate_chat = ConversableAgent.initiate_chat + instrumentor = self + + def wrapped_generate(self, messages=None, sender=None, **kwargs): + try: + current_context = trace.get_current_span().get_span_context() + + with instrumentor.tracer.start_as_current_span( + self.__class__.__name__, + context=trace.set_span_in_context(trace.get_current_span()), + links=[trace.Link(current_context)], + ) as span: + span.set_attribute(SpanAttributes.OPENINFERENCE_SPAN_KIND, "AGENT") + span.set_attribute( + SpanAttributes.INPUT_VALUE, instrumentor._safe_json_dumps(messages) + ) + span.set_attribute(SpanAttributes.INPUT_MIME_TYPE, "application/json") + span.set_attribute("agent.type", self.__class__.__name__) + + response = instrumentor._original_generate( + self, messages=messages, sender=sender, **kwargs + ) + + span.set_attribute( + SpanAttributes.OUTPUT_VALUE, instrumentor._safe_json_dumps(response) + ) + span.set_attribute(SpanAttributes.OUTPUT_MIME_TYPE, "application/json") + + return response + + except Exception as e: + if "span" in locals(): + span.set_status(Status(StatusCode.ERROR)) + span.record_exception(e) + raise + + def wrapped_initiate_chat(self, recipient, *args, **kwargs): + try: + message = kwargs.get("message", args[0] if args else None) + current_context = trace.get_current_span().get_span_context() + + with instrumentor.tracer.start_as_current_span( + "Autogen", + context=trace.set_span_in_context(trace.get_current_span()), + links=[trace.Link(current_context)], + ) as span: + span.set_attribute(SpanAttributes.OPENINFERENCE_SPAN_KIND, "AGENT") + span.set_attribute( + SpanAttributes.INPUT_VALUE, instrumentor._safe_json_dumps(message) + ) + span.set_attribute(SpanAttributes.INPUT_MIME_TYPE, "application/json") + + result = instrumentor._original_initiate_chat(self, recipient, *args, **kwargs) + + if hasattr(result, "chat_history") and result.chat_history: + last_message = result.chat_history[-1]["content"] + span.set_attribute( + SpanAttributes.OUTPUT_VALUE, instrumentor._safe_json_dumps(last_message) + ) + else: + span.set_attribute( + SpanAttributes.OUTPUT_VALUE, instrumentor._safe_json_dumps(result) + ) + + span.set_attribute(SpanAttributes.OUTPUT_MIME_TYPE, "application/json") + + return result + + except Exception as e: + if "span" in locals(): + span.set_status(Status(StatusCode.ERROR)) + span.record_exception(e) + raise + + # Replace methods + ConversableAgent.generate_reply = wrapped_generate + ConversableAgent.initiate_chat = wrapped_initiate_chat + + return self + + def uninstrument(self): + """Restore original behavior""" + if self._original_generate and self._original_initiate_chat: + ConversableAgent.generate_reply = self._original_generate + ConversableAgent.initiate_chat = self._original_initiate_chat + self._original_generate = None + self._original_initiate_chat = None + return self + + +class SpanAttributes: + OPENINFERENCE_SPAN_KIND = "openinference.span.kind" + INPUT_VALUE = "input.value" + INPUT_MIME_TYPE = "input.mime_type" + OUTPUT_VALUE = "output.value" + OUTPUT_MIME_TYPE = "output.mime_type" diff --git a/python/instrumentation/openinference-instrumentation-autogen/src/openinference/instrumentation/autogen/version.py b/python/instrumentation/openinference-instrumentation-autogen/src/openinference/instrumentation/autogen/version.py new file mode 100644 index 000000000..3dc1f76bc --- /dev/null +++ b/python/instrumentation/openinference-instrumentation-autogen/src/openinference/instrumentation/autogen/version.py @@ -0,0 +1 @@ +__version__ = "0.1.0" diff --git a/python/tox.ini b/python/tox.ini index c49b35739..d8ca0c2f4 100644 --- a/python/tox.ini +++ b/python/tox.ini @@ -19,6 +19,7 @@ envlist = ; py3{9,12}-ci-instructor py3{8,12}-ci-{anthropic,anthropic-latest} py3{10,13}-ci-{smolagents,smolagents-latest} + py3{8,12}-ci-{autogen,autogen-latest} py38-mypy-langchain_core [testenv] @@ -45,6 +46,7 @@ changedir = instructor: instrumentation/openinference-instrumentation-instructor/ anthropic: instrumentation/openinference-instrumentation-anthropic/ smolagents: instrumentation/openinference-instrumentation-smolagents/ + autogen: instrumentation/openinference-instrumentation-autogen/ commands_pre = instrumentation: uv pip install --reinstall {toxinidir}/openinference-instrumentation[test] semconv: uv pip install --reinstall {toxinidir}/openinference-semantic-conventions @@ -87,6 +89,7 @@ commands_pre = anthropic: uv pip install -r test-requirements.txt anthropic-latest: uv pip install -U anthropic 'httpx<0.28' smolagents: uv pip install --reinstall {toxinidir}/instrumentation/openinference-instrumentation-smolagents[test] + autogen: uv pip install --reinstall {toxinidir}/instrumentation/openinference-instrumentation-autogen[test] commands = ruff: ruff format {posargs:.} ruff: ruff check --fix {posargs:.} diff --git a/release-please-config.json b/release-please-config.json index 1955fcf2d..95e8c2c23 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -70,6 +70,10 @@ "python/instrumentation/openinference-instrumentation-smolagents": { "package-name": "python-openinference-instrumentation-smolagents", "release-type": "python" + }, + "python/instrumentation/openinference-instrumentation-autogen": { + "package-name": "python-openinference-instrumentation-autogen", + "release-type": "python" } } }