Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
73a764c
cherry pick changes from previous PR
keith-decker Sep 17, 2025
0d749a9
move span utils to new file
keith-decker Sep 17, 2025
77d9c3c
remove span state, use otel context for parent/child
keith-decker Sep 17, 2025
054ebe9
flatten LLMInvocation to use attributes instead of dict keys
keith-decker Sep 17, 2025
9d3926f
helper function and docstrings
keith-decker Sep 17, 2025
635b7f8
Merge branch 'main' into util-genai-inference-clean
keith-decker Sep 18, 2025
9837cf4
refactor: store span and context token in LLMInvocation instead of Sp…
keith-decker Sep 18, 2025
1a172d1
refactor: rename prompts/chat_generations to input_messages/output_me…
keith-decker Sep 19, 2025
465ca78
refactor: simplify TelemetryHandler API by moving invocation data man…
keith-decker Sep 19, 2025
cd5aaa6
refactor: update relative imports to absolute imports
keith-decker Sep 19, 2025
8347d17
Update handler to use a context manager instead of start_llm and stop…
keith-decker Sep 22, 2025
742a36f
resolve tox -e doc failure
keith-decker Sep 22, 2025
00e08a8
safeguard against empty request-model
keith-decker Sep 22, 2025
109625c
Merge branch 'main' into util-genai-inference-clean
keith-decker Sep 22, 2025
80c94bf
fix tox typecheck errors for utils
keith-decker Sep 22, 2025
f07c61f
refactor: move tracer to generator, clean up dead code
keith-decker Sep 22, 2025
d6f722f
remove unused linting hint
keith-decker Sep 22, 2025
fdc7f50
back off stricter request-model requirements
keith-decker Sep 22, 2025
da20448
reintroduce manual start/stop for langchain callback flow
keith-decker Sep 22, 2025
f9c081f
util-genai-inference-clean merge
zhirafovod Sep 23, 2025
2a19bf4
opentelemetry-util-genai-dev
zhirafovod Sep 23, 2025
c1ff846
Merge branch 'main' into util-genai-inference-clean
aabmass Sep 23, 2025
4a08d7f
clean up context handler, clarify unit tests
keith-decker Sep 23, 2025
5691155
WIP adding types from dev to upstream types/handler
zhirafovod Sep 23, 2025
1c57ab7
migrate span generator to use updated data type
zhirafovod Sep 24, 2025
243bf8d
remove generator concept
keith-decker Sep 25, 2025
93ecfc1
E2e inference merge (#15)
keith-decker Sep 25, 2025
3d6c8da
Merge branch 'main' into util-genai-inference-clean
keith-decker Sep 25, 2025
5f8cd1c
update token types
keith-decker Sep 25, 2025
e987d66
Merge branch 'main' into util-genai-inference-clean
keith-decker Sep 26, 2025
e723ee5
Sync e2e with Main + Rnference PR (#16)
keith-decker Sep 26, 2025
6e0bb88
langchain-alpha to langchain-dev renaming
zhirafovod Sep 26, 2025
1798743
merging poc updates
zhirafovod Sep 30, 2025
51d28c0
code cleanup
keith-decker Sep 30, 2025
88d0149
Merge branch 'main' into util-genai-inference-clean
keith-decker Sep 30, 2025
00c4085
Merge branch 'genai-utils-e2e-dev' into e2e-inference-merge
keith-decker Sep 30, 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 docs/nitpick-exceptions.ini
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ py-class=
psycopg.AsyncConnection
ObjectProxy
fastapi.applications.FastAPI
_contextvars.Token

any=
; API
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# 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
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 authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
OpenTelemetry LangChain Instrumentation (Alpha)
=============================================

This package provides OpenTelemetry instrumentation for LangChain LLM/chat
workflows. It now relies solely on ``opentelemetry-util-genai`` (the earlier
``opentelemetry-genai-sdk`` toggle and related environment switch have been removed).

Status: Alpha (APIs and produced telemetry are subject to change).

Features
--------
* Automatic spans for LangChain ChatOpenAI (and compatible) invocations.
* Metrics for LLM latency and token usage (when available from the provider).
* (Optional) message content capture (disabled by default) for spans and logs.
* Tool (function) definitions recorded as request attributes.

Installation
------------
Install from source (monorepo layout example)::

pip install -e opentelemetry-instrumentation-langchain-alpha/

This will pull in required OpenTelemetry core + ``opentelemetry-util-genai``.

Quick Start
-----------

.. code:: python

from opentelemetry.instrumentation.langchain import LangChainInstrumentor
from langchain_openai import ChatOpenAI
from langchain_core.messages import HumanMessage, SystemMessage

# (Optionally) configure providers/exporters before instrumentation
LangChainInstrumentor().instrument()

llm = ChatOpenAI(model="gpt-4o-mini", temperature=0.0)
messages = [
SystemMessage(content="You are a helpful assistant."),
HumanMessage(content="What is the capital of France?"),
]
response = llm.invoke(messages)
print(response.content)

Environment Variables
---------------------

Message content (prompt + completion) is NOT collected unless explicitly enabled:

``OTEL_INSTRUMENTATION_LANGCHAIN_CAPTURE_MESSAGE_CONTENT``
Set to ``true`` (case-insensitive) to record message text in spans/logs.

For finer-grained content handling controlled by util-genai you may also use:

``OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT``
(See ``opentelemetry-util-genai`` docs) Values like ``SPAN_ONLY`` etc.

Removed / Deprecated
--------------------
* The legacy ``opentelemetry-genai-sdk`` integration and the environment flag
``OTEL_INSTRUMENTATION_LANGCHAIN_USE_UTIL_GENAI`` were removed. The util-genai
handler is now always used.
* Legacy evaluation framework imports (``get_telemetry_client``, ``TelemetryClient``,
``get_evaluator``) are no longer re-exported here.

Telemetry Semantics
-------------------
Spans use incubating GenAI semantic attributes (subject to change) including:

* ``gen_ai.operation.name`` (e.g. ``chat``)
* ``gen_ai.request.model`` / ``gen_ai.response.model``
* ``gen_ai.usage.input_tokens`` / ``gen_ai.usage.output_tokens`` (if provided)
* ``gen_ai.response.id``
* Tool/function definitions under ``gen_ai.request.function.{i}.*``

Metrics (if a MeterProvider is configured) include:

* LLM duration (histogram/sum depending on pipeline)
* Token usage counters (input / output)

Testing
-------
Run the package tests (from repository root or this directory)::

pytest -k langchain instrumentation-genai/opentelemetry-instrumentation-langchain-alpha/tests

(Recorded cassettes or proper API keys may be required for full integration tests.)

Contributing
------------
Issues / PRs welcome in the main opentelemetry-python-contrib repository. This
module is alpha: feedback on attribute coverage, performance, and LangChain
surface expansion is especially helpful.

License
-------
Apache 2.0

Loading
Loading