Skip to content

Commit 0101233

Browse files
mattboddmattbodd
authored
Create new opentelemetry-jaeger-propagator library (#1487)
1 parent 433c1b3 commit 0101233

File tree

14 files changed

+1664
-534
lines changed

14 files changed

+1664
-534
lines changed

‎Cargo.toml

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ members = [
55
"opentelemetry-jaeger",
66
"opentelemetry-jaeger/examples/actix-udp",
77
"opentelemetry-jaeger/examples/remote-sampler",
8+
"opentelemetry-jaeger-propagator",
89
"opentelemetry-appender-log",
910
"opentelemetry-appender-tracing",
1011
"opentelemetry-otlp",

‎opentelemetry-jaeger-propagator/CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Changelog
2+
3+
## vNext
4+
5+
## v0.1.0
6+
7+
### Added
8+
9+
- As part of the gradual deprecation of the exporter functionality of the opentelemetry-jaeger crate, move the opentelemetry-jaeger propagator functionality to a new crate named opentelemetry-jaeger-propagator [#1487](https://github.com/open-telemetry/opentelemetry-rust/pull/1487)

‎opentelemetry-jaeger-propagator/Cargo.toml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
[package]
2+
name = "opentelemetry-jaeger-propagator"
3+
version = "0.1.0"
4+
description = "Jaeger propagator for OpenTelemetry"
5+
homepage = "https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-jaeger-propagator"
6+
repository = "https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-jaeger-propagator"
7+
readme = "README.md"
8+
categories = [
9+
"development-tools::debugging",
10+
"development-tools::profiling",
11+
"asynchronous",
12+
]
13+
keywords = ["opentelemetry", "jaeger", "propagator"]
14+
license = "Apache-2.0"
15+
edition = "2021"
16+
rust-version = "1.65"
17+
18+
19+
[package.metadata.docs.rs]
20+
all-features = true
21+
rustdoc-args = ["--cfg", "docsrs"]
22+
23+
[dependencies]
24+
opentelemetry = { version = "0.21", default-features = false, features = [
25+
"trace",
26+
], path = "../opentelemetry" }
27+
28+
tonic = { workspace = true, optional = true }
29+
prost = { version = "0.11.6", optional = true }
30+
prost-types = { version = "0.11.6", optional = true }
31+
32+
[dev-dependencies]
33+
opentelemetry_sdk = { features = ["testing"], path = "../opentelemetry-sdk" }
34+
35+
[features]
36+
default = []
37+
integration_test = []

‎opentelemetry-jaeger-propagator/LICENSE

+201
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 2023 The OpenTelemetry Authors
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.

‎opentelemetry-jaeger-propagator/README.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
![OpenTelemetry — An observability framework for cloud-native software.][splash]
2+
3+
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png
4+
5+
# OpenTelemetry Jaeger Propagator
6+
7+
[`Jaeger`] propagator integration for applications instrumented with [`OpenTelemetry`]. To export telemetry to Jaeger, use the opentelemetry-otlp crate.
8+
9+
[![Crates.io: opentelemetry-jaeger](https://img.shields.io/crates/v/opentelemetry-jaeger.svg)](https://crates.io/crates/opentelemetry-jaeger)
10+
[![Documentation](https://docs.rs/opentelemetry-jaeger/badge.svg)](https://docs.rs/opentelemetry-jaeger)
11+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-jaeger)](./LICENSE)
12+
[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amain)
13+
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
14+
15+
## Overview
16+
17+
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
18+
generate, collect, and export telemetry data (metrics, logs, and traces) for
19+
analysis in order to understand your software's performance and behavior. This
20+
crate provides the ability to create and interact with a Jaeger propagator.
21+
22+
*Compiler support: [requires `rustc` 1.64+][msrv]*
23+
24+
[`Jaeger`]: https://www.jaegertracing.io/
25+
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
26+
[msrv]: #supported-rust-versions
27+
28+
## Supported Rust Versions
29+
30+
OpenTelemetry is built against the latest stable release. The minimum supported
31+
version is 1.64. The current OpenTelemetry version is not guaranteed to build
32+
on Rust versions earlier than the minimum supported version.
33+
34+
The current stable Rust compiler and the three most recent minor versions
35+
before it will always be supported. For example, if the current stable compiler
36+
version is 1.49, the minimum supported version will not be increased past 1.46,
37+
three minor versions prior. Increasing the minimum supported compiler version
38+
is not considered a semver breaking change as long as doing so complies with
39+
this policy.

‎opentelemetry-jaeger-propagator/src/lib.rs

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
//! *Compiler support: [requires `rustc` 1.64+][msrv]*
2+
//!
3+
//! [Jaeger Docs]: https://www.jaegertracing.io/docs/
4+
//! [jaeger-deprecation]: https://github.com/open-telemetry/opentelemetry-specification/pull/2858/files
5+
//! [jaeger-otlp]: https://www.jaegertracing.io/docs/1.38/apis/#opentelemetry-protocol-stable
6+
//! [otlp-exporter]: https://docs.rs/opentelemetry-otlp/latest/opentelemetry_otlp/
7+
//! [msrv]: #supported-rust-versions
8+
//! [jaeger propagation format]: https://www.jaegertracing.io/docs/1.18/client-libraries/#propagation-format
9+
//!
10+
//! # Supported Rust Versions
11+
//!
12+
//! OpenTelemetry is built against the latest stable release. The minimum
13+
//! supported version is 1.64. The current OpenTelemetry version is not
14+
//! guaranteed to build on Rust versions earlier than the minimum supported
15+
//! version.
16+
//!
17+
//! The current stable Rust compiler and the three most recent minor versions
18+
//! before it will always be supported. For example, if the current stable
19+
//! compiler version is 1.64, the minimum supported version will not be
20+
//! increased past 1.46, three minor versions prior. Increasing the minimum
21+
//! supported compiler version is not considered a semver breaking change as
22+
//! long as doing so complies with this policy.
23+
#![warn(
24+
future_incompatible,
25+
missing_debug_implementations,
26+
missing_docs,
27+
nonstandard_style,
28+
rust_2018_idioms,
29+
unreachable_pub,
30+
unused
31+
)]
32+
#![cfg_attr(
33+
docsrs,
34+
feature(doc_cfg, doc_auto_cfg),
35+
deny(rustdoc::broken_intra_doc_links)
36+
)]
37+
#![doc(
38+
html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo.svg"
39+
)]
40+
#![cfg_attr(test, deny(warnings))]
41+
42+
/// The Jaeger propagator propagates span contexts in [Jaeger propagation format].
43+
///
44+
/// Cross-cutting concerns send their state to the next process using `Propagator`s,
45+
/// which are defined as objects used to read and write context data to and from messages
46+
/// exchanged by the applications. Each concern creates a set of `Propagator`s for every
47+
/// supported `Propagator` type.
48+
///
49+
/// Note that a jaeger header can be set in http header or encoded as url.
50+
///
51+
/// ## Examples
52+
/// ```
53+
/// # use opentelemetry::{global, trace::{Tracer, TraceContextExt}, Context};
54+
/// # use opentelemetry_jaeger_propagator::Propagator as JaegerPropagator;
55+
/// # fn send_request() {
56+
/// // setup jaeger propagator
57+
/// global::set_text_map_propagator(JaegerPropagator::default());
58+
/// // You also can init propagator with custom header name
59+
/// // global::set_text_map_propagator(JaegerPropagator::with_custom_header("my-custom-header"));
60+
///
61+
/// // before sending requests to downstream services.
62+
/// let mut headers = std::collections::HashMap::new(); // replace by http header of the outgoing request
63+
/// let caller_span = global::tracer("caller").start("say hello");
64+
/// let cx = Context::current_with_span(caller_span);
65+
/// global::get_text_map_propagator(|propagator| {
66+
/// propagator.inject_context(&cx, &mut headers); // propagator serialize the tracing context
67+
/// });
68+
/// // Send the request..
69+
/// # }
70+
///
71+
///
72+
/// # fn receive_request() {
73+
/// // Receive the request sent above on the other service...
74+
/// // setup jaeger propagator
75+
/// global::set_text_map_propagator(JaegerPropagator::new());
76+
/// // You also can init propagator with custom header name
77+
/// // global::set_text_map_propagator(JaegerPropagator::with_custom_header("my-custom-header"));
78+
///
79+
/// let headers = std::collections::HashMap::new(); // replace this with http header map from incoming requests.
80+
/// let parent_context = global::get_text_map_propagator(|propagator| {
81+
/// propagator.extract(&headers)
82+
/// });
83+
///
84+
/// // this span's parent span will be caller_span in send_request functions.
85+
/// let receiver_span = global::tracer("receiver").start_with_context("hello", &parent_context);
86+
/// # }
87+
/// ```
88+
///
89+
/// [jaeger propagation format]: https://www.jaegertracing.io/docs/1.18/client-libraries/#propagation-format
90+
pub mod propagator;
91+
#[cfg(feature = "integration_test")]
92+
#[doc(hidden)]
93+
pub mod testing;
94+
95+
pub use propagator::Propagator;

0 commit comments

Comments
 (0)