obzerve 0.1.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.
- obzerve-0.1.0/.gitignore +21 -0
- obzerve-0.1.0/CHANGELOG.md +13 -0
- obzerve-0.1.0/LICENSE +202 -0
- obzerve-0.1.0/PKG-INFO +170 -0
- obzerve-0.1.0/README.md +122 -0
- obzerve-0.1.0/pyproject.toml +72 -0
- obzerve-0.1.0/src/obzerve/__init__.py +7 -0
- obzerve-0.1.0/src/obzerve/_version.py +3 -0
- obzerve-0.1.0/src/obzerve/attributes.py +61 -0
- obzerve-0.1.0/src/obzerve/cli.py +188 -0
- obzerve-0.1.0/src/obzerve/client.py +98 -0
- obzerve-0.1.0/src/obzerve/delivery.py +139 -0
- obzerve-0.1.0/src/obzerve/evals.py +156 -0
- obzerve-0.1.0/src/obzerve/instrumentation/__init__.py +117 -0
- obzerve-0.1.0/src/obzerve/instrumentation/_common.py +312 -0
- obzerve-0.1.0/src/obzerve/instrumentation/anthropic.py +279 -0
- obzerve-0.1.0/src/obzerve/instrumentation/huggingface_hub.py +218 -0
- obzerve-0.1.0/src/obzerve/instrumentation/openai.py +270 -0
- obzerve-0.1.0/src/obzerve/instrumentation/transformers.py +163 -0
- obzerve-0.1.0/src/obzerve/observer.py +621 -0
- obzerve-0.1.0/src/obzerve/payloads.py +109 -0
- obzerve-0.1.0/src/obzerve/py.typed +0 -0
- obzerve-0.1.0/src/obzerve/replay.py +224 -0
- obzerve-0.1.0/tests/conftest.py +37 -0
- obzerve-0.1.0/tests/test_delivery.py +115 -0
- obzerve-0.1.0/tests/test_instrument_anthropic.py +220 -0
- obzerve-0.1.0/tests/test_instrument_huggingface.py +254 -0
- obzerve-0.1.0/tests/test_instrument_openai.py +273 -0
- obzerve-0.1.0/tests/test_observer.py +185 -0
- obzerve-0.1.0/tests/test_replay.py +304 -0
obzerve-0.1.0/.gitignore
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
.venv/
|
|
3
|
+
__pycache__/
|
|
4
|
+
*.py[cod]
|
|
5
|
+
.pytest_cache/
|
|
6
|
+
.ruff_cache/
|
|
7
|
+
dist/
|
|
8
|
+
*.egg-info/
|
|
9
|
+
|
|
10
|
+
# Node
|
|
11
|
+
node_modules/
|
|
12
|
+
web/dist/
|
|
13
|
+
|
|
14
|
+
# Local config
|
|
15
|
+
.env
|
|
16
|
+
.env.local
|
|
17
|
+
|
|
18
|
+
# Editors / OS
|
|
19
|
+
.idea/
|
|
20
|
+
.vscode/
|
|
21
|
+
.DS_Store
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to the `obzerve` Python SDK. Versions follow [Semantic Versioning](https://semver.org/); while the version is 0.x, minor releases may change the API.
|
|
4
|
+
|
|
5
|
+
## 0.1.0
|
|
6
|
+
|
|
7
|
+
First release.
|
|
8
|
+
|
|
9
|
+
- Tracing built on OpenTelemetry: `Observer.trace()`, `span()`, `@observe`, a bounded non-blocking export, and exact delivery counters (`Observer.stats()`).
|
|
10
|
+
- Automatic instrumentation (`Observer.instrument()`) for `openai` (Chat Completions, Responses, Embeddings), `anthropic` (Messages, including streaming), `huggingface_hub` (`InferenceClient`) and `transformers` (`generate()` and text-generation pipelines): sync, async, and streams.
|
|
11
|
+
- Replay: `@replayable` operations, automatic recordings of non-streaming instrumented calls, and `RECORDED` / `LLM_LIVE` / `LIVE` policies with divergence detection and side-effect guards.
|
|
12
|
+
- Evaluations: `obzerve.evals.run_eval`, deterministic assertions, and the `obzerve` CLI (`case add`, `eval compare`, `eval gate`).
|
|
13
|
+
- Payload redaction and truncation; W3C trace-context propagation across services.
|
obzerve-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
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 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 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 those 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
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
obzerve-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: obzerve
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Observability, replay, and regression testing for AI agents: OpenTelemetry tracing with automatic instrumentation for OpenAI, Anthropic, and Hugging Face models.
|
|
5
|
+
Project-URL: Homepage, https://github.com/aryanfredericks/Obzerve
|
|
6
|
+
Project-URL: Documentation, https://github.com/aryanfredericks/Obzerve/blob/main/sdk/python/README.md
|
|
7
|
+
Project-URL: Source, https://github.com/aryanfredericks/Obzerve/tree/main/sdk/python
|
|
8
|
+
Project-URL: Issues, https://github.com/aryanfredericks/Obzerve/issues
|
|
9
|
+
Project-URL: Changelog, https://github.com/aryanfredericks/Obzerve/blob/main/sdk/python/CHANGELOG.md
|
|
10
|
+
Author: Aryan Fredericks
|
|
11
|
+
License-Expression: Apache-2.0
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Keywords: agents,ai-agents,anthropic,evals,huggingface,llm,observability,openai,opentelemetry,replay,tracing,transformers
|
|
14
|
+
Classifier: Development Status :: 3 - Alpha
|
|
15
|
+
Classifier: Intended Audience :: Developers
|
|
16
|
+
Classifier: Operating System :: OS Independent
|
|
17
|
+
Classifier: Programming Language :: Python :: 3
|
|
18
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
23
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
24
|
+
Classifier: Topic :: Software Development :: Testing
|
|
25
|
+
Classifier: Topic :: System :: Monitoring
|
|
26
|
+
Classifier: Typing :: Typed
|
|
27
|
+
Requires-Python: >=3.10
|
|
28
|
+
Requires-Dist: opentelemetry-api>=1.27
|
|
29
|
+
Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.27
|
|
30
|
+
Requires-Dist: opentelemetry-sdk>=1.27
|
|
31
|
+
Requires-Dist: requests>=2.28
|
|
32
|
+
Provides-Extra: all
|
|
33
|
+
Requires-Dist: anthropic>=2; extra == 'all'
|
|
34
|
+
Requires-Dist: huggingface-hub>=2; extra == 'all'
|
|
35
|
+
Requires-Dist: openai>=3; extra == 'all'
|
|
36
|
+
Requires-Dist: torch; extra == 'all'
|
|
37
|
+
Requires-Dist: transformers>=5; extra == 'all'
|
|
38
|
+
Provides-Extra: anthropic
|
|
39
|
+
Requires-Dist: anthropic>=2; extra == 'anthropic'
|
|
40
|
+
Provides-Extra: huggingface
|
|
41
|
+
Requires-Dist: huggingface-hub>=2; extra == 'huggingface'
|
|
42
|
+
Provides-Extra: openai
|
|
43
|
+
Requires-Dist: openai>=3; extra == 'openai'
|
|
44
|
+
Provides-Extra: transformers
|
|
45
|
+
Requires-Dist: torch; extra == 'transformers'
|
|
46
|
+
Requires-Dist: transformers>=5; extra == 'transformers'
|
|
47
|
+
Description-Content-Type: text/markdown
|
|
48
|
+
|
|
49
|
+
# Obzerve Python SDK
|
|
50
|
+
|
|
51
|
+
Observability, replay, and regression testing for AI agents.
|
|
52
|
+
|
|
53
|
+
`obzerve` traces what your agent does: LLM calls, tool calls, retrieval, and handoffs. Traces go to a self-hosted [Obzerve](https://github.com/aryanfredericks/Obzerve) server, where you can see the timeline, latency, errors, token usage, and estimated cost of every request. When something goes wrong, the SDK can replay the exact execution from its recordings and turn it into a regression test that gates your next release.
|
|
54
|
+
|
|
55
|
+
The SDK is built on OpenTelemetry and sends standard OTLP.
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
pip install obzerve # or: uv add obzerve
|
|
59
|
+
pip install "obzerve[openai]" # plus the client libraries you use: openai, anthropic,
|
|
60
|
+
# huggingface, transformers, or all
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
You need a running Obzerve server and a project API key. See the [getting-started guide](https://github.com/aryanfredericks/Obzerve/blob/main/docs/getting-started.md); `make stack-demo` starts one locally in containers.
|
|
64
|
+
|
|
65
|
+
## Trace an agent in three lines
|
|
66
|
+
|
|
67
|
+
```python
|
|
68
|
+
from obzerve import Observer
|
|
69
|
+
|
|
70
|
+
observer = Observer(endpoint="http://localhost:8000", api_key="obz_...", service_name="support-bot")
|
|
71
|
+
observer.instrument() # trace OpenAI, Anthropic and Hugging Face calls automatically
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
def handle(ticket):
|
|
75
|
+
with observer.trace("support_bot", input={"ticket": ticket}) as trace:
|
|
76
|
+
answer = ... # your agent: every LLM call inside becomes a span of this trace
|
|
77
|
+
trace.set_output(answer)
|
|
78
|
+
return answer
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Automatic instrumentation
|
|
82
|
+
|
|
83
|
+
`observer.instrument()` patches the supported client libraries that are installed. Every model call becomes an LLM span inside the active trace, recording:
|
|
84
|
+
- model and provider
|
|
85
|
+
- sampling settings
|
|
86
|
+
- input, output, and cached token counts
|
|
87
|
+
- finish reason
|
|
88
|
+
- inputs and outputs, subject to redaction and `capture_payloads`
|
|
89
|
+
|
|
90
|
+
| Library | What is traced |
|
|
91
|
+
| --- | --- |
|
|
92
|
+
| `openai` | Chat Completions, Responses, and Embeddings: sync, async, and streams. OpenAI-compatible servers (vLLM, Ollama, TGI, LM Studio, ...) reached through the OpenAI client are recorded as `openai_compatible`, with their server address |
|
|
93
|
+
| `anthropic` | `messages.create` (including `stream=True`) and the `messages.stream()` helper, sync and async. Cache reads and writes are included in input tokens, and cache reads are priced as cached tokens |
|
|
94
|
+
| `huggingface_hub` | `InferenceClient.chat_completion` (also reached as `client.chat.completions.create`) and `text_generation`, sync, async, and streams. Covers the serverless Inference API, Inference Endpoints, and self-hosted TGI |
|
|
95
|
+
| `transformers` | Any local model's `generate()` (model, device, prompt and generated token counts) and text-generation pipelines |
|
|
96
|
+
|
|
97
|
+
```python
|
|
98
|
+
observer.instrument(openai=True, anthropic=False) # True: require it; False: skip it;
|
|
99
|
+
# None (default): instrument it if installed
|
|
100
|
+
handle = observer.instrument()
|
|
101
|
+
handle.uninstrument() # restore the original libraries
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
`transformers` loads PyTorch on import, so by default it is instrumented only if your code has already imported it. Pass `transformers=True` to instrument it regardless.
|
|
105
|
+
|
|
106
|
+
Instrumentation never breaks your call: if a library changes shape, you lose telemetry, not the request. A streamed response stays open as one span until you finish reading it, close it, or leave its `with` block. Close streams you stop reading early.
|
|
107
|
+
|
|
108
|
+
## Spans you define yourself
|
|
109
|
+
|
|
110
|
+
```python
|
|
111
|
+
from obzerve import SpanKind
|
|
112
|
+
|
|
113
|
+
with observer.span("search_orders", kind=SpanKind.TOOL, input={"customer": cid}) as span:
|
|
114
|
+
orders = orders_api.search(cid)
|
|
115
|
+
span.set_output(orders)
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
@observer.observe(kind=SpanKind.RETRIEVAL) # decorator form, sync or async
|
|
119
|
+
def retrieve(query: str) -> list[str]: ...
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Exceptions mark the span as failed, with the error type and message. `span.record_retry(attempt, exc)` records retries. `span.set_llm(model=..., input_tokens=..., output_tokens=...)` records model usage for calls the instrumentation doesn't cover.
|
|
123
|
+
|
|
124
|
+
## Replay and regression testing
|
|
125
|
+
|
|
126
|
+
Calls through the instrumented libraries are recorded exactly: the whole response, rebuilt as the library's own response type during a replay. For your own tools, use `@observer.replayable`:
|
|
127
|
+
|
|
128
|
+
```python
|
|
129
|
+
@observer.replayable(kind=SpanKind.TOOL)
|
|
130
|
+
def lookup_order(order_id: str) -> dict: ...
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
@observer.replayable(kind=SpanKind.TOOL, side_effect=True) # never re-run by a replay
|
|
134
|
+
def refund(order_id: str) -> None: ...
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Then reproduce a production request, without calling any model or tool:
|
|
138
|
+
|
|
139
|
+
```python
|
|
140
|
+
from obzerve.client import ObzerveClient
|
|
141
|
+
from obzerve.replay import RECORDED, LLM_LIVE
|
|
142
|
+
|
|
143
|
+
bundle = ObzerveClient("http://localhost:8000", api_key).replay_bundle(trace_id)
|
|
144
|
+
with observer.replay(bundle, RECORDED): # or LLM_LIVE: tools recorded, model live
|
|
145
|
+
handle(**bundle.root_input)
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
Turn the trace into a regression case, run your eval dataset against a change, and gate the release in CI:
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
obzerve case add <trace_id> --dataset regressions --name "refund flow" --mode recorded --no-error
|
|
152
|
+
obzerve eval gate <baseline_run> <candidate_run> --max-regressions 0 # exits 1 on failure
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Run datasets with `obzerve.evals.run_eval`. The [main README](https://github.com/aryanfredericks/Obzerve#replay-and-regression-testing) covers the full workflow.
|
|
156
|
+
|
|
157
|
+
## Privacy and reliability defaults
|
|
158
|
+
|
|
159
|
+
- **Redaction:** captured inputs and outputs are redacted (keys such as `api_key`, `password`, `authorization`, plus bearer and `sk-…` tokens) and truncated. `Observer(capture_payloads=False)` turns capture off entirely.
|
|
160
|
+
- **Never in your way:** export runs in a background thread through a bounded buffer with short timeouts. A slow or unavailable server never blocks or fails your agent; telemetry is dropped instead. `observer.stats()` reports exactly how many spans were exported, failed, or dropped.
|
|
161
|
+
- **No global takeover:** the SDK uses its own OpenTelemetry tracer provider and never replaces yours.
|
|
162
|
+
- **Anthropic's own spans:** the Anthropic SDK can emit OpenTelemetry spans to your *global* provider. If you also send those to Obzerve, disable one of the two (`Anthropic(open_telemetry=False)`), or each call appears twice.
|
|
163
|
+
|
|
164
|
+
## Current limits
|
|
165
|
+
|
|
166
|
+
- Streamed responses are traced, but not yet recorded for replay. A replay that reaches one runs it live (`LLM_LIVE`) or fails with a clear error (`RECORDED`).
|
|
167
|
+
- Replay matches calls by operation name and order. Concurrent calls of the same operation can't yet be told apart reliably.
|
|
168
|
+
- Tested with Python 3.10–3.13, `openai` 3.x, `anthropic` 2.x, `huggingface_hub` 2.x, and `transformers` 5.x. Other versions are instrumented best-effort: an incompatible library logs a warning and is left alone.
|
|
169
|
+
|
|
170
|
+
Licensed under [Apache-2.0](https://github.com/aryanfredericks/Obzerve/blob/main/LICENSE).
|
obzerve-0.1.0/README.md
ADDED
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Obzerve Python SDK
|
|
2
|
+
|
|
3
|
+
Observability, replay, and regression testing for AI agents.
|
|
4
|
+
|
|
5
|
+
`obzerve` traces what your agent does: LLM calls, tool calls, retrieval, and handoffs. Traces go to a self-hosted [Obzerve](https://github.com/aryanfredericks/Obzerve) server, where you can see the timeline, latency, errors, token usage, and estimated cost of every request. When something goes wrong, the SDK can replay the exact execution from its recordings and turn it into a regression test that gates your next release.
|
|
6
|
+
|
|
7
|
+
The SDK is built on OpenTelemetry and sends standard OTLP.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pip install obzerve # or: uv add obzerve
|
|
11
|
+
pip install "obzerve[openai]" # plus the client libraries you use: openai, anthropic,
|
|
12
|
+
# huggingface, transformers, or all
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
You need a running Obzerve server and a project API key. See the [getting-started guide](https://github.com/aryanfredericks/Obzerve/blob/main/docs/getting-started.md); `make stack-demo` starts one locally in containers.
|
|
16
|
+
|
|
17
|
+
## Trace an agent in three lines
|
|
18
|
+
|
|
19
|
+
```python
|
|
20
|
+
from obzerve import Observer
|
|
21
|
+
|
|
22
|
+
observer = Observer(endpoint="http://localhost:8000", api_key="obz_...", service_name="support-bot")
|
|
23
|
+
observer.instrument() # trace OpenAI, Anthropic and Hugging Face calls automatically
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
def handle(ticket):
|
|
27
|
+
with observer.trace("support_bot", input={"ticket": ticket}) as trace:
|
|
28
|
+
answer = ... # your agent: every LLM call inside becomes a span of this trace
|
|
29
|
+
trace.set_output(answer)
|
|
30
|
+
return answer
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Automatic instrumentation
|
|
34
|
+
|
|
35
|
+
`observer.instrument()` patches the supported client libraries that are installed. Every model call becomes an LLM span inside the active trace, recording:
|
|
36
|
+
- model and provider
|
|
37
|
+
- sampling settings
|
|
38
|
+
- input, output, and cached token counts
|
|
39
|
+
- finish reason
|
|
40
|
+
- inputs and outputs, subject to redaction and `capture_payloads`
|
|
41
|
+
|
|
42
|
+
| Library | What is traced |
|
|
43
|
+
| --- | --- |
|
|
44
|
+
| `openai` | Chat Completions, Responses, and Embeddings: sync, async, and streams. OpenAI-compatible servers (vLLM, Ollama, TGI, LM Studio, ...) reached through the OpenAI client are recorded as `openai_compatible`, with their server address |
|
|
45
|
+
| `anthropic` | `messages.create` (including `stream=True`) and the `messages.stream()` helper, sync and async. Cache reads and writes are included in input tokens, and cache reads are priced as cached tokens |
|
|
46
|
+
| `huggingface_hub` | `InferenceClient.chat_completion` (also reached as `client.chat.completions.create`) and `text_generation`, sync, async, and streams. Covers the serverless Inference API, Inference Endpoints, and self-hosted TGI |
|
|
47
|
+
| `transformers` | Any local model's `generate()` (model, device, prompt and generated token counts) and text-generation pipelines |
|
|
48
|
+
|
|
49
|
+
```python
|
|
50
|
+
observer.instrument(openai=True, anthropic=False) # True: require it; False: skip it;
|
|
51
|
+
# None (default): instrument it if installed
|
|
52
|
+
handle = observer.instrument()
|
|
53
|
+
handle.uninstrument() # restore the original libraries
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
`transformers` loads PyTorch on import, so by default it is instrumented only if your code has already imported it. Pass `transformers=True` to instrument it regardless.
|
|
57
|
+
|
|
58
|
+
Instrumentation never breaks your call: if a library changes shape, you lose telemetry, not the request. A streamed response stays open as one span until you finish reading it, close it, or leave its `with` block. Close streams you stop reading early.
|
|
59
|
+
|
|
60
|
+
## Spans you define yourself
|
|
61
|
+
|
|
62
|
+
```python
|
|
63
|
+
from obzerve import SpanKind
|
|
64
|
+
|
|
65
|
+
with observer.span("search_orders", kind=SpanKind.TOOL, input={"customer": cid}) as span:
|
|
66
|
+
orders = orders_api.search(cid)
|
|
67
|
+
span.set_output(orders)
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
@observer.observe(kind=SpanKind.RETRIEVAL) # decorator form, sync or async
|
|
71
|
+
def retrieve(query: str) -> list[str]: ...
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Exceptions mark the span as failed, with the error type and message. `span.record_retry(attempt, exc)` records retries. `span.set_llm(model=..., input_tokens=..., output_tokens=...)` records model usage for calls the instrumentation doesn't cover.
|
|
75
|
+
|
|
76
|
+
## Replay and regression testing
|
|
77
|
+
|
|
78
|
+
Calls through the instrumented libraries are recorded exactly: the whole response, rebuilt as the library's own response type during a replay. For your own tools, use `@observer.replayable`:
|
|
79
|
+
|
|
80
|
+
```python
|
|
81
|
+
@observer.replayable(kind=SpanKind.TOOL)
|
|
82
|
+
def lookup_order(order_id: str) -> dict: ...
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
@observer.replayable(kind=SpanKind.TOOL, side_effect=True) # never re-run by a replay
|
|
86
|
+
def refund(order_id: str) -> None: ...
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Then reproduce a production request, without calling any model or tool:
|
|
90
|
+
|
|
91
|
+
```python
|
|
92
|
+
from obzerve.client import ObzerveClient
|
|
93
|
+
from obzerve.replay import RECORDED, LLM_LIVE
|
|
94
|
+
|
|
95
|
+
bundle = ObzerveClient("http://localhost:8000", api_key).replay_bundle(trace_id)
|
|
96
|
+
with observer.replay(bundle, RECORDED): # or LLM_LIVE: tools recorded, model live
|
|
97
|
+
handle(**bundle.root_input)
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Turn the trace into a regression case, run your eval dataset against a change, and gate the release in CI:
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
obzerve case add <trace_id> --dataset regressions --name "refund flow" --mode recorded --no-error
|
|
104
|
+
obzerve eval gate <baseline_run> <candidate_run> --max-regressions 0 # exits 1 on failure
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
Run datasets with `obzerve.evals.run_eval`. The [main README](https://github.com/aryanfredericks/Obzerve#replay-and-regression-testing) covers the full workflow.
|
|
108
|
+
|
|
109
|
+
## Privacy and reliability defaults
|
|
110
|
+
|
|
111
|
+
- **Redaction:** captured inputs and outputs are redacted (keys such as `api_key`, `password`, `authorization`, plus bearer and `sk-…` tokens) and truncated. `Observer(capture_payloads=False)` turns capture off entirely.
|
|
112
|
+
- **Never in your way:** export runs in a background thread through a bounded buffer with short timeouts. A slow or unavailable server never blocks or fails your agent; telemetry is dropped instead. `observer.stats()` reports exactly how many spans were exported, failed, or dropped.
|
|
113
|
+
- **No global takeover:** the SDK uses its own OpenTelemetry tracer provider and never replaces yours.
|
|
114
|
+
- **Anthropic's own spans:** the Anthropic SDK can emit OpenTelemetry spans to your *global* provider. If you also send those to Obzerve, disable one of the two (`Anthropic(open_telemetry=False)`), or each call appears twice.
|
|
115
|
+
|
|
116
|
+
## Current limits
|
|
117
|
+
|
|
118
|
+
- Streamed responses are traced, but not yet recorded for replay. A replay that reaches one runs it live (`LLM_LIVE`) or fails with a clear error (`RECORDED`).
|
|
119
|
+
- Replay matches calls by operation name and order. Concurrent calls of the same operation can't yet be told apart reliably.
|
|
120
|
+
- Tested with Python 3.10–3.13, `openai` 3.x, `anthropic` 2.x, `huggingface_hub` 2.x, and `transformers` 5.x. Other versions are instrumented best-effort: an incompatible library logs a warning and is left alone.
|
|
121
|
+
|
|
122
|
+
Licensed under [Apache-2.0](https://github.com/aryanfredericks/Obzerve/blob/main/LICENSE).
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "obzerve"
|
|
3
|
+
dynamic = ["version"]
|
|
4
|
+
description = "Observability, replay, and regression testing for AI agents: OpenTelemetry tracing with automatic instrumentation for OpenAI, Anthropic, and Hugging Face models."
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
license = "Apache-2.0"
|
|
7
|
+
license-files = ["LICENSE"]
|
|
8
|
+
authors = [{ name = "Aryan Fredericks" }]
|
|
9
|
+
requires-python = ">=3.10"
|
|
10
|
+
keywords = [
|
|
11
|
+
"observability", "tracing", "opentelemetry", "llm", "agents", "ai-agents",
|
|
12
|
+
"openai", "anthropic", "huggingface", "transformers", "replay", "evals",
|
|
13
|
+
]
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Development Status :: 3 - Alpha",
|
|
16
|
+
"Intended Audience :: Developers",
|
|
17
|
+
"Operating System :: OS Independent",
|
|
18
|
+
"Programming Language :: Python :: 3",
|
|
19
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
20
|
+
"Programming Language :: Python :: 3.10",
|
|
21
|
+
"Programming Language :: Python :: 3.11",
|
|
22
|
+
"Programming Language :: Python :: 3.12",
|
|
23
|
+
"Programming Language :: Python :: 3.13",
|
|
24
|
+
"Topic :: Software Development :: Testing",
|
|
25
|
+
"Topic :: System :: Monitoring",
|
|
26
|
+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
|
27
|
+
"Typing :: Typed",
|
|
28
|
+
]
|
|
29
|
+
dependencies = [
|
|
30
|
+
"opentelemetry-api>=1.27",
|
|
31
|
+
"opentelemetry-sdk>=1.27",
|
|
32
|
+
"opentelemetry-exporter-otlp-proto-http>=1.27",
|
|
33
|
+
"requests>=2.28",
|
|
34
|
+
]
|
|
35
|
+
|
|
36
|
+
[project.optional-dependencies]
|
|
37
|
+
# Convenience pins for the client libraries Obzerve instruments. The core package
|
|
38
|
+
# never imports them; instrumentation is best-effort for other versions.
|
|
39
|
+
openai = ["openai>=3"]
|
|
40
|
+
anthropic = ["anthropic>=2"]
|
|
41
|
+
huggingface = ["huggingface_hub>=2"]
|
|
42
|
+
transformers = ["transformers>=5", "torch"]
|
|
43
|
+
all = ["obzerve[openai,anthropic,huggingface,transformers]"]
|
|
44
|
+
|
|
45
|
+
[project.urls]
|
|
46
|
+
Homepage = "https://github.com/aryanfredericks/Obzerve"
|
|
47
|
+
Documentation = "https://github.com/aryanfredericks/Obzerve/blob/main/sdk/python/README.md"
|
|
48
|
+
Source = "https://github.com/aryanfredericks/Obzerve/tree/main/sdk/python"
|
|
49
|
+
Issues = "https://github.com/aryanfredericks/Obzerve/issues"
|
|
50
|
+
Changelog = "https://github.com/aryanfredericks/Obzerve/blob/main/sdk/python/CHANGELOG.md"
|
|
51
|
+
|
|
52
|
+
[project.scripts]
|
|
53
|
+
obzerve = "obzerve.cli:main"
|
|
54
|
+
|
|
55
|
+
[build-system]
|
|
56
|
+
requires = ["hatchling>=1.27"]
|
|
57
|
+
build-backend = "hatchling.build"
|
|
58
|
+
|
|
59
|
+
[tool.hatch.version]
|
|
60
|
+
path = "src/obzerve/_version.py"
|
|
61
|
+
|
|
62
|
+
[tool.hatch.build.targets.wheel]
|
|
63
|
+
packages = ["src/obzerve"]
|
|
64
|
+
|
|
65
|
+
[tool.hatch.build.targets.sdist]
|
|
66
|
+
include = ["src/obzerve", "tests", "README.md", "CHANGELOG.md", "LICENSE"]
|
|
67
|
+
|
|
68
|
+
[tool.ruff]
|
|
69
|
+
# The SDK supports older Pythons than the rest of the workspace: lint it as 3.10 code
|
|
70
|
+
# so pyupgrade never suggests 3.11+ features (e.g. datetime.UTC).
|
|
71
|
+
extend = "../../pyproject.toml"
|
|
72
|
+
target-version = "py310"
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"""Obzerve Python SDK: trace AI-agent workflows with OpenTelemetry."""
|
|
2
|
+
|
|
3
|
+
from obzerve.attributes import SpanKind
|
|
4
|
+
from obzerve.delivery import DeliveryStats
|
|
5
|
+
from obzerve.observer import Observer, ObzerveSpan, __version__
|
|
6
|
+
|
|
7
|
+
__all__ = ["DeliveryStats", "Observer", "ObzerveSpan", "SpanKind", "__version__"]
|