tencentcloud-agentobs-sdk-langchain 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (22) hide show
  1. tencentcloud_agentobs_sdk_langchain-0.0.1/LICENSE +191 -0
  2. tencentcloud_agentobs_sdk_langchain-0.0.1/PKG-INFO +182 -0
  3. tencentcloud_agentobs_sdk_langchain-0.0.1/README.md +149 -0
  4. tencentcloud_agentobs_sdk_langchain-0.0.1/pyproject.toml +54 -0
  5. tencentcloud_agentobs_sdk_langchain-0.0.1/setup.cfg +4 -0
  6. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain/__init__.py +369 -0
  7. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain/cls_cloud_exporter.py +513 -0
  8. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain/config.py +234 -0
  9. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain/patch_react_step.py +208 -0
  10. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain/patch_rerank.py +398 -0
  11. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain/session_manager.py +110 -0
  12. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain/span_utils.py +512 -0
  13. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain/tracer.py +1585 -0
  14. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain/version.py +1 -0
  15. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain.egg-info/PKG-INFO +182 -0
  16. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain.egg-info/SOURCES.txt +20 -0
  17. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain.egg-info/dependency_links.txt +1 -0
  18. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain.egg-info/requires.txt +10 -0
  19. tencentcloud_agentobs_sdk_langchain-0.0.1/tencentcloud_agentobs_sdk_langchain.egg-info/top_level.txt +1 -0
  20. tencentcloud_agentobs_sdk_langchain-0.0.1/tests/test_patch_react_step.py +324 -0
  21. tencentcloud_agentobs_sdk_langchain-0.0.1/tests/test_patch_rerank.py +396 -0
  22. tencentcloud_agentobs_sdk_langchain-0.0.1/tests/test_tracer_react_rerank.py +220 -0
@@ -0,0 +1,191 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to the Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by the Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding any notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ Copyright 2024 Tencent Cloud
180
+
181
+ Licensed under the Apache License, Version 2.0 (the "License");
182
+ you may not use this file except in compliance with the License.
183
+ You may obtain a copy of the License at
184
+
185
+ http://www.apache.org/licenses/LICENSE-2.0
186
+
187
+ Unless required by applicable law or agreed to in writing, software
188
+ distributed under the License is distributed on an "AS IS" BASIS,
189
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190
+ See the License for the specific language governing permissions and
191
+ limitations under the License.
@@ -0,0 +1,182 @@
1
+ Metadata-Version: 2.4
2
+ Name: tencentcloud-agentobs-sdk-langchain
3
+ Version: 0.0.1
4
+ Summary: CLS observability SDK for LangChain/LangGraph — 6-layer span hierarchy, direct upload to Tencent Cloud CLS
5
+ Author: Tencent Cloud CLS Team
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://cloud.tencent.com/product/cls
8
+ Project-URL: Documentation, https://cloud.tencent.com/document/product/614
9
+ Project-URL: Repository, https://github.com/TencentCloud/cls-sdk-langchain
10
+ Keywords: tencent,cls,langchain,langgraph,opentelemetry,observability,llm
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: License :: OSI Approved :: Apache Software License
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.9
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Topic :: System :: Monitoring
20
+ Requires-Python: >=3.9
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE
23
+ Requires-Dist: langchain-core>=0.2.0
24
+ Requires-Dist: opentelemetry-api>=1.20.0
25
+ Requires-Dist: opentelemetry-sdk>=1.20.0
26
+ Requires-Dist: opentelemetry-instrumentation>=0.40b0
27
+ Requires-Dist: wrapt>=1.14.0
28
+ Requires-Dist: tencentcloud-cls-sdk-python>=1.0.8
29
+ Provides-Extra: dev
30
+ Requires-Dist: pytest>=7.0; extra == "dev"
31
+ Requires-Dist: pytest-cov>=4.0; extra == "dev"
32
+ Dynamic: license-file
33
+
34
+ # tencentcloud-agentobs-sdk-langchain
35
+
36
+ [中文文档](README.zh-CN.md)
37
+
38
+ Observability SDK for **LangChain / LangGraph**: automatically intercepts
39
+ LangChain callback and LangGraph node lifecycle events, converts them into OTel
40
+ spans conforming to the Tencent Cloud CLS GenAI Trace specification, and uploads
41
+ directly to **Tencent Cloud CLS**.
42
+
43
+ - **Zero intrusion**: one `setup()` call (or `LangChainInstrumentor().instrument()`) completes instrumentation — no changes to business code
44
+ - **Faithful trace tree**: each `graph.invoke()` produces a complete trace with an `entry → agent → step → chat / tool` hierarchy that mirrors the framework's real call structure
45
+ - **Concurrency safe**: parent-child relationships are derived from the framework's `parent_run_id` — parallel tool calls and nested sub-agents just work
46
+ - **Compliance ready**: three content capture modes (`full` / `truncate` / `off`) for strict data-residency requirements
47
+ - **Full metrics**: token usage, finish_reason, tool error classification, ReAct round tracking
48
+
49
+ ---
50
+
51
+ ## Installation
52
+
53
+ ```bash
54
+ pip install tencentcloud-agentobs-sdk-langchain
55
+ ```
56
+
57
+ Runtime dependencies are installed automatically. The key ones:
58
+
59
+ - `langchain-core > 0.1.0` — the target framework being instrumented
60
+ - `tencentcloud-cls-sdk-python >= 1.0.8` — CLS upload client
61
+
62
+ For LangGraph agents you additionally need `langgraph`, and for LLM calls a
63
+ provider integration such as `langchain-openai`.
64
+
65
+ Requires **Python >= 3.9**.
66
+
67
+ ---
68
+
69
+ ## Quick Start
70
+
71
+ A single `setup()` handles all initialization:
72
+
73
+ ```python
74
+ import os
75
+ from tencentcloud_agentobs_sdk_langchain import setup, CLSConfig
76
+
77
+ # 1. Configure your LLM provider (managed by LangChain, not this SDK)
78
+ os.environ["OPENAI_API_KEY"] = "sk-xxxx"
79
+
80
+ # 2. Enable CLS observability (must be called before running any agent)
81
+ # Option A: all from environment variables
82
+ setup()
83
+
84
+ # Option B: explicit CLSConfig (unset fields fall back to env vars)
85
+ setup(CLSConfig(
86
+ endpoint="ap-guangzhou.cls.tencentcs.com",
87
+ topic_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
88
+ secret_id="your_secret_id",
89
+ secret_key="your_secret_key",
90
+ ))
91
+
92
+ # 3. Use LangChain / LangGraph as usual
93
+ from langchain_core.tools import tool
94
+ from langchain_openai import ChatOpenAI
95
+ from langgraph.prebuilt import create_react_agent
96
+
97
+ @tool
98
+ def get_weather(city: str) -> str:
99
+ """Look up the weather for a city."""
100
+ return {"Beijing": "Sunny, 26C"}.get(city, "Sunny, 25C")
101
+
102
+ agent = create_react_agent(ChatOpenAI(model="gpt-4o-mini"), tools=[get_weather])
103
+ result = agent.invoke({"messages": [("user", "What's the weather in Beijing?")]})
104
+ print(result["messages"][-1].content)
105
+ ```
106
+
107
+ `setup()` creates a `TracerProvider`, attaches the `CLSCloudExporter`, registers
108
+ instrumentation, and returns the provider (useful if you need to attach
109
+ additional processors).
110
+
111
+ ### Manual wiring (advanced)
112
+
113
+ ```python
114
+ from opentelemetry.sdk.trace import TracerProvider
115
+ from opentelemetry.sdk.trace.export import BatchSpanProcessor
116
+ from tencentcloud_agentobs_sdk_langchain import LangChainInstrumentor
117
+ from tencentcloud_agentobs_sdk_langchain.cls_cloud_exporter import CLSCloudExporter
118
+
119
+ provider = TracerProvider()
120
+ provider.add_span_processor(BatchSpanProcessor(CLSCloudExporter()))
121
+ LangChainInstrumentor().instrument(tracer_provider=provider)
122
+ ```
123
+
124
+ ---
125
+
126
+ ## Configuration
127
+
128
+ All fields resolve with the priority: **explicit `CLSConfig` value > environment variable > built-in default**.
129
+
130
+ | Field | Env var | Default | Meaning |
131
+ |---|---|---|---|
132
+ | `endpoint` | `CLS_ENDPOINT` | — | CLS API endpoint (required) |
133
+ | `topic_id` | `CLS_TOPIC_ID` | — | CLS log topic ID (required) |
134
+ | `secret_id` | `CLS_SECRET_ID` | — | Tencent Cloud SecretId (required) |
135
+ | `secret_key` | `CLS_SECRET_KEY` | — | Tencent Cloud SecretKey (required) |
136
+ | `service_name` | `CLS_SERVICE_NAME` / `OTEL_SERVICE_NAME` | `langchain-app` | Service / application name |
137
+ | `content_mode` | `OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT` | `full` | `full` / `truncate` / `off` |
138
+ | `batch_size` | `CLS_BATCH_SIZE` | `32` | Spans per upload batch (clamped 1–1000) |
139
+ | `debug` | `CLS_DEBUG` | `false` | Verbose SDK logging |
140
+ | `local_dump` | `CLS_LOCAL_DUMP` | `false` | Also write each uploaded batch to a local jsonl |
141
+ | `local_dump_file` | `CLS_LOCAL_DUMP_FILE` | `cls_spans.jsonl` | Local dump file path |
142
+ | `user_id` | `CLS_USER_ID` | — | End-user ID written to `gen_ai.user.id` |
143
+
144
+ SDK logs are written to `cls_sdk.log` (configurable via `CLS_SDK_LOG_FILE` /
145
+ `CLS_SDK_LOG_LEVEL`), using a rotating file handler.
146
+
147
+ ---
148
+
149
+ ## Span hierarchy
150
+
151
+ For a LangGraph `create_react_agent`, one `invoke()` produces:
152
+
153
+ ```
154
+ entry enter_application
155
+ └ agent invoke_agent
156
+ ├ step react round_1
157
+ │ ├ chain call_model
158
+ │ ├ chain RunnableSequence
159
+ │ │ ├ chain Prompt
160
+ │ │ └ chat <model>
161
+ │ ├ chain should_continue
162
+ │ └ tool execute_tool <name> (one per parallel tool call)
163
+ └ step react round_2
164
+ └ ...
165
+ ```
166
+
167
+ The tree faithfully reflects LangChain's real callback nesting: `chat` is nested
168
+ under its `RunnableSequence`, tool executions attach directly under the current
169
+ step, and each entry into the LangGraph `agent` node opens a new ReAct `step`.
170
+
171
+ ---
172
+
173
+ ## Examples
174
+
175
+ See [`example.py`](example.py) for a minimal end-to-end quick start
176
+ (LangGraph ReAct agent + `setup()`).
177
+
178
+ ---
179
+
180
+ ## License
181
+
182
+ Apache-2.0. See [LICENSE](LICENSE).
@@ -0,0 +1,149 @@
1
+ # tencentcloud-agentobs-sdk-langchain
2
+
3
+ [中文文档](README.zh-CN.md)
4
+
5
+ Observability SDK for **LangChain / LangGraph**: automatically intercepts
6
+ LangChain callback and LangGraph node lifecycle events, converts them into OTel
7
+ spans conforming to the Tencent Cloud CLS GenAI Trace specification, and uploads
8
+ directly to **Tencent Cloud CLS**.
9
+
10
+ - **Zero intrusion**: one `setup()` call (or `LangChainInstrumentor().instrument()`) completes instrumentation — no changes to business code
11
+ - **Faithful trace tree**: each `graph.invoke()` produces a complete trace with an `entry → agent → step → chat / tool` hierarchy that mirrors the framework's real call structure
12
+ - **Concurrency safe**: parent-child relationships are derived from the framework's `parent_run_id` — parallel tool calls and nested sub-agents just work
13
+ - **Compliance ready**: three content capture modes (`full` / `truncate` / `off`) for strict data-residency requirements
14
+ - **Full metrics**: token usage, finish_reason, tool error classification, ReAct round tracking
15
+
16
+ ---
17
+
18
+ ## Installation
19
+
20
+ ```bash
21
+ pip install tencentcloud-agentobs-sdk-langchain
22
+ ```
23
+
24
+ Runtime dependencies are installed automatically. The key ones:
25
+
26
+ - `langchain-core > 0.1.0` — the target framework being instrumented
27
+ - `tencentcloud-cls-sdk-python >= 1.0.8` — CLS upload client
28
+
29
+ For LangGraph agents you additionally need `langgraph`, and for LLM calls a
30
+ provider integration such as `langchain-openai`.
31
+
32
+ Requires **Python >= 3.9**.
33
+
34
+ ---
35
+
36
+ ## Quick Start
37
+
38
+ A single `setup()` handles all initialization:
39
+
40
+ ```python
41
+ import os
42
+ from tencentcloud_agentobs_sdk_langchain import setup, CLSConfig
43
+
44
+ # 1. Configure your LLM provider (managed by LangChain, not this SDK)
45
+ os.environ["OPENAI_API_KEY"] = "sk-xxxx"
46
+
47
+ # 2. Enable CLS observability (must be called before running any agent)
48
+ # Option A: all from environment variables
49
+ setup()
50
+
51
+ # Option B: explicit CLSConfig (unset fields fall back to env vars)
52
+ setup(CLSConfig(
53
+ endpoint="ap-guangzhou.cls.tencentcs.com",
54
+ topic_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
55
+ secret_id="your_secret_id",
56
+ secret_key="your_secret_key",
57
+ ))
58
+
59
+ # 3. Use LangChain / LangGraph as usual
60
+ from langchain_core.tools import tool
61
+ from langchain_openai import ChatOpenAI
62
+ from langgraph.prebuilt import create_react_agent
63
+
64
+ @tool
65
+ def get_weather(city: str) -> str:
66
+ """Look up the weather for a city."""
67
+ return {"Beijing": "Sunny, 26C"}.get(city, "Sunny, 25C")
68
+
69
+ agent = create_react_agent(ChatOpenAI(model="gpt-4o-mini"), tools=[get_weather])
70
+ result = agent.invoke({"messages": [("user", "What's the weather in Beijing?")]})
71
+ print(result["messages"][-1].content)
72
+ ```
73
+
74
+ `setup()` creates a `TracerProvider`, attaches the `CLSCloudExporter`, registers
75
+ instrumentation, and returns the provider (useful if you need to attach
76
+ additional processors).
77
+
78
+ ### Manual wiring (advanced)
79
+
80
+ ```python
81
+ from opentelemetry.sdk.trace import TracerProvider
82
+ from opentelemetry.sdk.trace.export import BatchSpanProcessor
83
+ from tencentcloud_agentobs_sdk_langchain import LangChainInstrumentor
84
+ from tencentcloud_agentobs_sdk_langchain.cls_cloud_exporter import CLSCloudExporter
85
+
86
+ provider = TracerProvider()
87
+ provider.add_span_processor(BatchSpanProcessor(CLSCloudExporter()))
88
+ LangChainInstrumentor().instrument(tracer_provider=provider)
89
+ ```
90
+
91
+ ---
92
+
93
+ ## Configuration
94
+
95
+ All fields resolve with the priority: **explicit `CLSConfig` value > environment variable > built-in default**.
96
+
97
+ | Field | Env var | Default | Meaning |
98
+ |---|---|---|---|
99
+ | `endpoint` | `CLS_ENDPOINT` | — | CLS API endpoint (required) |
100
+ | `topic_id` | `CLS_TOPIC_ID` | — | CLS log topic ID (required) |
101
+ | `secret_id` | `CLS_SECRET_ID` | — | Tencent Cloud SecretId (required) |
102
+ | `secret_key` | `CLS_SECRET_KEY` | — | Tencent Cloud SecretKey (required) |
103
+ | `service_name` | `CLS_SERVICE_NAME` / `OTEL_SERVICE_NAME` | `langchain-app` | Service / application name |
104
+ | `content_mode` | `OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT` | `full` | `full` / `truncate` / `off` |
105
+ | `batch_size` | `CLS_BATCH_SIZE` | `32` | Spans per upload batch (clamped 1–1000) |
106
+ | `debug` | `CLS_DEBUG` | `false` | Verbose SDK logging |
107
+ | `local_dump` | `CLS_LOCAL_DUMP` | `false` | Also write each uploaded batch to a local jsonl |
108
+ | `local_dump_file` | `CLS_LOCAL_DUMP_FILE` | `cls_spans.jsonl` | Local dump file path |
109
+ | `user_id` | `CLS_USER_ID` | — | End-user ID written to `gen_ai.user.id` |
110
+
111
+ SDK logs are written to `cls_sdk.log` (configurable via `CLS_SDK_LOG_FILE` /
112
+ `CLS_SDK_LOG_LEVEL`), using a rotating file handler.
113
+
114
+ ---
115
+
116
+ ## Span hierarchy
117
+
118
+ For a LangGraph `create_react_agent`, one `invoke()` produces:
119
+
120
+ ```
121
+ entry enter_application
122
+ └ agent invoke_agent
123
+ ├ step react round_1
124
+ │ ├ chain call_model
125
+ │ ├ chain RunnableSequence
126
+ │ │ ├ chain Prompt
127
+ │ │ └ chat <model>
128
+ │ ├ chain should_continue
129
+ │ └ tool execute_tool <name> (one per parallel tool call)
130
+ └ step react round_2
131
+ └ ...
132
+ ```
133
+
134
+ The tree faithfully reflects LangChain's real callback nesting: `chat` is nested
135
+ under its `RunnableSequence`, tool executions attach directly under the current
136
+ step, and each entry into the LangGraph `agent` node opens a new ReAct `step`.
137
+
138
+ ---
139
+
140
+ ## Examples
141
+
142
+ See [`example.py`](example.py) for a minimal end-to-end quick start
143
+ (LangGraph ReAct agent + `setup()`).
144
+
145
+ ---
146
+
147
+ ## License
148
+
149
+ Apache-2.0. See [LICENSE](LICENSE).
@@ -0,0 +1,54 @@
1
+ [build-system]
2
+ requires = ["setuptools>=68.0", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "tencentcloud-agentobs-sdk-langchain"
7
+ version = "0.0.1"
8
+ description = "CLS observability SDK for LangChain/LangGraph — 6-layer span hierarchy, direct upload to Tencent Cloud CLS"
9
+ readme = "README.md"
10
+ requires-python = ">=3.9"
11
+ license = { text = "Apache-2.0" }
12
+ authors = [
13
+ { name = "Tencent Cloud CLS Team" },
14
+ ]
15
+ keywords = ["tencent", "cls", "langchain", "langgraph", "opentelemetry", "observability", "llm"]
16
+ classifiers = [
17
+ "Development Status :: 4 - Beta",
18
+ "Intended Audience :: Developers",
19
+ "License :: OSI Approved :: Apache Software License",
20
+ "Programming Language :: Python :: 3",
21
+ "Programming Language :: Python :: 3.9",
22
+ "Programming Language :: Python :: 3.10",
23
+ "Programming Language :: Python :: 3.11",
24
+ "Programming Language :: Python :: 3.12",
25
+ "Topic :: System :: Monitoring",
26
+ ]
27
+
28
+ dependencies = [
29
+ "langchain-core>=0.2.0",
30
+ "opentelemetry-api>=1.20.0",
31
+ "opentelemetry-sdk>=1.20.0",
32
+ "opentelemetry-instrumentation>=0.40b0",
33
+ "wrapt>=1.14.0",
34
+ "tencentcloud-cls-sdk-python>=1.0.8",
35
+ ]
36
+
37
+ [project.optional-dependencies]
38
+ dev = [
39
+ "pytest>=7.0",
40
+ "pytest-cov>=4.0",
41
+ ]
42
+
43
+ [project.urls]
44
+ Homepage = "https://cloud.tencent.com/product/cls"
45
+ Documentation = "https://cloud.tencent.com/document/product/614"
46
+ Repository = "https://github.com/TencentCloud/cls-sdk-langchain"
47
+
48
+ [tool.setuptools.packages.find]
49
+ where = ["."]
50
+ include = ["tencentcloud_agentobs_sdk_langchain*"]
51
+
52
+ [tool.pytest.ini_options]
53
+ testpaths = ["tests"]
54
+ pythonpath = ["."]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+