tracespan 0.2.0__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.
- tracespan-0.2.0/LICENSE +201 -0
- tracespan-0.2.0/MANIFEST.in +16 -0
- tracespan-0.2.0/PKG-INFO +288 -0
- tracespan-0.2.0/README.md +264 -0
- tracespan-0.2.0/examples/deepagents_sqlite.py +126 -0
- tracespan-0.2.0/examples/langchain_integration.py +85 -0
- tracespan-0.2.0/examples/langgraph_sqlite.py +157 -0
- tracespan-0.2.0/examples/quickstart.py +60 -0
- tracespan-0.2.0/pyproject.toml +35 -0
- tracespan-0.2.0/setup.cfg +4 -0
- tracespan-0.2.0/tests/test_langgraph.py +184 -0
- tracespan-0.2.0/tests/test_tracespan.py +331 -0
- tracespan-0.2.0/tracespan/__init__.py +84 -0
- tracespan-0.2.0/tracespan/context.py +109 -0
- tracespan-0.2.0/tracespan/instrumentation/__init__.py +13 -0
- tracespan-0.2.0/tracespan/instrumentation/callbacks.py +274 -0
- tracespan-0.2.0/tracespan/instrumentation/langchain.py +127 -0
- tracespan-0.2.0/tracespan/instrumentation/patch.py +190 -0
- tracespan-0.2.0/tracespan/models.py +289 -0
- tracespan-0.2.0/tracespan/py.typed +0 -0
- tracespan-0.2.0/tracespan/query.py +152 -0
- tracespan-0.2.0/tracespan/serialization.py +84 -0
- tracespan-0.2.0/tracespan/store/__init__.py +28 -0
- tracespan-0.2.0/tracespan/store/base.py +93 -0
- tracespan-0.2.0/tracespan/store/file.py +147 -0
- tracespan-0.2.0/tracespan/store/mysql.py +83 -0
- tracespan-0.2.0/tracespan/store/postgres.py +80 -0
- tracespan-0.2.0/tracespan/store/sql.py +326 -0
- tracespan-0.2.0/tracespan/store/sqlite.py +79 -0
- tracespan-0.2.0/tracespan/tracer.py +409 -0
- tracespan-0.2.0/tracespan.egg-info/SOURCES.txt +28 -0
tracespan-0.2.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
include README.md
|
|
2
|
+
include LICENSE
|
|
3
|
+
include pyproject.toml
|
|
4
|
+
|
|
5
|
+
recursive-include tracespan *.py py.typed
|
|
6
|
+
recursive-include examples *.py
|
|
7
|
+
recursive-include tests *.py
|
|
8
|
+
|
|
9
|
+
recursive-exclude * __pycache__ *.py[cod]
|
|
10
|
+
global-exclude *.db *.db-shm *.db-wal *.jsonl
|
|
11
|
+
|
|
12
|
+
prune .workbuddy
|
|
13
|
+
prune .idea
|
|
14
|
+
prune build
|
|
15
|
+
prune dist
|
|
16
|
+
prune *.egg-info
|
tracespan-0.2.0/PKG-INFO
ADDED
|
@@ -0,0 +1,288 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: tracespan
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: 无侵入的 Agent 行为追踪库:Trace/Span 两级模型、可插拔存储、查询与排错接口
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
Keywords: agent,tracing,observability,langchain,langgraph,deepagents,llm
|
|
7
|
+
Classifier: Development Status :: 3 - Alpha
|
|
8
|
+
Classifier: Intended Audience :: Developers
|
|
9
|
+
Classifier: Programming Language :: Python :: 3
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
13
|
+
Classifier: Typing :: Typed
|
|
14
|
+
Requires-Python: >=3.10
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
License-File: LICENSE
|
|
17
|
+
Provides-Extra: mysql
|
|
18
|
+
Requires-Dist: pymysql>=1.1; extra == "mysql"
|
|
19
|
+
Provides-Extra: postgres
|
|
20
|
+
Requires-Dist: psycopg[binary]>=3.1; extra == "postgres"
|
|
21
|
+
Provides-Extra: langchain
|
|
22
|
+
Requires-Dist: langchain-core>=0.2; extra == "langchain"
|
|
23
|
+
Dynamic: license-file
|
|
24
|
+
|
|
25
|
+
# tracespan —— 无侵入的 Agent 行为追踪库
|
|
26
|
+
|
|
27
|
+
记录 Agent 每一次运行的 **trace(主表)** 与 **span(附表)**,覆盖:
|
|
28
|
+
|
|
29
|
+
- 运行参数(模型、温度、thread_id、工具实参、token 用量……)
|
|
30
|
+
- 耗时(每一步与整次运行)
|
|
31
|
+
- 是否失败(异常类型与消息,追踪层不吞业务异常)
|
|
32
|
+
- 用户 `user_id`、`agent_id`、`session_id`
|
|
33
|
+
- 输入输出、标签、元数据
|
|
34
|
+
|
|
35
|
+
存储层是**抽象基类 + 多实现**,接入方式是**无感补丁**,查询层提供**面向排错的高层接口**。
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 一、安装与目录
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pip install tracespan # 从 PyPI 安装(核心零依赖)
|
|
43
|
+
pip install 'tracespan[mysql]' # 可选:MySQL 后端
|
|
44
|
+
pip install 'tracespan[postgres]'# 可选:PostgreSQL 后端
|
|
45
|
+
|
|
46
|
+
# 或从源码安装
|
|
47
|
+
cd trace
|
|
48
|
+
pip install -e .
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
trace/
|
|
53
|
+
├── tracespan/
|
|
54
|
+
│ ├── models.py # Trace / Span / Status / SpanKind / 过滤器
|
|
55
|
+
│ ├── serialization.py # 安全 JSON 序列化(截断、降级)
|
|
56
|
+
│ ├── context.py # ContextVar 传播 trace/span/身份
|
|
57
|
+
│ ├── tracer.py # Tracer、@traced、全局配置
|
|
58
|
+
│ ├── query.py # 查询与排错接口
|
|
59
|
+
│ ├── store/
|
|
60
|
+
│ │ ├── base.py # ★ TraceStore 抽象基类
|
|
61
|
+
│ │ ├── sql.py # SQL 通用实现(方言适配)
|
|
62
|
+
│ │ ├── file.py # 本地 JSONL
|
|
63
|
+
│ │ ├── sqlite.py # SQLite
|
|
64
|
+
│ │ ├── mysql.py # MySQL
|
|
65
|
+
│ │ └── postgres.py # PostgreSQL
|
|
66
|
+
│ └── instrumentation/
|
|
67
|
+
│ ├── patch.py # 通用无感补丁
|
|
68
|
+
│ ├── callbacks.py # LangChain 回调 -> span(chain/llm/tool)
|
|
69
|
+
│ └── langchain.py # LangChain / LangGraph 适配
|
|
70
|
+
├── examples/
|
|
71
|
+
│ ├── quickstart.py
|
|
72
|
+
│ ├── langchain_integration.py
|
|
73
|
+
│ ├── langgraph_sqlite.py # LangGraph 接入 + SQLite 落库
|
|
74
|
+
│ └── deepagents_sqlite.py # deepagents 接入 + SQLite 落库
|
|
75
|
+
└── tests/
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## 二、30 秒上手
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
import tracespan as at
|
|
84
|
+
|
|
85
|
+
tracer = at.configure(dir="./traces") # 本地文件;也可 db_path="traces.db"
|
|
86
|
+
|
|
87
|
+
with at.bind_run(user_id="u-1", agent_id="cs", session_id="s-1"):
|
|
88
|
+
with tracer.trace("customer_service", input={"q": "退款"}) as trace:
|
|
89
|
+
with tracer.span("intent", kind=at.SpanKind.LLM, params={"model": "gpt-4o"}):
|
|
90
|
+
pass
|
|
91
|
+
with tracer.span("refund_api", kind=at.SpanKind.TOOL,
|
|
92
|
+
params={"args": {"order_id": "A100"}}):
|
|
93
|
+
pass
|
|
94
|
+
|
|
95
|
+
q = at.query(tracer.store)
|
|
96
|
+
print(q.summary()) # 总数 / 成功 / 失败 / 失败率 / 平均与 P95 耗时
|
|
97
|
+
print(q.format_errors()) # 可读的失败报告(含具体失败 span)
|
|
98
|
+
print(q.format_trace(trace.trace_id))
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
运行示例:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
../venv/bin/python examples/quickstart.py
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### deepagents + SQLite 完整示例
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
../venv/bin/python examples/deepagents_sqlite.py # 离线假模型,无需 Key
|
|
111
|
+
DEEPSEEK_API_KEY=sk-... ../venv/bin/python examples/deepagents_sqlite.py --real
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
一次 `agent.invoke(...)` 自动落一条 trace;借助注入的回调处理器,deepagents 内部的
|
|
115
|
+
`chain → model → llm / tools → tool` 也会落成带父子关系与耗时的 span 树:
|
|
116
|
+
|
|
117
|
+
```python
|
|
118
|
+
import tracespan as at
|
|
119
|
+
|
|
120
|
+
tracer = at.configure(db_path="traces.db") # SQLite
|
|
121
|
+
at.instrument_langchain() # invoke 补丁 + 内部回调,业务代码不用改
|
|
122
|
+
|
|
123
|
+
with at.bind_run(user_id="u-1001", agent_id="demo_deep_agent", session_id="s-7"):
|
|
124
|
+
result = agent.invoke({"messages": [HumanMessage(content="查订单 A100")]}, config={...})
|
|
125
|
+
|
|
126
|
+
print(at.query(tracer.store).format_trace(trace_id))
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
`instrument_langchain(inject_callbacks=False)` 可关闭内部回调,只记录最外层 invoke。
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## 三、存储层:基类 + 多实现
|
|
134
|
+
|
|
135
|
+
所有后端实现同一个 `TraceStore` 接口,替换后端不需要改任何业务代码:
|
|
136
|
+
|
|
137
|
+
| 实现 | 说明 | 依赖 |
|
|
138
|
+
|---|---|---|
|
|
139
|
+
| `FileTraceStore(dir=...)` | 本地 append-only JSONL,零依赖、开箱即用 | 无 |
|
|
140
|
+
| `SQLiteTraceStore(db_path=...)` | 本地数据库,线程安全 | 标准库 `sqlite3` |
|
|
141
|
+
| `MySQLTraceStore(host=..., user=..., database=...)` | MySQL / MariaDB | `pymysql` |
|
|
142
|
+
| `PostgresTraceStore(dsn=...)` | PostgreSQL | `psycopg` |
|
|
143
|
+
|
|
144
|
+
```python
|
|
145
|
+
# 同一套 API,随便切换
|
|
146
|
+
store = at.SQLiteTraceStore("traces.db")
|
|
147
|
+
store = at.MySQLTraceStore(host="127.0.0.1", user="root", password="...", database="trace")
|
|
148
|
+
store = at.PostgresTraceStore(dsn="postgresql://user:pwd@host:5432/trace")
|
|
149
|
+
|
|
150
|
+
tracer = at.Tracer(store) # 上层完全不变
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### 自定义后端
|
|
154
|
+
|
|
155
|
+
继承 `TraceStore`,实现 9 个方法即可(`save_trace / save_span / get_trace / get_span /
|
|
156
|
+
get_spans / query_traces / query_spans / delete_trace / close`):
|
|
157
|
+
|
|
158
|
+
```python
|
|
159
|
+
from tracespan.store import TraceStore
|
|
160
|
+
|
|
161
|
+
class MyStore(TraceStore):
|
|
162
|
+
def save_trace(self, trace): ...
|
|
163
|
+
...
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
若是 SQL 数据库,更省事的做法是继承 `tracespan.store.sql.SQLTraceStore`,
|
|
167
|
+
只需提供 `_connect()`、`SCHEMA`、`PLACEHOLDER` 与 `CONFLICT_STYLE`。
|
|
168
|
+
|
|
169
|
+
### 表结构
|
|
170
|
+
|
|
171
|
+
**trace(一次 Agent 运行一行)**
|
|
172
|
+
|
|
173
|
+
| 字段 | 说明 |
|
|
174
|
+
|---|---|
|
|
175
|
+
| `trace_id` / `name` / `parent_trace_id` | 主键 / 名称 / 父链路 |
|
|
176
|
+
| `user_id` / `agent_id` / `session_id` | 运行身份(需求字段) |
|
|
177
|
+
| `status` / `is_failed` / `error` | `running` / `ok` / `error`、失败布尔值、异常信息 |
|
|
178
|
+
| `start_time` / `end_time` / `duration_ms` | 时间与耗时 |
|
|
179
|
+
| `input_json` / `output_json` / `params_json` | 输入输出与运行参数(JSON) |
|
|
180
|
+
| `tags_json` / `metadata_json` | 标签与元数据 |
|
|
181
|
+
|
|
182
|
+
**span(一次步骤一行,通过 `parent_span_id` 组成调用树)**
|
|
183
|
+
|
|
184
|
+
| 字段 | 说明 |
|
|
185
|
+
|---|---|
|
|
186
|
+
| `span_id` / `trace_id` / `parent_span_id` | 主键 / 所属 trace / 父 span |
|
|
187
|
+
| `name` / `kind` | 名称 / `agent` \| `chain` \| `llm` \| `tool` \| `retrieval` \| `business` \| `custom` |
|
|
188
|
+
| `user_id` / `agent_id` / `session_id` | 冗余存储,便于直接按身份过滤 span |
|
|
189
|
+
| `status` / `is_failed` / `error` / `duration_ms` | 同 trace |
|
|
190
|
+
| `input_json` / `output_json` / `params_json` | 工具实参、模型参数、token 用量等 |
|
|
191
|
+
|
|
192
|
+
索引:`user_id` / `agent_id` / `session_id` / `status` / `kind` / `trace_id` / `parent_span_id`。
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
## 四、无感接入(核心)
|
|
197
|
+
|
|
198
|
+
### 方式一:框架级一次性打补丁(推荐)
|
|
199
|
+
|
|
200
|
+
现有代码里 `agent.invoke(...)` / `await agent.ainvoke(...)` **一行都不用改**:
|
|
201
|
+
|
|
202
|
+
```python
|
|
203
|
+
import tracespan as at
|
|
204
|
+
|
|
205
|
+
at.configure(db_path="traces.db")
|
|
206
|
+
at.instrument_langchain() # 给 Runnable / Pregel / CompiledStateGraph 打补丁
|
|
207
|
+
|
|
208
|
+
# ... 你的原有代码,照常调用 agent.invoke(...)
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
需要停用时 `at.uninstrument_langchain()`。默认不包裹 `stream/astream`,
|
|
212
|
+
避免 LangGraph 内部 invoke 与 stream 互相调用时产生重复 span;如需要可传 `patch_stream=True`。
|
|
213
|
+
|
|
214
|
+
### 方式二:任意框架/任意方法
|
|
215
|
+
|
|
216
|
+
```python
|
|
217
|
+
at.instrument(MyFramework, "run", name="my_agent", kind=at.SpanKind.AGENT,
|
|
218
|
+
params=lambda owner, args, kwargs: {"model": kwargs.get("model")})
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
支持同步、异步、生成器与异步生成器方法,打补丁是幂等的。
|
|
222
|
+
|
|
223
|
+
### 方式三:装饰器
|
|
224
|
+
|
|
225
|
+
```python
|
|
226
|
+
@at.traced(kind=at.SpanKind.TOOL, agent_id="search")
|
|
227
|
+
def search(query: str):
|
|
228
|
+
...
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
### 身份透传
|
|
232
|
+
|
|
233
|
+
```python
|
|
234
|
+
with at.bind_run(user_id="u-7", agent_id="cs", session_id="s-9", env="prod"):
|
|
235
|
+
agent.invoke(...)
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
`bind_run` 绑定的身份与 `env="prod"` 这类 baggage 会自动进入其下所有 trace/span
|
|
239
|
+
的对应字段与 `params`,异步任务之间互不串线。
|
|
240
|
+
|
|
241
|
+
---
|
|
242
|
+
|
|
243
|
+
## 五、查询与排错接口
|
|
244
|
+
|
|
245
|
+
```python
|
|
246
|
+
q = at.query(store)
|
|
247
|
+
|
|
248
|
+
q.traces(user_id="u-1", agent_id="cs", failed_only=True, min_duration_ms=1000)
|
|
249
|
+
q.spans(trace_id="...", kind=at.SpanKind.TOOL, failed_only=True)
|
|
250
|
+
q.by_user("u-1") / q.by_agent("cs") / q.by_session("s-9")
|
|
251
|
+
q.failed_traces() / q.failed_spans() / q.errors()
|
|
252
|
+
q.slow_traces(min_duration_ms=1000)
|
|
253
|
+
q.summary() # {total, ok, failed, error_rate, avg/p95_duration_ms}
|
|
254
|
+
q.tree(trace_id) / q.flat_tree(trace_id)
|
|
255
|
+
q.format_errors() # 人类可读的失败清单,含失败 span
|
|
256
|
+
q.format_trace(trace_id) # 带耗时与错误的调用树
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
存储层也提供快捷方法:`store.find_errors()`、`store.trace_tree(trace_id)`、`store.list_traces()`。
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## 六、设计取舍
|
|
264
|
+
|
|
265
|
+
- **追踪不能影响业务**:序列化对未知类型降级为截断字符串;异常落库后原样抛出。
|
|
266
|
+
- **运行中可观察**:trace/span 在开始时先写一条 `running`,结束时 upsert 更新,
|
|
267
|
+
因此长任务在执行过程中就能被查询到。
|
|
268
|
+
- **文本截断**:默认单字段 8000 字符,防止大 prompt / 大响应撑爆存储。
|
|
269
|
+
- **零强制依赖**:核心只用标准库;MySQL/PostgreSQL/LangChain 均为可选依赖。
|
|
270
|
+
- **一个实现一种职责**:存储、上下文、追踪、接入、查询各自独立,可单独替换。
|
|
271
|
+
|
|
272
|
+
## 七、验证
|
|
273
|
+
|
|
274
|
+
```bash
|
|
275
|
+
cd trace
|
|
276
|
+
../venv/bin/python -m unittest discover -s tests -v # 17 个测试全部通过
|
|
277
|
+
../venv/bin/python -m unittest tests.test_langgraph -v # 只跑 LangGraph 用例
|
|
278
|
+
../venv/bin/python examples/quickstart.py
|
|
279
|
+
../venv/bin/python examples/langchain_integration.py
|
|
280
|
+
../venv/bin/python examples/langgraph_sqlite.py
|
|
281
|
+
../venv/bin/python examples/deepagents_sqlite.py
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
`examples/langgraph_sqlite.py` 用条件路由图演示 `classify(llm) → order(tool)`,
|
|
285
|
+
运行后可在 `./tracespan.db` 中查看 trace 与 span 树。
|
|
286
|
+
|
|
287
|
+
`tests/test_langgraph.py` 覆盖 LangGraph 的同步 `invoke`、异步 `ainvoke`、节点异常、
|
|
288
|
+
调用树与查询报告,使用离线假模型并真实写入 SQLite。
|