beacon-otel 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.
- beacon_otel-0.1.0/.gitignore +68 -0
- beacon_otel-0.1.0/LICENSE +201 -0
- beacon_otel-0.1.0/PKG-INFO +63 -0
- beacon_otel-0.1.0/README.md +29 -0
- beacon_otel-0.1.0/pyproject.toml +65 -0
- beacon_otel-0.1.0/src/beacon_otel/__init__.py +5 -0
- beacon_otel-0.1.0/src/beacon_otel/cli.py +44 -0
- beacon_otel-0.1.0/src/beacon_otel/distro.py +28 -0
- beacon_otel-0.1.0/src/beacon_otel/version.py +2 -0
- beacon_otel-0.1.0/tests/test_cli.py +78 -0
- beacon_otel-0.1.0/tests/test_distro.py +48 -0
- beacon_otel-0.1.0/tests/test_package_metadata.py +22 -0
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
*.py[cod]
|
|
2
|
+
*.sw[op]
|
|
3
|
+
|
|
4
|
+
# C extensions
|
|
5
|
+
*.so
|
|
6
|
+
|
|
7
|
+
# Packages
|
|
8
|
+
*.egg
|
|
9
|
+
*.egg-info
|
|
10
|
+
dist
|
|
11
|
+
dist-info
|
|
12
|
+
build
|
|
13
|
+
eggs
|
|
14
|
+
parts
|
|
15
|
+
bin
|
|
16
|
+
var
|
|
17
|
+
sdist
|
|
18
|
+
develop-eggs
|
|
19
|
+
.installed.cfg
|
|
20
|
+
pyvenv.cfg
|
|
21
|
+
lib
|
|
22
|
+
lib64
|
|
23
|
+
__pycache__
|
|
24
|
+
venv*/
|
|
25
|
+
.venv*/
|
|
26
|
+
|
|
27
|
+
# Installer logs
|
|
28
|
+
pip-log.txt
|
|
29
|
+
|
|
30
|
+
# Unit test / coverage reports
|
|
31
|
+
coverage.xml
|
|
32
|
+
.coverage
|
|
33
|
+
.nox
|
|
34
|
+
.tox
|
|
35
|
+
.cache
|
|
36
|
+
htmlcov
|
|
37
|
+
|
|
38
|
+
# Translations
|
|
39
|
+
*.mo
|
|
40
|
+
|
|
41
|
+
# Mac
|
|
42
|
+
.DS_Store
|
|
43
|
+
|
|
44
|
+
# Mr Developer
|
|
45
|
+
.mr.developer.cfg
|
|
46
|
+
.project
|
|
47
|
+
.pydevproject
|
|
48
|
+
|
|
49
|
+
# JetBrains
|
|
50
|
+
.idea
|
|
51
|
+
|
|
52
|
+
# VSCode
|
|
53
|
+
.vscode
|
|
54
|
+
|
|
55
|
+
# Sphinx
|
|
56
|
+
_build/
|
|
57
|
+
|
|
58
|
+
# mypy
|
|
59
|
+
.mypy_cache/
|
|
60
|
+
target
|
|
61
|
+
|
|
62
|
+
# Benchmark result files
|
|
63
|
+
*-benchmark.json
|
|
64
|
+
|
|
65
|
+
# opentelemetry-admin jobs
|
|
66
|
+
opentelemetry-admin-jobs.txt
|
|
67
|
+
|
|
68
|
+
.claude/settings.local.json
|
|
@@ -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,63 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: beacon-otel
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Beacon Python auto-instrumentation distribution
|
|
5
|
+
Project-URL: Homepage, https://github.com/GuanceCloud/beacon-python/tree/main/beacon-otel
|
|
6
|
+
Project-URL: Repository, https://github.com/GuanceCloud/beacon-python
|
|
7
|
+
Author: GuanceCloud
|
|
8
|
+
License-Expression: Apache-2.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
13
|
+
Classifier: Programming Language :: Python
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
20
|
+
Requires-Python: >=3.10
|
|
21
|
+
Requires-Dist: opentelemetry-api==1.44.0
|
|
22
|
+
Requires-Dist: opentelemetry-exporter-otlp==1.44.0
|
|
23
|
+
Requires-Dist: opentelemetry-instrumentation==0.65b0
|
|
24
|
+
Requires-Dist: opentelemetry-sdk==1.44.0
|
|
25
|
+
Provides-Extra: fastapi
|
|
26
|
+
Requires-Dist: opentelemetry-instrumentation-fastapi==0.65b0; extra == 'fastapi'
|
|
27
|
+
Provides-Extra: flask
|
|
28
|
+
Requires-Dist: opentelemetry-instrumentation-flask==0.65b0; extra == 'flask'
|
|
29
|
+
Provides-Extra: profiling
|
|
30
|
+
Requires-Dist: beacon-profiling==0.1.0; extra == 'profiling'
|
|
31
|
+
Provides-Extra: requests
|
|
32
|
+
Requires-Dist: opentelemetry-instrumentation-requests==0.65b0; extra == 'requests'
|
|
33
|
+
Description-Content-Type: text/markdown
|
|
34
|
+
|
|
35
|
+
# Beacon Python
|
|
36
|
+
|
|
37
|
+
`beacon-otel` 是 Beacon Python 的主安装包。当前稳定版本为 `0.1.0`。
|
|
38
|
+
|
|
39
|
+
安装主包和所需框架的自动插桩插件。例如,FastAPI 应用可安装当前稳定版本:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pip install 'beacon-otel[fastapi]==0.1.0'
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
需要 Profiling 时安装:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
pip install 'beacon-otel[fastapi,profiling]==0.1.0'
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
先激活安装 Beacon 的虚拟环境,再配置 OTLP 接收端并启动应用;也可以在 `beacon` 后传入该虚拟环境内可执行文件的完整路径:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
export OTEL_SERVICE_NAME=my-service
|
|
55
|
+
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
|
|
56
|
+
beacon uvicorn myapp:app
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
`beacon --version` 显示 Beacon Python 产品版本。当前提供 `requests`、`flask`、`fastapi` 可选依赖;其他框架的自动插桩包可根据 OpenTelemetry 官方说明单独安装。安装包存在不代表所有框架和运行环境已获 Beacon 稳定版支持;支持范围以对应版本的发行说明和验收记录为准。
|
|
60
|
+
|
|
61
|
+
可选依赖仅安装对应的自动插桩插件;应用框架本身仍由应用自行安装。不要在同一 Python 环境中混装旧版 `guance-sdk-extension-profiling`,其自动插桩入口会与 `beacon-profiling` 冲突。
|
|
62
|
+
|
|
63
|
+
`beacon` 默认选择 Beacon 的 OpenTelemetry distro/configurator,并沿用标准 `OTEL_*` 环境变量。用户显式设置的 `OTEL_PYTHON_DISTRO` 或 `OTEL_PYTHON_CONFIGURATOR` 不会被覆盖。Profiling 默认关闭,启用方式见[Profiling 文档](../sdk-extension/beacon-profiling/README.rst)。
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Beacon Python
|
|
2
|
+
|
|
3
|
+
`beacon-otel` 是 Beacon Python 的主安装包。当前稳定版本为 `0.1.0`。
|
|
4
|
+
|
|
5
|
+
安装主包和所需框架的自动插桩插件。例如,FastAPI 应用可安装当前稳定版本:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pip install 'beacon-otel[fastapi]==0.1.0'
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
需要 Profiling 时安装:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pip install 'beacon-otel[fastapi,profiling]==0.1.0'
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
先激活安装 Beacon 的虚拟环境,再配置 OTLP 接收端并启动应用;也可以在 `beacon` 后传入该虚拟环境内可执行文件的完整路径:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
export OTEL_SERVICE_NAME=my-service
|
|
21
|
+
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
|
|
22
|
+
beacon uvicorn myapp:app
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
`beacon --version` 显示 Beacon Python 产品版本。当前提供 `requests`、`flask`、`fastapi` 可选依赖;其他框架的自动插桩包可根据 OpenTelemetry 官方说明单独安装。安装包存在不代表所有框架和运行环境已获 Beacon 稳定版支持;支持范围以对应版本的发行说明和验收记录为准。
|
|
26
|
+
|
|
27
|
+
可选依赖仅安装对应的自动插桩插件;应用框架本身仍由应用自行安装。不要在同一 Python 环境中混装旧版 `guance-sdk-extension-profiling`,其自动插桩入口会与 `beacon-profiling` 冲突。
|
|
28
|
+
|
|
29
|
+
`beacon` 默认选择 Beacon 的 OpenTelemetry distro/configurator,并沿用标准 `OTEL_*` 环境变量。用户显式设置的 `OTEL_PYTHON_DISTRO` 或 `OTEL_PYTHON_CONFIGURATOR` 不会被覆盖。Profiling 默认关闭,启用方式见[Profiling 文档](../sdk-extension/beacon-profiling/README.rst)。
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "beacon-otel"
|
|
7
|
+
dynamic = ["version"]
|
|
8
|
+
description = "Beacon Python auto-instrumentation distribution"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "Apache-2.0"
|
|
11
|
+
requires-python = ">=3.10"
|
|
12
|
+
authors = [
|
|
13
|
+
{ name = "GuanceCloud" },
|
|
14
|
+
]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 3 - Alpha",
|
|
17
|
+
"Intended Audience :: Developers",
|
|
18
|
+
"License :: OSI Approved :: Apache Software License",
|
|
19
|
+
"Programming Language :: Python",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3.10",
|
|
22
|
+
"Programming Language :: Python :: 3.11",
|
|
23
|
+
"Programming Language :: Python :: 3.12",
|
|
24
|
+
"Programming Language :: Python :: 3.13",
|
|
25
|
+
"Programming Language :: Python :: 3.14",
|
|
26
|
+
]
|
|
27
|
+
dependencies = [
|
|
28
|
+
"opentelemetry-api == 1.44.0",
|
|
29
|
+
"opentelemetry-sdk == 1.44.0",
|
|
30
|
+
"opentelemetry-instrumentation == 0.65b0",
|
|
31
|
+
"opentelemetry-exporter-otlp == 1.44.0",
|
|
32
|
+
]
|
|
33
|
+
|
|
34
|
+
[project.optional-dependencies]
|
|
35
|
+
profiling = ["beacon-profiling == 0.1.0"]
|
|
36
|
+
requests = ["opentelemetry-instrumentation-requests == 0.65b0"]
|
|
37
|
+
flask = ["opentelemetry-instrumentation-flask == 0.65b0"]
|
|
38
|
+
fastapi = ["opentelemetry-instrumentation-fastapi == 0.65b0"]
|
|
39
|
+
|
|
40
|
+
[project.scripts]
|
|
41
|
+
beacon = "beacon_otel.cli:main"
|
|
42
|
+
|
|
43
|
+
[project.entry-points.opentelemetry_distro]
|
|
44
|
+
beacon = "beacon_otel.distro:BeaconDistro"
|
|
45
|
+
|
|
46
|
+
[project.entry-points.opentelemetry_configurator]
|
|
47
|
+
beacon = "beacon_otel.distro:BeaconConfigurator"
|
|
48
|
+
|
|
49
|
+
[project.urls]
|
|
50
|
+
Homepage = "https://github.com/GuanceCloud/beacon-python/tree/main/beacon-otel"
|
|
51
|
+
Repository = "https://github.com/GuanceCloud/beacon-python"
|
|
52
|
+
|
|
53
|
+
[tool.hatch.version]
|
|
54
|
+
path = "src/beacon_otel/version.py"
|
|
55
|
+
|
|
56
|
+
[tool.hatch.build.targets.sdist]
|
|
57
|
+
include = [
|
|
58
|
+
"/src",
|
|
59
|
+
"/tests",
|
|
60
|
+
"/README.md",
|
|
61
|
+
"/LICENSE",
|
|
62
|
+
]
|
|
63
|
+
|
|
64
|
+
[tool.hatch.build.targets.wheel]
|
|
65
|
+
packages = ["src/beacon_otel"]
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"""Beacon Python command-line entry point."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import os
|
|
6
|
+
import sys
|
|
7
|
+
from importlib.metadata import PackageNotFoundError, distribution
|
|
8
|
+
|
|
9
|
+
from beacon_otel.version import __version__
|
|
10
|
+
|
|
11
|
+
from opentelemetry.instrumentation.auto_instrumentation import run
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
def main() -> None:
|
|
15
|
+
"""Launch an application with the Beacon distro selected by default."""
|
|
16
|
+
args = sys.argv[1:]
|
|
17
|
+
if args == ["--version"]:
|
|
18
|
+
print(f"Beacon Python {__version__}")
|
|
19
|
+
return
|
|
20
|
+
if not args or args[0] in ("-h", "--help"):
|
|
21
|
+
print("usage: beacon [OTEL options] COMMAND [ARGS ...]")
|
|
22
|
+
print("Run a Python application with Beacon auto-instrumentation.")
|
|
23
|
+
print(
|
|
24
|
+
"Configure telemetry with standard OTEL_* environment variables."
|
|
25
|
+
)
|
|
26
|
+
if not args:
|
|
27
|
+
raise SystemExit(2)
|
|
28
|
+
return
|
|
29
|
+
|
|
30
|
+
try:
|
|
31
|
+
distribution("guance-sdk-extension-profiling")
|
|
32
|
+
except PackageNotFoundError:
|
|
33
|
+
pass
|
|
34
|
+
else:
|
|
35
|
+
raise SystemExit(
|
|
36
|
+
"Beacon Python cannot run alongside the legacy "
|
|
37
|
+
"guance-sdk-extension-profiling package. Remove that package "
|
|
38
|
+
"from this environment before launching with beacon."
|
|
39
|
+
)
|
|
40
|
+
|
|
41
|
+
os.environ.setdefault("OTEL_PYTHON_DISTRO", "beacon")
|
|
42
|
+
os.environ.setdefault("OTEL_PYTHON_CONFIGURATOR", "beacon")
|
|
43
|
+
|
|
44
|
+
run()
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
"""Beacon defaults for OpenTelemetry Python auto-instrumentation."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import os
|
|
6
|
+
|
|
7
|
+
from opentelemetry.environment_variables import (
|
|
8
|
+
OTEL_LOGS_EXPORTER,
|
|
9
|
+
OTEL_METRICS_EXPORTER,
|
|
10
|
+
OTEL_TRACES_EXPORTER,
|
|
11
|
+
)
|
|
12
|
+
from opentelemetry.instrumentation.distro import BaseDistro
|
|
13
|
+
from opentelemetry.sdk._configuration import _OTelSDKConfigurator
|
|
14
|
+
from opentelemetry.sdk.environment_variables import OTEL_EXPORTER_OTLP_PROTOCOL
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
class BeaconConfigurator(_OTelSDKConfigurator):
|
|
18
|
+
"""Configure the OTel SDK using its standard environment variables."""
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
class BeaconDistro(BaseDistro):
|
|
22
|
+
"""Select OTLP defaults without overriding explicit user settings."""
|
|
23
|
+
|
|
24
|
+
def _configure(self, **kwargs: object) -> None:
|
|
25
|
+
os.environ.setdefault(OTEL_TRACES_EXPORTER, "otlp")
|
|
26
|
+
os.environ.setdefault(OTEL_METRICS_EXPORTER, "otlp")
|
|
27
|
+
os.environ.setdefault(OTEL_LOGS_EXPORTER, "otlp")
|
|
28
|
+
os.environ.setdefault(OTEL_EXPORTER_OTLP_PROTOCOL, "grpc")
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"""Behavior of the Beacon command-line entry point."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import os
|
|
6
|
+
import sys
|
|
7
|
+
from importlib.metadata import PackageNotFoundError
|
|
8
|
+
from unittest.mock import patch
|
|
9
|
+
|
|
10
|
+
import pytest
|
|
11
|
+
from beacon_otel import __version__
|
|
12
|
+
from beacon_otel.cli import main
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def test_version(capsys: pytest.CaptureFixture[str]) -> None:
|
|
16
|
+
with patch.object(sys, "argv", ["beacon", "--version"]):
|
|
17
|
+
main()
|
|
18
|
+
assert capsys.readouterr().out == f"Beacon Python {__version__}\n"
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
def test_help(capsys: pytest.CaptureFixture[str]) -> None:
|
|
22
|
+
with patch.object(sys, "argv", ["beacon", "--help"]):
|
|
23
|
+
main()
|
|
24
|
+
assert "usage: beacon" in capsys.readouterr().out
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
def test_missing_command(capsys: pytest.CaptureFixture[str]) -> None:
|
|
28
|
+
with patch.object(sys, "argv", ["beacon"]):
|
|
29
|
+
with pytest.raises(SystemExit, match="2"):
|
|
30
|
+
main()
|
|
31
|
+
assert "usage: beacon" in capsys.readouterr().out
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
def test_launch_selects_beacon_entry_points(
|
|
35
|
+
monkeypatch: pytest.MonkeyPatch,
|
|
36
|
+
) -> None:
|
|
37
|
+
monkeypatch.delenv("OTEL_PYTHON_DISTRO", raising=False)
|
|
38
|
+
monkeypatch.delenv("OTEL_PYTHON_CONFIGURATOR", raising=False)
|
|
39
|
+
with (
|
|
40
|
+
patch.object(sys, "argv", ["beacon", "python", "app.py"]),
|
|
41
|
+
patch(
|
|
42
|
+
"beacon_otel.cli.distribution",
|
|
43
|
+
side_effect=PackageNotFoundError,
|
|
44
|
+
),
|
|
45
|
+
patch("beacon_otel.cli.run") as run,
|
|
46
|
+
):
|
|
47
|
+
main()
|
|
48
|
+
run.assert_called_once_with()
|
|
49
|
+
assert os.environ["OTEL_PYTHON_DISTRO"] == "beacon"
|
|
50
|
+
assert os.environ["OTEL_PYTHON_CONFIGURATOR"] == "beacon"
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
def test_launch_keeps_explicit_distro(
|
|
54
|
+
monkeypatch: pytest.MonkeyPatch,
|
|
55
|
+
) -> None:
|
|
56
|
+
monkeypatch.setenv("OTEL_PYTHON_DISTRO", "custom")
|
|
57
|
+
monkeypatch.setenv("OTEL_PYTHON_CONFIGURATOR", "custom")
|
|
58
|
+
with (
|
|
59
|
+
patch.object(sys, "argv", ["beacon", "python", "app.py"]),
|
|
60
|
+
patch(
|
|
61
|
+
"beacon_otel.cli.distribution",
|
|
62
|
+
side_effect=PackageNotFoundError,
|
|
63
|
+
),
|
|
64
|
+
patch("beacon_otel.cli.run"),
|
|
65
|
+
):
|
|
66
|
+
main()
|
|
67
|
+
assert os.environ["OTEL_PYTHON_DISTRO"] == "custom"
|
|
68
|
+
assert os.environ["OTEL_PYTHON_CONFIGURATOR"] == "custom"
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
def test_legacy_profiling_conflict_is_actionable() -> None:
|
|
72
|
+
with (
|
|
73
|
+
patch.object(sys, "argv", ["beacon", "python", "app.py"]),
|
|
74
|
+
patch("beacon_otel.cli.distribution") as legacy_distribution,
|
|
75
|
+
):
|
|
76
|
+
legacy_distribution.return_value = object()
|
|
77
|
+
with pytest.raises(SystemExit, match="guance-sdk-extension-profiling"):
|
|
78
|
+
main()
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
"""Beacon OpenTelemetry distro defaults."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import os
|
|
6
|
+
|
|
7
|
+
import pytest
|
|
8
|
+
from beacon_otel.distro import BeaconDistro
|
|
9
|
+
|
|
10
|
+
from opentelemetry.environment_variables import (
|
|
11
|
+
OTEL_LOGS_EXPORTER,
|
|
12
|
+
OTEL_METRICS_EXPORTER,
|
|
13
|
+
OTEL_TRACES_EXPORTER,
|
|
14
|
+
)
|
|
15
|
+
from opentelemetry.sdk.environment_variables import OTEL_EXPORTER_OTLP_PROTOCOL
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
def test_defaults(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
19
|
+
for key in (
|
|
20
|
+
OTEL_TRACES_EXPORTER,
|
|
21
|
+
OTEL_METRICS_EXPORTER,
|
|
22
|
+
OTEL_LOGS_EXPORTER,
|
|
23
|
+
OTEL_EXPORTER_OTLP_PROTOCOL,
|
|
24
|
+
):
|
|
25
|
+
monkeypatch.delenv(key, raising=False)
|
|
26
|
+
|
|
27
|
+
BeaconDistro().configure()
|
|
28
|
+
|
|
29
|
+
assert os.environ[OTEL_TRACES_EXPORTER] == "otlp"
|
|
30
|
+
assert os.environ[OTEL_METRICS_EXPORTER] == "otlp"
|
|
31
|
+
assert os.environ[OTEL_LOGS_EXPORTER] == "otlp"
|
|
32
|
+
assert os.environ[OTEL_EXPORTER_OTLP_PROTOCOL] == "grpc"
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
def test_explicit_settings_are_preserved(
|
|
36
|
+
monkeypatch: pytest.MonkeyPatch,
|
|
37
|
+
) -> None:
|
|
38
|
+
monkeypatch.setenv(OTEL_TRACES_EXPORTER, "console")
|
|
39
|
+
monkeypatch.setenv(OTEL_METRICS_EXPORTER, "none")
|
|
40
|
+
monkeypatch.setenv(OTEL_LOGS_EXPORTER, "none")
|
|
41
|
+
monkeypatch.setenv(OTEL_EXPORTER_OTLP_PROTOCOL, "http/protobuf")
|
|
42
|
+
|
|
43
|
+
BeaconDistro().configure()
|
|
44
|
+
|
|
45
|
+
assert os.environ[OTEL_TRACES_EXPORTER] == "console"
|
|
46
|
+
assert os.environ[OTEL_METRICS_EXPORTER] == "none"
|
|
47
|
+
assert os.environ[OTEL_LOGS_EXPORTER] == "none"
|
|
48
|
+
assert os.environ[OTEL_EXPORTER_OTLP_PROTOCOL] == "http/protobuf"
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"""Beacon distribution metadata and entry points."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from importlib.metadata import distribution
|
|
6
|
+
|
|
7
|
+
from beacon_otel import __version__
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def test_beacon_otel_distribution_identity() -> None:
|
|
11
|
+
package = distribution("beacon-otel")
|
|
12
|
+
assert package.metadata["Name"] == "beacon-otel"
|
|
13
|
+
assert package.version == __version__
|
|
14
|
+
for group, name in (
|
|
15
|
+
("console_scripts", "beacon"),
|
|
16
|
+
("opentelemetry_distro", "beacon"),
|
|
17
|
+
("opentelemetry_configurator", "beacon"),
|
|
18
|
+
):
|
|
19
|
+
assert any(
|
|
20
|
+
entry_point.group == group and entry_point.name == name
|
|
21
|
+
for entry_point in package.entry_points
|
|
22
|
+
)
|