Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
e414c1e
feat: OpenAI Agents tracing according to latest genai spec
nagkumar91 Sep 25, 2025
b42aeba
Merge branch 'main' into main
nagkumar91 Sep 25, 2025
475c23b
Commit the uv lock and readme update
nagkumar91 Sep 26, 2025
939c015
Add missing import
nagkumar91 Sep 26, 2025
4bfbcd3
Re-add readme after tox generate
nagkumar91 Sep 26, 2025
51bd178
Delete instrumentation-genai/opentelemetry-instrumentation-openai-age…
nagkumar91 Sep 26, 2025
327acf8
Delete instrumentation-genai/opentelemetry-instrumentation-openai-age…
nagkumar91 Sep 26, 2025
69262d6
Delete instrumentation-genai/opentelemetry-instrumentation-openai-age…
nagkumar91 Sep 26, 2025
d8b67f1
Delete instrumentation-genai/opentelemetry-instrumentation-openai-age…
nagkumar91 Sep 26, 2025
61f01cb
Delete instrumentation-genai/opentelemetry-instrumentation-openai-age…
nagkumar91 Sep 26, 2025
7137cab
Basic example and move the original one as quickstart
nagkumar91 Sep 26, 2025
a14881a
Update changelog
nagkumar91 Sep 26, 2025
2f62564
Remove env vars that are not a part of semantic convention
nagkumar91 Sep 26, 2025
2f59dd7
Using the right openai-agents
nagkumar91 Sep 26, 2025
a38ebc8
more updates to readme
nagkumar91 Sep 26, 2025
5c47332
remove ununsed env vars
nagkumar91 Sep 26, 2025
303c1ff
More explicit __all__
nagkumar91 Sep 26, 2025
1c4ced3
examples: reorganize samples and collectors; remove azure monitor fro…
nagkumar91 Sep 29, 2025
746c934
Merge branch 'main' into main
nagkumar91 Sep 29, 2025
353fdb0
GenAI: emit system_instructions as typed text objects; add redaction …
nagkumar91 Sep 30, 2025
8a90db1
Apply ruff-format after normalization changes
nagkumar91 Sep 30, 2025
91ee492
Fix ruff errors: remove unused variable; run ruff-format
nagkumar91 Sep 30, 2025
dd2fd58
GenAI: redact output message text when include_sensitive_data is Fals…
nagkumar91 Sep 30, 2025
a6cd2b0
Merge branch 'main' into main
nagkumar91 Oct 2, 2025
935f7dc
Merge branch 'main' into main
lzchen Oct 2, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions instrumentation-genai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
| --------------- | ------------------ | --------------- | -------------- |
| [opentelemetry-instrumentation-google-genai](./opentelemetry-instrumentation-google-genai) | google-genai >= 1.0.0 | No | development
| [opentelemetry-instrumentation-langchain](./opentelemetry-instrumentation-langchain) | langchain >= 0.3.21 | No | development
| [opentelemetry-instrumentation-openai-agents](./opentelemetry-instrumentation-openai-agents) | openai-agent >= 0.1.0 | Yes | development
| [opentelemetry-instrumentation-openai-v2](./opentelemetry-instrumentation-openai-v2) | openai >= 1.26.0 | Yes | development
| [opentelemetry-instrumentation-vertexai](./opentelemetry-instrumentation-vertexai) | google-cloud-aiplatform >= 1.64 | No | development
| [opentelemetry-instrumentation-weaviate](./opentelemetry-instrumentation-weaviate) | weaviate-client >= 3.0.0,<5.0.0 | No | development
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
examples/.env
examples/openai_agents_multi_agent_travel/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Changelog

## Unreleased

### Added

- Initial implementation of OpenAI Agents instrumentation ([#3762](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3762))

### Changed

### Deprecated

### Removed

### Fixed

### Security
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
OpenTelemetry OpenAI Agents Instrumentation
===========================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-openai-agents.svg
:target: https://pypi.org/project/opentelemetry-instrumentation-openai-agents/

This library instruments the `OpenAI Agents framework <https://openai.github.io/openai-agents-python/>`_
to trace requests and log messages flowing through agents. It also captures operation duration and
token usage as metrics.

Installation
------------

::

pip install opentelemetry-instrumentation-openai-agents

Dependency note
---------------

This instrumentation integrates with the OpenAI Agents framework via the
`openai-agents <https://pypi.org/project/openai-agents/>`_ package. Ensure
``openai-agents>=0.3.2`` is installed in environments where agent events are
emitted; otherwise, the instrumentor will load but skip processor setup.

Usage
-----

.. code:: python

from openai import OpenAI
from opentelemetry.instrumentation.openai_agents import OpenAIAgentsInstrumentor

OpenAIAgentsInstrumentor().instrument()

# Your OpenAI agents code here
client = OpenAI()

API
---

The `opentelemetry-instrumentation-openai-agents` package provides automatic instrumentation for the OpenAI Agents framework.

Configuration
--------------

This instrumentation captures content, metrics, and events by default with no additional configuration required.
If you are installing and setting up this tracing library, the assumption is you want full capture.

References
----------

* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenAI Python API Library <https://pypi.org/project/openai/>`_
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# OpenAI Agents Instrumentation Configuration Example
# ===================================================

# Copy this file to your project and modify as needed
# Set these environment variables to configure the instrumentation

# Enable/disable content capture (request/response bodies)
# Default: false

# Standard OpenTelemetry configuration
# Set your service name
OTEL_SERVICE_NAME=my-openai-agents-service

# Set your service version
OTEL_SERVICE_VERSION=1.0.0

# Set your resource attributes
OTEL_RESOURCE_ATTRIBUTES=service.name=my-openai-agents-service,service.version=1.0.0

# Configure exporters (example for OTLP)
# OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
# OTEL_EXPORTER_OTLP_HEADERS=api-key=your-api-key

# Configure trace exporters
# OTEL_TRACES_EXPORTER=otlp

# Configure metrics exporters
# OTEL_METRICS_EXPORTER=otlp

# Configure logs exporters
# OTEL_LOGS_EXPORTER=otlp
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# OpenAI Agents Instrumentation Examples
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently all other genai instrumentations have a manual and zerocode examples. Perhaps we can follow up with a separate pr for zerocode. https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation-genai/opentelemetry-instrumentation-vertexai/examples


This directory contains examples of how to use the OpenAI Agents instrumentation.

## Files

- `quickstart.py` - Minimal OpenTelemetry setup and OpenAI chat sample.
- `basic_usage.py` - Tool-calling airline demo (no Azure Monitor).
- `mcp_hotel_capture_all.py` - MCP HTTP hotel finder sample (no Azure Monitor).
- `enhanced_travel_planner.py` - Complex orchestration travel planner (console exporter).
- `trace_collectors.py` - Showcase of Console, OTLP gRPC/HTTP, and Azure Monitor exporters.
- `.env.example` - Example environment variables configuration.

## Basic Usage

1. Install the package:
```bash
pip install opentelemetry-instrumentation-openai-agents
```

2. Set up your environment variables (copy `.env.example` to `.env` and modify as needed):
```bash
cp .env.example .env
```

3. Run the basic example:
```bash
python examples/quickstart.py
```

## Configuration

Content, metrics, and events are captured by default.

## Integration with Agent Frameworks

This instrumentation is designed to work with OpenAI-based agent frameworks. Common use cases include:

- Multi-agent systems
- Conversational AI applications
- Automated reasoning systems
- Task-oriented agents

## Observability Features

The instrumentation provides:

- **Distributed tracing** - Track requests across agent interactions
- **Metrics collection** - Monitor token usage, latency, and error rates
- **Content capture** - Optional logging of request/response content
- **Error tracking** - Automatic error status recording

## Security Considerations

When enabling content capture, be aware that:

- Request and response content may contain sensitive information
- Content is included in telemetry data
- Ensure your telemetry backend has appropriate security measures
- Consider data retention policies for captured content
Loading
Loading