octic-telemetry 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.
Files changed (45) hide show
  1. octic_telemetry-0.1.0/.gitignore +21 -0
  2. octic_telemetry-0.1.0/CHANGELOG.md +22 -0
  3. octic_telemetry-0.1.0/LICENSE +202 -0
  4. octic_telemetry-0.1.0/PKG-INFO +156 -0
  5. octic_telemetry-0.1.0/README.md +130 -0
  6. octic_telemetry-0.1.0/pyproject.toml +96 -0
  7. octic_telemetry-0.1.0/src/octic_telemetry/__init__.py +109 -0
  8. octic_telemetry-0.1.0/src/octic_telemetry/agent.py +59 -0
  9. octic_telemetry-0.1.0/src/octic_telemetry/annotations.py +389 -0
  10. octic_telemetry-0.1.0/src/octic_telemetry/attributes.py +184 -0
  11. octic_telemetry-0.1.0/src/octic_telemetry/attributes_gen.py +621 -0
  12. octic_telemetry-0.1.0/src/octic_telemetry/batching.py +35 -0
  13. octic_telemetry-0.1.0/src/octic_telemetry/content.py +346 -0
  14. octic_telemetry-0.1.0/src/octic_telemetry/context_scope.py +123 -0
  15. octic_telemetry-0.1.0/src/octic_telemetry/counters.py +85 -0
  16. octic_telemetry-0.1.0/src/octic_telemetry/identity.py +112 -0
  17. octic_telemetry-0.1.0/src/octic_telemetry/otlp_json.py +240 -0
  18. octic_telemetry-0.1.0/src/octic_telemetry/pipeline.py +527 -0
  19. octic_telemetry-0.1.0/src/octic_telemetry/processor.py +125 -0
  20. octic_telemetry-0.1.0/src/octic_telemetry/prompt.py +42 -0
  21. octic_telemetry-0.1.0/src/octic_telemetry/py.typed +0 -0
  22. octic_telemetry-0.1.0/src/octic_telemetry/redacting_exporter.py +282 -0
  23. octic_telemetry-0.1.0/src/octic_telemetry/run.py +63 -0
  24. octic_telemetry-0.1.0/src/octic_telemetry/safe_exporter.py +63 -0
  25. octic_telemetry-0.1.0/src/octic_telemetry/safe_processor.py +65 -0
  26. octic_telemetry-0.1.0/src/octic_telemetry/sanitize.py +147 -0
  27. octic_telemetry-0.1.0/src/octic_telemetry/silence_watch.py +118 -0
  28. octic_telemetry-0.1.0/src/octic_telemetry/spool.py +600 -0
  29. octic_telemetry-0.1.0/src/octic_telemetry/spool_exporter.py +67 -0
  30. octic_telemetry-0.1.0/src/octic_telemetry/version.py +33 -0
  31. octic_telemetry-0.1.0/tests/conftest.py +137 -0
  32. octic_telemetry-0.1.0/tests/test_annotations.py +201 -0
  33. octic_telemetry-0.1.0/tests/test_content_policy.py +274 -0
  34. octic_telemetry-0.1.0/tests/test_context_scope.py +100 -0
  35. octic_telemetry-0.1.0/tests/test_contract.py +47 -0
  36. octic_telemetry-0.1.0/tests/test_init.py +210 -0
  37. octic_telemetry-0.1.0/tests/test_non_interference.py +120 -0
  38. octic_telemetry-0.1.0/tests/test_otlp_json.py +236 -0
  39. octic_telemetry-0.1.0/tests/test_redacting_exporter.py +206 -0
  40. octic_telemetry-0.1.0/tests/test_safe.py +67 -0
  41. octic_telemetry-0.1.0/tests/test_sanitize.py +101 -0
  42. octic_telemetry-0.1.0/tests/test_scopes.py +140 -0
  43. octic_telemetry-0.1.0/tests/test_silence_watch.py +82 -0
  44. octic_telemetry-0.1.0/tests/test_spool.py +323 -0
  45. octic_telemetry-0.1.0/tests/test_spool_exporter.py +108 -0
@@ -0,0 +1,21 @@
1
+ node_modules/
2
+ dist/
3
+ *.tgz
4
+
5
+ # Test and lint output
6
+ junit.xml
7
+ coverage/
8
+ .eslintcache
9
+
10
+ # Editors / OS
11
+ .DS_Store
12
+ *.swp
13
+
14
+ __pycache__
15
+
16
+ # Python
17
+ .venv/
18
+ .pytest_cache/
19
+ .mypy_cache/
20
+ .ruff_cache/
21
+ *.egg-info/
@@ -0,0 +1,22 @@
1
+ # Changelog
2
+
3
+ ## 0.1.0 (2026-09-22)
4
+
5
+
6
+ ### Features
7
+
8
+ * **contract:** Added Python attribute generator ([#13](https://github.com/OcticHQ/telemetry/issues/13)) ([4424ddb](https://github.com/OcticHQ/telemetry/commit/4424ddbc75ea5d69af7215439e34d89793d4d1f0))
9
+ * **contract:** close octic.sdk.name to the SDKs that exist ([4fad2e0](https://github.com/OcticHQ/telemetry/commit/4fad2e00664760de760976f3351ee3bab4241caa))
10
+ * **python:** default content capture to none, and stop requiring an endpoint ([a9cc52a](https://github.com/OcticHQ/telemetry/commit/a9cc52a7ed1ba6224125ba670e51e7922a3908c8))
11
+ * **python:** the SDK core — scopes, annotations, content policy, encoder ([0302576](https://github.com/OcticHQ/telemetry/commit/030257650a06f6a54306691f9280ae924b6f4959))
12
+ * **python:** the spool, init(), and the guards around them ([b073ee5](https://github.com/OcticHQ/telemetry/commit/b073ee50176e73c08184025ac8fe3e3a7a6f7d54))
13
+
14
+
15
+ ### Bug Fixes
16
+
17
+ * **python:** keep ruff's formatter off the generated contract ([0027d68](https://github.com/OcticHQ/telemetry/commit/0027d689d0077bbdca9efd4bf6536927b2220f56))
18
+
19
+
20
+ ### Documentation
21
+
22
+ * teach the Python SDK, and stop docs/ being written in one language ([da4c35a](https://github.com/OcticHQ/telemetry/commit/da4c35a3d42de2a2a9584f8f2467c509f4befb2d))
@@ -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 2026 Octic.ai
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.
@@ -0,0 +1,156 @@
1
+ Metadata-Version: 2.5
2
+ Name: octic-telemetry
3
+ Version: 0.1.0
4
+ Summary: Agent telemetry for Octic — OpenTelemetry spans, stamped with the Octic attribute contract
5
+ Project-URL: Homepage, https://github.com/OcticHQ/telemetry
6
+ Project-URL: Repository, https://github.com/OcticHQ/telemetry
7
+ Project-URL: Changelog, https://github.com/OcticHQ/telemetry/blob/main/python/CHANGELOG.md
8
+ Project-URL: Issues, https://github.com/OcticHQ/telemetry/issues
9
+ Author: Octic
10
+ License-Expression: Apache-2.0
11
+ License-File: LICENSE
12
+ Keywords: agents,genai,llm,observability,opentelemetry,telemetry
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Topic :: System :: Monitoring
21
+ Classifier: Typing :: Typed
22
+ Requires-Python: >=3.10
23
+ Requires-Dist: opentelemetry-api<2.0.0,>=1.30.0
24
+ Requires-Dist: opentelemetry-sdk<2.0.0,>=1.30.0
25
+ Description-Content-Type: text/markdown
26
+
27
+ # `octic-telemetry`
28
+
29
+ Agent telemetry for [Octic](https://octic.ai) — OpenTelemetry spans, stamped
30
+ with the Octic attribute contract.
31
+
32
+ > **Spool-only.** This release writes telemetry to a local directory and does
33
+ > not talk to any Octic service: no credential, no network call. A separate
34
+ > reader process delivers what it writes.
35
+
36
+ ## What it is, and what it is not
37
+
38
+ **It ships no instrumentation.** Bring whatever you already run — the OpenAI
39
+ instrumentation, OpenLLMetry, or stock OpenTelemetry — and this package adds the
40
+ layer above it: the layer that knows *these five model calls were one agent
41
+ doing one job, for that customer, from that prompt template.*
42
+
43
+ That layer is the part no interception can produce. Intercepting the network
44
+ call to a model tells you the model, the tokens and the latency. It cannot know
45
+ where a run began, which end user it was for, or which governed asset the agent
46
+ is. None of it can be added to the data afterwards.
47
+
48
+ The mechanism is one OpenTelemetry `SpanProcessor`. It reads values off the
49
+ OpenTelemetry context and stamps them onto every span created through the
50
+ provider — **including spans this package did not create**. That is why your
51
+ instrumentation, whichever you chose, comes out carrying your identity.
52
+
53
+ ## Install
54
+
55
+ ```bash
56
+ pip install octic-telemetry
57
+ ```
58
+
59
+ `opentelemetry-api` and `opentelemetry-sdk` come with it, and exactly one copy
60
+ of the API must exist in your environment — two copies mean two context
61
+ managers, and the stamping silently stops working.
62
+
63
+ ## Use
64
+
65
+ Once per process, before the libraries you want observed are imported:
66
+
67
+ ```python
68
+ from octic_telemetry import Agent, init
69
+
70
+ telemetry = init(
71
+ service_name="checkout-agent",
72
+ service_version="1.4.2",
73
+ agent=Agent(agent_id="refunds", name="Refunds Agent"),
74
+ environment="production",
75
+ )
76
+ ```
77
+
78
+ `init()` never raises.
79
+
80
+ Then annotate what only your application knows:
81
+
82
+ ```python
83
+ from octic_telemetry import with_identity, with_prompt, with_tool, with_workflow
84
+
85
+ with with_identity(conversation_id=conversation_id, user_id=user_id):
86
+ with with_workflow(name="refund-request", input=message) as run:
87
+ with with_prompt(template="refund-triage", version="3"):
88
+ ... # your model calls, instrumented by whatever you already run
89
+
90
+ with with_tool(name="lookup_order"):
91
+ ...
92
+
93
+ run.set_output(result)
94
+ ```
95
+
96
+ Call `telemetry.shutdown()` from your own shutdown path — the package registers
97
+ no `atexit` hook.
98
+
99
+ | Call | What it does |
100
+ |---|---|
101
+ | `init` | wiring, once, before anything else |
102
+ | `with_identity` | conversation and end user; sets context, emits no span |
103
+ | `with_agent` | only if one process runs several agents |
104
+ | `with_prompt` | which template produced this call |
105
+ | `with_workflow` | the run root, and the run id |
106
+ | `with_retrieval` | a lookup that fetched context |
107
+ | `with_tool` | a tool execution |
108
+ | `with_content` | override the content policy for one run |
109
+
110
+ Each annotation also works as `async with` and as a decorator over a sync or an
111
+ async function.
112
+
113
+ ## Content policy
114
+
115
+ Prompts, tool arguments and model output are your data rather than telemetry
116
+ about it, and none of them are needed to answer a governance question — the
117
+ agent, the run, the prompt *name*, the token counts and the asset references all
118
+ survive with content switched off.
119
+
120
+ | level | what leaves your process |
121
+ |---|---|
122
+ | `full` | the content, after your `redact` hook and `max_length` |
123
+ | `metadata` | a length and a hash, not the content |
124
+ | `none` | nothing. Everything else is untouched, and the product works here |
125
+
126
+ The default is **`none`** — unlike the Node SDK, because this SDK writes to a
127
+ directory on the host's own disk rather than sending anywhere, and content there
128
+ sits at rest. Set it per process with
129
+ `init(content=ContentOptions(capture="full"))`, or per run with `with_content`.
130
+
131
+ ## Requirements
132
+
133
+ | | |
134
+ |---|---|
135
+ | Python | 3.10+ |
136
+ | Runtime dependencies | `opentelemetry-api`, `opentelemetry-sdk` |
137
+ | Signals | traces |
138
+ | Typing | ships `py.typed` |
139
+
140
+ Spans are exported by a `BatchSpanProcessor` on its own worker thread;
141
+ `SimpleSpanProcessor` is refused, because it would write to disk on the thread
142
+ that ended the span.
143
+
144
+ ## Links
145
+
146
+ - [Repository](https://github.com/OcticHQ/telemetry)
147
+ - [Usage guide](https://github.com/OcticHQ/telemetry/blob/main/docs/python-guide.md)
148
+ — every feature, and how they compose
149
+ - [Concepts](https://github.com/OcticHQ/telemetry/blob/main/docs/concepts.md)
150
+ - [Attribute contract](https://github.com/OcticHQ/telemetry/blob/main/contract/ATTRIBUTES.md)
151
+ — every key this SDK writes, frozen
152
+ - [Content policy](https://github.com/OcticHQ/telemetry/blob/main/docs/content-policy.md)
153
+
154
+ ## Licence
155
+
156
+ Apache-2.0
@@ -0,0 +1,130 @@
1
+ # `octic-telemetry`
2
+
3
+ Agent telemetry for [Octic](https://octic.ai) — OpenTelemetry spans, stamped
4
+ with the Octic attribute contract.
5
+
6
+ > **Spool-only.** This release writes telemetry to a local directory and does
7
+ > not talk to any Octic service: no credential, no network call. A separate
8
+ > reader process delivers what it writes.
9
+
10
+ ## What it is, and what it is not
11
+
12
+ **It ships no instrumentation.** Bring whatever you already run — the OpenAI
13
+ instrumentation, OpenLLMetry, or stock OpenTelemetry — and this package adds the
14
+ layer above it: the layer that knows *these five model calls were one agent
15
+ doing one job, for that customer, from that prompt template.*
16
+
17
+ That layer is the part no interception can produce. Intercepting the network
18
+ call to a model tells you the model, the tokens and the latency. It cannot know
19
+ where a run began, which end user it was for, or which governed asset the agent
20
+ is. None of it can be added to the data afterwards.
21
+
22
+ The mechanism is one OpenTelemetry `SpanProcessor`. It reads values off the
23
+ OpenTelemetry context and stamps them onto every span created through the
24
+ provider — **including spans this package did not create**. That is why your
25
+ instrumentation, whichever you chose, comes out carrying your identity.
26
+
27
+ ## Install
28
+
29
+ ```bash
30
+ pip install octic-telemetry
31
+ ```
32
+
33
+ `opentelemetry-api` and `opentelemetry-sdk` come with it, and exactly one copy
34
+ of the API must exist in your environment — two copies mean two context
35
+ managers, and the stamping silently stops working.
36
+
37
+ ## Use
38
+
39
+ Once per process, before the libraries you want observed are imported:
40
+
41
+ ```python
42
+ from octic_telemetry import Agent, init
43
+
44
+ telemetry = init(
45
+ service_name="checkout-agent",
46
+ service_version="1.4.2",
47
+ agent=Agent(agent_id="refunds", name="Refunds Agent"),
48
+ environment="production",
49
+ )
50
+ ```
51
+
52
+ `init()` never raises.
53
+
54
+ Then annotate what only your application knows:
55
+
56
+ ```python
57
+ from octic_telemetry import with_identity, with_prompt, with_tool, with_workflow
58
+
59
+ with with_identity(conversation_id=conversation_id, user_id=user_id):
60
+ with with_workflow(name="refund-request", input=message) as run:
61
+ with with_prompt(template="refund-triage", version="3"):
62
+ ... # your model calls, instrumented by whatever you already run
63
+
64
+ with with_tool(name="lookup_order"):
65
+ ...
66
+
67
+ run.set_output(result)
68
+ ```
69
+
70
+ Call `telemetry.shutdown()` from your own shutdown path — the package registers
71
+ no `atexit` hook.
72
+
73
+ | Call | What it does |
74
+ |---|---|
75
+ | `init` | wiring, once, before anything else |
76
+ | `with_identity` | conversation and end user; sets context, emits no span |
77
+ | `with_agent` | only if one process runs several agents |
78
+ | `with_prompt` | which template produced this call |
79
+ | `with_workflow` | the run root, and the run id |
80
+ | `with_retrieval` | a lookup that fetched context |
81
+ | `with_tool` | a tool execution |
82
+ | `with_content` | override the content policy for one run |
83
+
84
+ Each annotation also works as `async with` and as a decorator over a sync or an
85
+ async function.
86
+
87
+ ## Content policy
88
+
89
+ Prompts, tool arguments and model output are your data rather than telemetry
90
+ about it, and none of them are needed to answer a governance question — the
91
+ agent, the run, the prompt *name*, the token counts and the asset references all
92
+ survive with content switched off.
93
+
94
+ | level | what leaves your process |
95
+ |---|---|
96
+ | `full` | the content, after your `redact` hook and `max_length` |
97
+ | `metadata` | a length and a hash, not the content |
98
+ | `none` | nothing. Everything else is untouched, and the product works here |
99
+
100
+ The default is **`none`** — unlike the Node SDK, because this SDK writes to a
101
+ directory on the host's own disk rather than sending anywhere, and content there
102
+ sits at rest. Set it per process with
103
+ `init(content=ContentOptions(capture="full"))`, or per run with `with_content`.
104
+
105
+ ## Requirements
106
+
107
+ | | |
108
+ |---|---|
109
+ | Python | 3.10+ |
110
+ | Runtime dependencies | `opentelemetry-api`, `opentelemetry-sdk` |
111
+ | Signals | traces |
112
+ | Typing | ships `py.typed` |
113
+
114
+ Spans are exported by a `BatchSpanProcessor` on its own worker thread;
115
+ `SimpleSpanProcessor` is refused, because it would write to disk on the thread
116
+ that ended the span.
117
+
118
+ ## Links
119
+
120
+ - [Repository](https://github.com/OcticHQ/telemetry)
121
+ - [Usage guide](https://github.com/OcticHQ/telemetry/blob/main/docs/python-guide.md)
122
+ — every feature, and how they compose
123
+ - [Concepts](https://github.com/OcticHQ/telemetry/blob/main/docs/concepts.md)
124
+ - [Attribute contract](https://github.com/OcticHQ/telemetry/blob/main/contract/ATTRIBUTES.md)
125
+ — every key this SDK writes, frozen
126
+ - [Content policy](https://github.com/OcticHQ/telemetry/blob/main/docs/content-policy.md)
127
+
128
+ ## Licence
129
+
130
+ Apache-2.0
@@ -0,0 +1,96 @@
1
+ [build-system]
2
+ requires = ["hatchling"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "octic-telemetry"
7
+ # Owned by release-please once `python` is registered as a component. Until
8
+ # then this is deliberately 0.0.0: an unreleased build should not claim a
9
+ # version number that identifies a release it is not.
10
+ version = "0.1.0"
11
+ description = "Agent telemetry for Octic — OpenTelemetry spans, stamped with the Octic attribute contract"
12
+ readme = "README.md"
13
+ requires-python = ">=3.10"
14
+ license = "Apache-2.0"
15
+ license-files = ["LICENSE"]
16
+ authors = [{ name = "Octic" }]
17
+ keywords = ["opentelemetry", "telemetry", "observability", "llm", "agents", "genai"]
18
+ classifiers = [
19
+ "Development Status :: 3 - Alpha",
20
+ "Intended Audience :: Developers",
21
+ "Programming Language :: Python :: 3",
22
+ "Programming Language :: Python :: 3.10",
23
+ "Programming Language :: Python :: 3.11",
24
+ "Programming Language :: Python :: 3.12",
25
+ "Programming Language :: Python :: 3.13",
26
+ "Topic :: System :: Monitoring",
27
+ "Typing :: Typed",
28
+ ]
29
+
30
+ # The whole runtime dependency set. Anything else a consumer needs — an
31
+ # instrumentation package, an exporter, a web framework — is theirs to choose;
32
+ # see AGENTS.md rule 8 on why this package ships no instrumentation.
33
+ dependencies = [
34
+ "opentelemetry-api>=1.30.0,<2.0.0",
35
+ "opentelemetry-sdk>=1.30.0,<2.0.0",
36
+ ]
37
+
38
+ [project.urls]
39
+ Homepage = "https://github.com/OcticHQ/telemetry"
40
+ Repository = "https://github.com/OcticHQ/telemetry"
41
+ Changelog = "https://github.com/OcticHQ/telemetry/blob/main/python/CHANGELOG.md"
42
+ Issues = "https://github.com/OcticHQ/telemetry/issues"
43
+
44
+ [dependency-groups]
45
+ dev = [
46
+ "build>=1.2",
47
+ "mypy>=1.13",
48
+ "pytest>=8.3",
49
+ "pytest-asyncio>=0.24",
50
+ "ruff>=0.8",
51
+ "twine>=5.1",
52
+ ]
53
+
54
+ [tool.hatch.build.targets.wheel]
55
+ packages = ["src/octic_telemetry"]
56
+
57
+ [tool.ruff]
58
+ line-length = 100
59
+ target-version = "py310"
60
+ src = ["src", "tests"]
61
+
62
+ [tool.ruff.format]
63
+ # The generated contract is `contract/generate.ts`'s output, byte for byte. A
64
+ # formatter that rewrites it makes the artifact stale against its generator,
65
+ # which is a CI failure and, worse, a diff nobody meant to author. Generated
66
+ # artifacts are committed and only the generator writes them (AGENTS.md rule 3).
67
+ exclude = ["src/octic_telemetry/attributes_gen.py"]
68
+
69
+ [tool.ruff.lint]
70
+ select = ["E", "F", "I", "N", "UP", "B", "A", "C4", "RUF", "BLE", "SIM", "TID"]
71
+ # BLE001 is switched off per-line where it belongs, with a reason. The rule is
72
+ # on because a bare `except Exception` is nearly always wrong; this package is
73
+ # the narrow case where it is the requirement, so each one is argued at the site.
74
+
75
+ [tool.ruff.lint.per-file-ignores]
76
+ # The generated contract is the contract's to format, not ruff's.
77
+ "src/octic_telemetry/attributes_gen.py" = ["E501", "RUF001", "RUF002", "RUF003"]
78
+ # Nested `with` is what several of these tests are about — an inner scope
79
+ # composing with an outer one. Flattening them would hide the subject.
80
+ "tests/**" = ["SIM117"]
81
+
82
+ [tool.mypy]
83
+ python_version = "3.10"
84
+ strict = true
85
+ warn_unreachable = true
86
+ files = ["src", "tests"]
87
+
88
+ [[tool.mypy.overrides]]
89
+ # The generated file is emitted by contract/generate.ts and checked by the
90
+ # drift check, not by us.
91
+ module = "octic_telemetry.attributes_gen"
92
+ ignore_errors = true
93
+
94
+ [tool.pytest.ini_options]
95
+ testpaths = ["tests"]
96
+ asyncio_mode = "auto"