llm-tracekit 1.0.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 (56) hide show
  1. llm_tracekit-1.0.0/.github/workflows/lint.yml +31 -0
  2. llm_tracekit-1.0.0/.github/workflows/publish.yml +51 -0
  3. llm_tracekit-1.0.0/.github/workflows/test.yml +30 -0
  4. llm_tracekit-1.0.0/.gitignore +60 -0
  5. llm_tracekit-1.0.0/CODEOWNERS +1 -0
  6. llm_tracekit-1.0.0/LICENSE.md +201 -0
  7. llm_tracekit-1.0.0/PKG-INFO +95 -0
  8. llm_tracekit-1.0.0/README.md +80 -0
  9. llm_tracekit-1.0.0/pyproject.toml +40 -0
  10. llm_tracekit-1.0.0/src/llm_tracekit/__init__.py +183 -0
  11. llm_tracekit-1.0.0/src/llm_tracekit/extended_gen_ai_attributes.py +138 -0
  12. llm_tracekit-1.0.0/src/llm_tracekit/instruments.py +52 -0
  13. llm_tracekit-1.0.0/src/llm_tracekit/package.py +16 -0
  14. llm_tracekit-1.0.0/src/llm_tracekit/patch.py +512 -0
  15. llm_tracekit-1.0.0/src/llm_tracekit/py.typed +0 -0
  16. llm_tracekit-1.0.0/src/llm_tracekit/utils.py +274 -0
  17. llm_tracekit-1.0.0/src/llm_tracekit/version.py +15 -0
  18. llm_tracekit-1.0.0/tests/__init__.py +0 -0
  19. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_404.yaml +89 -0
  20. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_extra_params.yaml +145 -0
  21. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_metrics.yaml +133 -0
  22. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_multiple_choices.yaml +143 -0
  23. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_multiple_choices_streaming.yaml +382 -0
  24. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_multiple_tools_streaming_no_content.yaml +164 -0
  25. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_multiple_tools_streaming_with_content.yaml +164 -0
  26. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_no_content.yaml +132 -0
  27. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_streaming.yaml +117 -0
  28. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_streaming_not_complete.yaml +112 -0
  29. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_streaming_unsampled.yaml +117 -0
  30. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_tool_calls_no_content.yaml +342 -0
  31. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_tool_calls_with_content.yaml +342 -0
  32. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_with_content.yaml +132 -0
  33. llm_tracekit-1.0.0/tests/cassettes/test_async_chat_completion_with_content_array.yaml +143 -0
  34. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_404.yaml +91 -0
  35. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_extra_params.yaml +145 -0
  36. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_metrics.yaml +135 -0
  37. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_multiple_choices.yaml +145 -0
  38. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_multiple_choices_streaming.yaml +326 -0
  39. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_multiple_tools_streaming_no_content.yaml +166 -0
  40. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_multiple_tools_streaming_with_content.yaml +166 -0
  41. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_no_content.yaml +134 -0
  42. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_streaming.yaml +119 -0
  43. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_streaming_not_complete.yaml +114 -0
  44. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_tool_calls_no_content.yaml +346 -0
  45. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_tool_calls_with_content.yaml +346 -0
  46. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_with_content.yaml +134 -0
  47. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_with_content_array.yaml +143 -0
  48. llm_tracekit-1.0.0/tests/cassettes/test_chat_completion_with_content_span_unsampled.yaml +134 -0
  49. llm_tracekit-1.0.0/tests/conftest.py +204 -0
  50. llm_tracekit-1.0.0/tests/requirements.latest.txt +52 -0
  51. llm_tracekit-1.0.0/tests/requirements.oldest.txt +33 -0
  52. llm_tracekit-1.0.0/tests/test_async_chat_completions.py +710 -0
  53. llm_tracekit-1.0.0/tests/test_chat_completions.py +723 -0
  54. llm_tracekit-1.0.0/tests/test_chat_metrics.py +209 -0
  55. llm_tracekit-1.0.0/tests/utils.py +292 -0
  56. llm_tracekit-1.0.0/uv.lock +2029 -0
@@ -0,0 +1,31 @@
1
+ name: Lint
2
+ run-name: Lint
3
+
4
+ on:
5
+ pull_request:
6
+
7
+ jobs:
8
+ lint:
9
+ runs-on: ubuntu-latest
10
+ name: Lint - Python
11
+ steps:
12
+ - name: Checkout
13
+ uses: actions/checkout@v4
14
+
15
+ - name: Setup python
16
+ uses: actions/setup-python@v5.0.0
17
+ with:
18
+ python-version: ">=3.8"
19
+
20
+ - name: Install uv
21
+ uses: astral-sh/setup-uv@v5
22
+
23
+ - name: Run Ruff
24
+ run: |
25
+ uv run --group=dev ruff check src
26
+ shell: bash
27
+
28
+ - name: Run Mypy
29
+ run: |
30
+ uv run --group=dev mypy src
31
+ shell: bash
@@ -0,0 +1,51 @@
1
+ name: Publish Python distribution to PyPI
2
+ on:
3
+ # release:
4
+ # types: [ published ]
5
+ push:
6
+ branches:
7
+ - gonrappaport/aidev-445-create-publish-action
8
+
9
+ jobs:
10
+ build:
11
+ name: Build distribution
12
+ runs-on: ubuntu-latest
13
+ steps:
14
+ - uses: actions/checkout@v4
15
+ - name: Set up Python
16
+ uses: actions/setup-python@v5
17
+ with:
18
+ python-version: ">=3.8"
19
+ - name: Install uv
20
+ uses: astral-sh/setup-uv@v5
21
+ - name: Build a binary wheel and a source tarball
22
+ run: uv build
23
+ - name: Store the distribution packages
24
+ uses: actions/upload-artifact@v4
25
+ with:
26
+ name: python-package-distributions
27
+ path: dist/
28
+
29
+ publish-to-pypi:
30
+ name: Publish Python distribution to PyPI
31
+ needs:
32
+ - build
33
+ runs-on: ubuntu-latest
34
+ environment:
35
+ name: pypi
36
+ url: https://pypi.org/project/llm-tracekit/
37
+ permissions:
38
+ id-token: write
39
+ steps:
40
+ - name: Install uv
41
+ uses: astral-sh/setup-uv@v5
42
+ - name: Download all the dists
43
+ uses: actions/download-artifact@v4
44
+ with:
45
+ name: python-package-distributions
46
+ path: dist/
47
+ - name: Publish distribution to PyPI
48
+ run: uv publish
49
+ env:
50
+ UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
51
+ UV_PUBLISH_URL: https://upload.pypi.org/legacy/
@@ -0,0 +1,30 @@
1
+ name: Unit Tests
2
+ run-name: Unit Tests
3
+
4
+ on:
5
+ pull_request:
6
+
7
+ jobs:
8
+ tests:
9
+ runs-on: ubuntu-latest
10
+ strategy:
11
+ fail-fast: false
12
+ matrix:
13
+ python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
14
+ name: Unit Tests - Python ${{ matrix.python-version }}
15
+ steps:
16
+ - name: Checkout
17
+ uses: actions/checkout@v4
18
+
19
+ - name: Setup python ${{ matrix.python-version}}
20
+ uses: actions/setup-python@v5.0.0
21
+ with:
22
+ python-version: ${{ matrix.python-version }}
23
+
24
+ - name: Install uv
25
+ uses: astral-sh/setup-uv@v5
26
+
27
+ - name: Run test
28
+ run: |
29
+ uv run --group=dev pytest tests/ -sv
30
+ shell: bash
@@ -0,0 +1,60 @@
1
+ # BeyondCompare
2
+ *.orig
3
+
4
+ # Pulumi
5
+ Pulumi.*.yaml
6
+
7
+ # Helm chart dependencies
8
+ requirements.lock
9
+ **/charts/*.tgz
10
+
11
+ # JetBrains
12
+ .idea
13
+
14
+ # MacOS
15
+ .DS_Store
16
+
17
+ # Ignore all VSCode setting except launch.json in root directory
18
+ services/**/.vscode
19
+ infra/**/.vscode
20
+ lib/**/.vscode
21
+ /.vscode/*
22
+ !/.vscode/launch.json
23
+ !/.vscode/tasks.json
24
+ .history
25
+ env
26
+ lib/*/dist
27
+
28
+ # Python
29
+ *.pyc
30
+ venv
31
+ __pycache__/
32
+
33
+ # pyenv
34
+ .python-version
35
+
36
+ # Poetry
37
+ .venv/
38
+
39
+ # Ruff
40
+ .ruff_cache/
41
+
42
+ # Logs
43
+ *.log
44
+ *.log.*
45
+
46
+ services/**/dist/
47
+ infra/tools/aporia_cli/.context.json
48
+
49
+ tests/system/tests_result/*
50
+ !tests/system/tests_result/.gitkeep
51
+
52
+ tests/system/result.xlsx
53
+ agent/tmp
54
+ infra/pulumi/**/*.crt
55
+ infra/pulumi/**/*.key
56
+ tests/system/latency_results*
57
+ nginx/certs/*
58
+ infra/pulumi/tmp
59
+
60
+ src/llm_tracekit.egg-info/
@@ -0,0 +1 @@
1
+ * @coralogix/team-cxai
@@ -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,95 @@
1
+ Metadata-Version: 2.4
2
+ Name: llm-tracekit
3
+ Version: 1.0.0
4
+ Summary: Add your description here
5
+ License-File: LICENSE.md
6
+ Requires-Python: <4.0,>=3.8
7
+ Requires-Dist: openai>=1.26.0
8
+ Requires-Dist: opentelemetry-api~=1.30.0
9
+ Requires-Dist: opentelemetry-instrumentation~=0.51b0
10
+ Requires-Dist: opentelemetry-semantic-conventions~=0.51b0
11
+ Provides-Extra: export
12
+ Requires-Dist: opentelemetry-exporter-otlp>=1.30.0; extra == 'export'
13
+ Requires-Dist: opentelemetry-sdk>=1.30.0; extra == 'export'
14
+ Description-Content-Type: text/markdown
15
+
16
+ # LLM Tracekit
17
+ This library is a modified version of the [OpenTelemetry instrumentaion for OpenAI](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation-genai/opentelemetry-instrumentation-openai-v2), designed to simplify LLM application development and production tracing and debugging.
18
+
19
+ ## Installation
20
+ ```bash
21
+ pip install llm-tracekit
22
+ ```
23
+
24
+ ## Usage
25
+ This library serves as a replacement for the OpenTelemetry OpenAI instrumentation - to set up OpenAI instrumentation, follow the manual instrumentation process detailed in the [OpenTelemetry OpenAI instrumentation docs](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation-genai/opentelemetry-instrumentation-openai-v2#usage) and replace `opentelemetry.instrumentation.openai_v2` with `llm_tracekit`.
26
+
27
+ ### Activation
28
+ ```python
29
+ from llm_tracekit import OpenAIInstrumentor
30
+
31
+ OpenAIInstrumentor().instrument()
32
+ ```
33
+
34
+ ### Full Example
35
+ ```python
36
+ from llm_tracekit import OpenAIInstrumentor, setup_export_to_coralogix
37
+ from openai import OpenAI
38
+
39
+ # Optional: Configure sending spans to Coralogix
40
+ # Reads Coralogix connection details from the following environment variables:
41
+ # - CX_TOKEN
42
+ # - CX_ENDPOINT
43
+ # To use, install llm-tracekit[export]
44
+ setup_export_to_coralogix(
45
+ service_name="ai-service",
46
+ application_name="ai-application",
47
+ subsystem_name="ai-subsystem",
48
+ capture_content=True,
49
+ )
50
+
51
+ # Activate instrumentation
52
+ OpenAIInstrumentor().instrument()
53
+
54
+ # Example OpenAI Usage
55
+ client = OpenAI()
56
+ response = client.chat.completions.create(
57
+ model="gpt-4o-mini",
58
+ messages=[
59
+ {"role": "user", "content": "Write a short poem on open telemetry."},
60
+ ],
61
+ )
62
+ ```
63
+
64
+ ### Enabling message content
65
+ Message content such as the contents of the prompt, completion, function arguments and return values are not captured by default. To capture message content as span attributes, set the environment variable OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT to true.
66
+
67
+ Most Coralogix AI evaluations will not work without message contents, so it is highly recommended to enable capturing.
68
+
69
+ ### Changes from OpenTelemetry
70
+ * The `user` parameter in the OpenAI Chat Completions API is now recorded in the span as the `gen_ai.openai.request.user` attribute
71
+ * The `tools` parameter in the OpenAI Chat Completions API is now recorded in the span as the `gen_ai.openai.request.tools` attributes.
72
+ * User prompts and model responses are captured as span attributes instead of log events (see [Semantic Conventions](#semantic-conventions) below)
73
+
74
+ ## Semantic Conventions
75
+ | Attribute | Type | Description | Examples
76
+ | --------- | ---- | ----------- | --------
77
+ | `gen_ai.openai.request.user` | string | A unique identifier representing the end-user | `user@company.com`
78
+ | `gen_ai.openai.request.tools.<tool_number>.type` | string | Type of tool entry in tools list | `function`
79
+ | `gen_ai.openai.request.tools.<tool_number>.function.name` | string | The name of the function to use in tool calls | `get_current_weather`
80
+ | `gen_ai.openai.request.tools.<tool_number>.function.description` | string | Description of the function | `Get the current weather in a given location`
81
+ | `gen_ai.openai.request.tools.<tool_number>.function.parameters` | string | JSON describing the schema of the function parameters | `{"type": "object", "properties": {"location": {"type": "string", "description": "The city and state, e.g. San Francisco, CA"}, "unit": {"type": "string", "enum": ["celsius", "fahrenheit"]}}, "required": ["location"]}`
82
+ | `gen_ai.prompt.<message_number>.role` | string | Role of message author for user message <message_number> | `system`, `user`, `assistant`, `tool`
83
+ | `gen_ai.prompt.<message_number>.content` | string | Contents of user message <message_number> | `What's the weather in Paris?`
84
+ | `gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.id` | string | ID of tool call in user message <message_number> | `call_O8NOz8VlxosSASEsOY7LDUcP`
85
+ | `gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.type` | string | Type of tool call in user message <message_number> | `function`
86
+ | `gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.function.name` | string | The name of the function used in tool call within user message <message_number> | `get_current_weather`
87
+ | `gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.function.arguments` | string | Arguments passed to the function used in tool call within user message <message_number> | `{"location": "Seattle, WA"}`
88
+ | `gen_ai.prompt.<message_number>.tool_call_id` | string | Tool call ID in user message <message_number> | `call_mszuSIzqtI65i1wAUOE8w5H4`
89
+ | `gen_ai.completion.<choice_number>.role` | string | Role of message author for choice <choice_number> in model response | `assistant`
90
+ | `gen_ai.completion.<choice_number>.finish_reason` | string | Finish reason for choice <choice_number> in model response | `stop`, `tool_calls`, `error`
91
+ | `gen_ai.completion.<choice_number>.content` | string | Contents of choice <choice_number> in model response | `The weather in Paris is rainy and overcast, with temperatures around 57°F`
92
+ | `gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.id` | string | ID of tool call in choice <choice_number> | `call_O8NOz8VlxosSASEsOY7LDUcP`
93
+ | `gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.type` | string | Type of tool call in choice <choice_number> | `function`
94
+ | `gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.function.name` | string | The name of the function used in tool call within choice <choice_number> | `get_current_weather`
95
+ | `gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.function.arguments` | string | Arguments passed to the function used in tool call within choice <choice_number> | `{"location": "Seattle, WA"}`
@@ -0,0 +1,80 @@
1
+ # LLM Tracekit
2
+ This library is a modified version of the [OpenTelemetry instrumentaion for OpenAI](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation-genai/opentelemetry-instrumentation-openai-v2), designed to simplify LLM application development and production tracing and debugging.
3
+
4
+ ## Installation
5
+ ```bash
6
+ pip install llm-tracekit
7
+ ```
8
+
9
+ ## Usage
10
+ This library serves as a replacement for the OpenTelemetry OpenAI instrumentation - to set up OpenAI instrumentation, follow the manual instrumentation process detailed in the [OpenTelemetry OpenAI instrumentation docs](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation-genai/opentelemetry-instrumentation-openai-v2#usage) and replace `opentelemetry.instrumentation.openai_v2` with `llm_tracekit`.
11
+
12
+ ### Activation
13
+ ```python
14
+ from llm_tracekit import OpenAIInstrumentor
15
+
16
+ OpenAIInstrumentor().instrument()
17
+ ```
18
+
19
+ ### Full Example
20
+ ```python
21
+ from llm_tracekit import OpenAIInstrumentor, setup_export_to_coralogix
22
+ from openai import OpenAI
23
+
24
+ # Optional: Configure sending spans to Coralogix
25
+ # Reads Coralogix connection details from the following environment variables:
26
+ # - CX_TOKEN
27
+ # - CX_ENDPOINT
28
+ # To use, install llm-tracekit[export]
29
+ setup_export_to_coralogix(
30
+ service_name="ai-service",
31
+ application_name="ai-application",
32
+ subsystem_name="ai-subsystem",
33
+ capture_content=True,
34
+ )
35
+
36
+ # Activate instrumentation
37
+ OpenAIInstrumentor().instrument()
38
+
39
+ # Example OpenAI Usage
40
+ client = OpenAI()
41
+ response = client.chat.completions.create(
42
+ model="gpt-4o-mini",
43
+ messages=[
44
+ {"role": "user", "content": "Write a short poem on open telemetry."},
45
+ ],
46
+ )
47
+ ```
48
+
49
+ ### Enabling message content
50
+ Message content such as the contents of the prompt, completion, function arguments and return values are not captured by default. To capture message content as span attributes, set the environment variable OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT to true.
51
+
52
+ Most Coralogix AI evaluations will not work without message contents, so it is highly recommended to enable capturing.
53
+
54
+ ### Changes from OpenTelemetry
55
+ * The `user` parameter in the OpenAI Chat Completions API is now recorded in the span as the `gen_ai.openai.request.user` attribute
56
+ * The `tools` parameter in the OpenAI Chat Completions API is now recorded in the span as the `gen_ai.openai.request.tools` attributes.
57
+ * User prompts and model responses are captured as span attributes instead of log events (see [Semantic Conventions](#semantic-conventions) below)
58
+
59
+ ## Semantic Conventions
60
+ | Attribute | Type | Description | Examples
61
+ | --------- | ---- | ----------- | --------
62
+ | `gen_ai.openai.request.user` | string | A unique identifier representing the end-user | `user@company.com`
63
+ | `gen_ai.openai.request.tools.<tool_number>.type` | string | Type of tool entry in tools list | `function`
64
+ | `gen_ai.openai.request.tools.<tool_number>.function.name` | string | The name of the function to use in tool calls | `get_current_weather`
65
+ | `gen_ai.openai.request.tools.<tool_number>.function.description` | string | Description of the function | `Get the current weather in a given location`
66
+ | `gen_ai.openai.request.tools.<tool_number>.function.parameters` | string | JSON describing the schema of the function parameters | `{"type": "object", "properties": {"location": {"type": "string", "description": "The city and state, e.g. San Francisco, CA"}, "unit": {"type": "string", "enum": ["celsius", "fahrenheit"]}}, "required": ["location"]}`
67
+ | `gen_ai.prompt.<message_number>.role` | string | Role of message author for user message <message_number> | `system`, `user`, `assistant`, `tool`
68
+ | `gen_ai.prompt.<message_number>.content` | string | Contents of user message <message_number> | `What's the weather in Paris?`
69
+ | `gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.id` | string | ID of tool call in user message <message_number> | `call_O8NOz8VlxosSASEsOY7LDUcP`
70
+ | `gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.type` | string | Type of tool call in user message <message_number> | `function`
71
+ | `gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.function.name` | string | The name of the function used in tool call within user message <message_number> | `get_current_weather`
72
+ | `gen_ai.prompt.<message_number>.tool_calls.<tool_call_number>.function.arguments` | string | Arguments passed to the function used in tool call within user message <message_number> | `{"location": "Seattle, WA"}`
73
+ | `gen_ai.prompt.<message_number>.tool_call_id` | string | Tool call ID in user message <message_number> | `call_mszuSIzqtI65i1wAUOE8w5H4`
74
+ | `gen_ai.completion.<choice_number>.role` | string | Role of message author for choice <choice_number> in model response | `assistant`
75
+ | `gen_ai.completion.<choice_number>.finish_reason` | string | Finish reason for choice <choice_number> in model response | `stop`, `tool_calls`, `error`
76
+ | `gen_ai.completion.<choice_number>.content` | string | Contents of choice <choice_number> in model response | `The weather in Paris is rainy and overcast, with temperatures around 57°F`
77
+ | `gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.id` | string | ID of tool call in choice <choice_number> | `call_O8NOz8VlxosSASEsOY7LDUcP`
78
+ | `gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.type` | string | Type of tool call in choice <choice_number> | `function`
79
+ | `gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.function.name` | string | The name of the function used in tool call within choice <choice_number> | `get_current_weather`
80
+ | `gen_ai.completion.<choice_number>.tool_calls.<tool_call_number >.function.arguments` | string | Arguments passed to the function used in tool call within choice <choice_number> | `{"location": "Seattle, WA"}`
@@ -0,0 +1,40 @@
1
+ [project]
2
+ name = "llm-tracekit"
3
+ version = "1.0.0"
4
+ description = "Add your description here"
5
+ readme = "README.md"
6
+ requires-python = ">=3.8, <4.0"
7
+ dependencies = [
8
+ "openai>=1.26.0",
9
+ "opentelemetry-api~=1.30.0",
10
+ "opentelemetry-instrumentation~=0.51b0",
11
+ "opentelemetry-semantic-conventions~=0.51b0",
12
+ ]
13
+
14
+ [dependency-groups]
15
+ dev = [
16
+ "mypy>=1.14.1",
17
+ "opentelemetry-sdk>=1.30.0",
18
+ "pytest>=8.3.4",
19
+ "pytest-asyncio>=0.24.0",
20
+ "pytest-vcr>=1.0.2",
21
+ "pyyaml>=6.0.2",
22
+ "ruff>=0.9.7",
23
+ ]
24
+
25
+ [project.optional-dependencies]
26
+ export = [
27
+ "opentelemetry-exporter-otlp>=1.30.0",
28
+ "opentelemetry-sdk>=1.30.0",
29
+ ]
30
+
31
+ [build-system]
32
+ requires = ["hatchling"]
33
+ build-backend = "hatchling.build"
34
+
35
+ [tool.pytest.ini_options]
36
+ asyncio_default_fixture_loop_scope = "function"
37
+
38
+ [[tool.mypy.overrides]]
39
+ module = ["wrapt", "opentelemetry.exporter.otlp.proto.grpc.trace_exporter"]
40
+ ignore_missing_imports = true