signalfx · etserend · Dec 4, 2025 · Dec 4, 2025 · Dec 5, 2025 · Dec 8, 2025
@@ -0,0 +1,3 @@
+examples/.env
+examples/openai_agents_multi_agent_travel/.env
+examples/**/.env
@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+- Document official package metadata and README for the OpenAI Agents instrumentation.
+  ([#3859](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3859))
+
+## Version 0.1.0 (2025-10-15)
+
+- Initial barebones package skeleton: minimal instrumentor stub, version module,
+  and packaging metadata/entry point.
+  ([#3805](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3805))
+- Implement OpenAI Agents span processing aligned with GenAI semantic conventions.
+  ([#3817](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3817))
+- Input and output according to GenAI spec.
+  ([#3824](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3824))
@@ -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 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
+      (which shall not include communication that is clearly marked or
+      otherwise designated in writing by the copyright owner as "Not a Work").
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based upon (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 clearly 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 use, reproduce, modify, distribute, and 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, trademark, patent,
+          attribution and other 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 notice 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 Support. When 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 support.
+
+   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.
@@ -0,0 +1,109 @@
+OpenTelemetry OpenAI Agents Instrumentation
+===========================================
+
+|pypi|
+
+.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-openai-agents-v2.svg
+   :target: https://pypi.org/project/opentelemetry-instrumentation-openai-agents-v2/
+
+This library provides the official OpenTelemetry instrumentation for the
+`openai-agents SDK <https://pypi.org/project/openai-agents/>`_. It converts
+the rich trace data emitted by the Agents runtime
+into the GenAI semantic conventions, enriches spans with request/response payload
+metadata, and records duration/token usage metrics.
+
+Features
+--------
+
+* Generates spans for agents, tools, generations, guardrails, and handoffs using
+  the OpenTelemetry GenAI semantic conventions.
+* Captures prompts, responses, tool arguments, and system instructions when content
+  capture is enabled.
+* Publishes duration and token metrics for every operation.
+* Supports environment overrides so you can configure agent metadata or disable
+  telemetry without code changes.
+
+Installation
+------------
+
+If your application is already configured with OpenTelemetry, install the package
+and its optional instruments:
+
+.. code-block:: console
+
+    pip install opentelemetry-instrumentation-openai-agents-v2
+    pip install openai-agents
+
+Usage
+-----
+
+Instrumentation automatically wires the Agents tracing processor into the SDK.
+Configure OpenTelemetry as usual, then call :class:`OpenAIAgentsInstrumentor`.
+
+.. code-block:: python
+
+    from agents import Agent, Runner, function_tool
+    from opentelemetry import trace
+    from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
+    from opentelemetry.instrumentation.openai_agents import OpenAIAgentsInstrumentor
+    from opentelemetry.sdk.trace import TracerProvider
+    from opentelemetry.sdk.trace.export import BatchSpanProcessor
+
+
+    def configure_otel() -> None:
+        provider = TracerProvider()
+        provider.add_span_processor(BatchSpanProcessor(OTLPSpanExporter()))
+        trace.set_tracer_provider(provider)
+
+        OpenAIAgentsInstrumentor().instrument(tracer_provider=provider)
+
+
+    @function_tool
+    def get_weather(city: str) -> str:
+        return f"The forecast for {city} is sunny with pleasant temperatures."
+
+
+    assistant = Agent(
+        name="Travel Concierge",
+        instructions="You are a concise travel concierge.",
+        tools=[get_weather],
+    )
+
+    result = Runner.run_sync(assistant, "I'm visiting Barcelona this weekend. How should I pack?")
+    print(result.final_output)
+
+Configuration
+-------------
+
+The instrumentor exposes runtime toggles through keyword arguments and environment
+variables:
+
+* ``OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT`` or
+  ``OTEL_INSTRUMENTATION_OPENAI_AGENTS_CAPTURE_CONTENT`` – controls how much
+  message content is captured. Valid values map to
+  :class:`opentelemetry.instrumentation.openai_agents.ContentCaptureMode`
+  (``span_only``, ``event_only``, ``span_and_event``, ``no_content``).
+* ``OTEL_INSTRUMENTATION_OPENAI_AGENTS_CAPTURE_METRICS`` – set to ``false`` to
+  disable duration/token metrics.
+* ``OTEL_INSTRUMENTATION_OPENAI_AGENTS_SYSTEM`` – overrides the ``gen_ai.system``
+  attribute when your deployment is not the default OpenAI platform.
+
+You can also override agent metadata directly when calling
+``OpenAIAgentsInstrumentor().instrument(...)`` using ``agent_name``, ``agent_id``,
+``agent_description``, ``base_url``, ``server_address``, and ``server_port``.
+
+Examples
+--------
+
+The :mod:`examples` directory contains runnable scenarios, including:
+
+* ``examples/manual`` – manual OpenTelemetry configuration for a single agent run.
+* ``examples/content-capture`` – demonstrates span and event content capture.
+* ``examples/zero-code`` – end-to-end setup using environment configuration only.
+
+References
+----------
+
+* `OpenTelemetry Python Contrib <https://github.com/open-telemetry/opentelemetry-python-contrib>`_
+* `OpenTelemetry GenAI semantic conventions <https://opentelemetry.io/docs/specs/semconv/gen-ai/gen-ai-spans/>`_
+* `OpenAI Agents SDK <https://github.com/openai/openai-agents-python>`_
@@ -0,0 +1,8 @@
+# Copy to .env and add values before running the sample.
+# Required for OpenAI client (only used if you swap in a real OpenAI call)
+OPENAI_API_KEY=
+
+# Optional overrides for span attributes / exporters
+OTEL_SERVICE_NAME=openai-agents-content-capture-demo
+OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
+OTEL_EXPORTER_OTLP_PROTOCOL=grpc
@@ -0,0 +1,42 @@
+# OpenAI Agents Content Capture Demo
+
+This example exercises the `OpenAIAgentsInstrumentor` with message content
+capture enabled, illustrating how prompts, responses, and tool payloads are
+recorded on spans and span events.
+
+> The demo uses the local tracing utilities from the `openai-agents`
+> package—no outbound API calls are made.
+
+## Prerequisites
+
+1. Activate the repository virtual environment:
+
+   ```bash
+   source ../../.venv/bin/activate
+   ```
+
+2. Copy `.env.example` to `.env` and provide any overrides you need (for example,
+   setting `OTEL_EXPORTER_OTLP_ENDPOINT`).
+3. Ensure `openai-agents` is installed in the environment (it is included in
+   the shared development venv for this repository).
+
+## Run the demo
+
+```bash
+python main.py
+```
+
+The script will:
+
+- Configure the OpenTelemetry SDK with an OTLP exporter so spans reach your collector.
+- Instrument the OpenAI Agents tracing hooks with content capture enabled.
+- Simulate an agent invocation that performs a generation and a tool call.
+- Print the resulting spans, attributes, and events (including JSON-encoded
+  prompts and responses) to stdout.
+
+## Customisation tips
+
+- Set `OTEL_SERVICE_NAME` before running to override the default service name.
+- Adjust the OTLP exporter configuration (endpoint, protocol) through `.env`.
+- Modify the prompts, tool payloads, or add additional spans in `run_workflow`
+  to explore different content capture scenarios.