Skip to content

Commit f92431e

Browse files
author
alrex
authored
split jaeger exporter for proto/thrift (#1694)
1 parent c61a712 commit f92431e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+1210
-261
lines changed

.flake8

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ exclude =
1616
venv*/
1717
target
1818
__pycache__
19-
exporter/opentelemetry-exporter-jaeger/src/opentelemetry/exporter/jaeger/gen/
20-
exporter/opentelemetry-exporter-jaeger/build/*
19+
exporter/opentelemetry-exporter-jaeger-proto/src/opentelemetry/exporter/jaeger/proto/gen/
20+
exporter/opentelemetry-exporter-jaeger-proto/build/*
21+
exporter/opentelemetry-exporter-jaeger-thrift/src/opentelemetry/exporter/jaeger/thrift/gen/
22+
exporter/opentelemetry-exporter-jaeger-thrift/build/*
2123
exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/encoder/v2/protobuf/gen/
2224
docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/grpc/gen/
2325
docs/examples/opentelemetry-example-app/build/*

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5959
([#1680](https://github.com/open-telemetry/opentelemetry-python/pull/1680))
6060
- Change Zipkin exporter to obtain service.name from span
6161
([#1696](https://github.com/open-telemetry/opentelemetry-python/pull/1696))
62+
- Split up `opentelemetry-exporter-jaeger` package into `opentelemetry-exporter-jaeger-proto` and
63+
`opentelemetry-exporter-jaeger-thrift` packages to reduce dependencies for each one.
64+
([#1694](https://github.com/open-telemetry/opentelemetry-python/pull/1694))
6265

6366
### Removed
6467
- Removed unused `get_hexadecimal_trace_id` and `get_hexadecimal_span_id` methods.

docs/examples/opentracing/main.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from rediscache import RedisCache
44

55
from opentelemetry import trace
6-
from opentelemetry.exporter.jaeger import JaegerExporter
6+
from opentelemetry.exporter.jaeger.thrift import JaegerExporter
77
from opentelemetry.sdk.trace import TracerProvider
88
from opentelemetry.sdk.trace.export import SimpleSpanProcessor
99
from opentelemetry.shim import opentracing_shim
@@ -13,11 +13,7 @@
1313
tracer_provider = trace.get_tracer_provider()
1414

1515
# Configure the tracer to export traces to Jaeger
16-
jaeger_exporter = JaegerExporter(
17-
service_name="OpenTracing Shim Example",
18-
agent_host_name="localhost",
19-
agent_port=6831,
20-
)
16+
jaeger_exporter = JaegerExporter(agent_host_name="localhost", agent_port=6831,)
2117
span_processor = SimpleSpanProcessor(jaeger_exporter)
2218
tracer_provider.add_span_processor(span_processor)
2319

docs/exporter/jaeger/jaeger.rst

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,35 @@
1-
Opentelemetry Jaeger Exporter
2-
=============================
1+
Opentelemetry Jaeger Exporters
2+
==============================
33

44
.. automodule:: opentelemetry.exporter.jaeger
55
:members:
66
:undoc-members:
77
:show-inheritance:
88

9+
.. automodule:: opentelemetry.exporter.jaeger.thrift
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:
13+
14+
.. automodule:: opentelemetry.exporter.jaeger.proto
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
918

1019
Submodules
1120
----------
1221

13-
.. automodule:: opentelemetry.exporter.jaeger.gen.jaeger.ttypes
22+
.. automodule:: opentelemetry.exporter.jaeger.thrift.gen.jaeger.ttypes
1423
:members:
1524
:undoc-members:
1625
:show-inheritance:
1726

18-
.. automodule:: opentelemetry.exporter.jaeger.send.thrift
27+
.. automodule:: opentelemetry.exporter.jaeger.thrift.send
1928
:members:
2029
:undoc-members:
2130
:show-inheritance:
2231

23-
.. automodule:: opentelemetry.exporter.jaeger.gen.collector_pb2_grpc
32+
.. automodule:: opentelemetry.exporter.jaeger.proto.gen.collector_pb2_grpc
2433
:members:
2534
:undoc-members:
2635
:show-inheritance:

docs/getting_started/jaeger_example.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
# jaeger_example.py
1616
from opentelemetry import trace
17-
from opentelemetry.exporter import jaeger
17+
from opentelemetry.exporter.jaeger.thrift import JaegerExporter
1818
from opentelemetry.sdk.resources import SERVICE_NAME, Resource
1919
from opentelemetry.sdk.trace import TracerProvider
2020
from opentelemetry.sdk.trace.export import BatchSpanProcessor
@@ -25,9 +25,7 @@
2525
)
2626
)
2727

28-
jaeger_exporter = jaeger.JaegerExporter(
29-
agent_host_name="localhost", agent_port=6831,
30-
)
28+
jaeger_exporter = JaegerExporter(agent_host_name="localhost", agent_port=6831,)
3129

3230
trace.get_tracer_provider().add_span_processor(
3331
BatchSpanProcessor(jaeger_exporter)
Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
graft src
2+
graft tests
3+
global-exclude *.pyc
4+
global-exclude *.pyo
5+
global-exclude __pycache__/*
6+
include CHANGELOG.md
7+
include MANIFEST.in
8+
include README.rst
9+
include LICENSE
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
OpenTelemetry Jaeger Protobuf Exporter
2+
======================================
3+
4+
|pypi|
5+
6+
.. |pypi| image:: https://badge.fury.io/py/opentelemetry-exporter-jaeger-proto.svg
7+
:target: https://pypi.org/project/opentelemetry-exporter-jaeger-proto/
8+
9+
This library allows to export tracing data to `Jaeger <https://www.jaegertracing.io/>`_.
10+
11+
Installation
12+
------------
13+
14+
::
15+
16+
pip install opentelemetry-exporter-jaeger-proto
17+
18+
19+
.. _Jaeger: https://www.jaegertracing.io/
20+
.. _OpenTelemetry: https://github.com/open-telemetry/opentelemetry-python/
21+
22+
Configuration
23+
-------------
24+
25+
OpenTelemetry Jaeger Exporter can be configured by setting `JaegerExporter parameters
26+
<https://github.com/open-telemetry/opentelemetry-python/blob/main/exporter/opentelemetry-exporter-jaeger-proto
27+
/src/opentelemetry/exporter/jaeger/proto/__init__.py#L88>`_ or by setting
28+
`environment variables <https://github.com/open-telemetry/opentelemetry-specification/blob/main/
29+
specification/sdk-environment-variables.md#jaeger-exporter>`_
30+
31+
References
32+
----------
33+
34+
* `OpenTelemetry Jaeger Exporter <https://opentelemetry-python.readthedocs.io/en/latest/exporter/jaeger/jaeger.html>`_
35+
* `Jaeger <https://www.jaegertracing.io/>`_
36+
* `OpenTelemetry Project <https://opentelemetry.io/>`_

exporter/opentelemetry-exporter-jaeger/examples/jaeger_exporter_example.py renamed to exporter/opentelemetry-exporter-jaeger-proto/examples/jaeger_exporter_example.py

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,22 @@
11
import time
22

33
from opentelemetry import trace
4-
from opentelemetry.exporter import jaeger
4+
from opentelemetry.exporter.jaeger import proto
55
from opentelemetry.sdk.trace import TracerProvider
66
from opentelemetry.sdk.trace.export import BatchSpanProcessor
77

88
trace.set_tracer_provider(TracerProvider())
99
tracer = trace.get_tracer(__name__)
1010

11-
# create a JaegerExporter
12-
jaeger_exporter = jaeger.JaegerExporter(
13-
# configure agent
14-
agent_host_name="localhost",
15-
agent_port=6831,
16-
# optional: configure also collector
17-
# collector_host_name="localhost",
18-
# collector_port=14268,
19-
# collector_endpoint="/api/traces?format=jaeger.thrift",
20-
# username=xxxx, # optional
21-
# password=xxxx, # optional
22-
)
23-
2411
# Create a JaegerExporter to send spans with gRPC
2512
# If there is no encryption or authentication set `insecure` to True
2613
# If server has authentication with SSL/TLS you can set the
2714
# parameter credentials=ChannelCredentials(...) or the environment variable
2815
# `EXPORTER_JAEGER_CERTIFICATE` with file containing creds.
2916

30-
# jaeger_exporter = jaeger.JaegerExporter(
31-
# collector_endpoint="localhost:14250",
32-
# insecure=True,
33-
# transport_format="protobuf",
34-
# )
17+
jaeger_exporter = proto.JaegerExporter(
18+
collector_endpoint="localhost:14250", insecure=True,
19+
)
3520

3621
# create a BatchSpanProcessor and add the exporter to it
3722
span_processor = BatchSpanProcessor(jaeger_exporter)
File renamed without changes.

0 commit comments

Comments
 (0)