Skip to content

Commit dacd75a

Browse files
jtescherjtescher
authored
Split out opentelemetry-api and opentelemetry-sdk (open-telemetry#735)
* Split out `opentelemetry` crate into api and sdk crates, and re-export to maintain existing compatibility. * Move `util` module to sdk as it was internal and not documented publicly. * Remove api doc tests for now that relied on the sdk. * Switch default text map propagator to be a noop (allowed by the [spec](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/context/api-propagators.md#global-propagators)) * Move `ExportError` and `InstrumentationLibrary` to API. * Move `SamplingResult` and `SamplingDecision` to trace API.
1 parent e108b1e commit dacd75a

File tree

115 files changed

+1525
-1007
lines changed

Some content is hidden

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

115 files changed

+1525
-1007
lines changed

‎.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ jobs:
7272
override: true
7373
- name: Run tests
7474
run: cargo --version &&
75-
cargo test --verbose --manifest-path=opentelemetry/Cargo.toml --features trace,metrics,serialize,rt-tokio,serde,testing &&
75+
cargo test --verbose --manifest-path=opentelemetry/Cargo.toml --features trace,metrics,serialize,rt-tokio,testing &&
7676
cargo test --manifest-path=opentelemetry-jaeger/Cargo.toml --features rt-tokio &&
7777
cargo test --manifest-path=opentelemetry-zipkin/Cargo.toml
7878
cargo-deny:

‎Cargo.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
[workspace]
22
members = [
33
"opentelemetry",
4+
"opentelemetry-api",
5+
"opentelemetry-aws",
46
"opentelemetry-contrib",
57
"opentelemetry-datadog",
68
"opentelemetry-dynatrace",
79
"opentelemetry-http",
810
"opentelemetry-jaeger",
911
"opentelemetry-otlp",
10-
"opentelemetry-proto",
1112
"opentelemetry-prometheus",
12-
"opentelemetry-aws",
13+
"opentelemetry-proto",
14+
"opentelemetry-sdk",
1315
"opentelemetry-semantic-conventions",
1416
"opentelemetry-stackdriver",
1517
"opentelemetry-zipkin",

‎examples/basic-otlp-with-selector/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ fn init_tracer() -> Result<sdktrace::Tracer, TraceError> {
3232

3333
// Skip first immediate tick from tokio, not needed for async_std.
3434
fn delayed_interval(duration: Duration) -> impl Stream<Item = tokio::time::Instant> {
35-
opentelemetry::util::tokio_interval_stream(duration).skip(1)
35+
opentelemetry::sdk::util::tokio_interval_stream(duration).skip(1)
3636
}
3737

3838
#[derive(Debug)]

‎examples/basic-otlp/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ fn init_tracer() -> Result<sdktrace::Tracer, TraceError> {
2626

2727
// Skip first immediate tick from tokio, not needed for async_std.
2828
fn delayed_interval(duration: Duration) -> impl Stream<Item = tokio::time::Instant> {
29-
opentelemetry::util::tokio_interval_stream(duration).skip(1)
29+
opentelemetry::sdk::util::tokio_interval_stream(duration).skip(1)
3030
}
3131

3232
fn init_meter() -> metrics::Result<PushController> {

‎examples/basic/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ fn init_tracer() -> Result<sdktrace::Tracer, TraceError> {
2525

2626
// Skip first immediate tick from tokio, not needed for async_std.
2727
fn delayed_interval(duration: Duration) -> impl Stream<Item = tokio::time::Instant> {
28-
opentelemetry::util::tokio_interval_stream(duration).skip(1)
28+
opentelemetry::sdk::util::tokio_interval_stream(duration).skip(1)
2929
}
3030

3131
fn init_meter() -> PushController {

‎examples/dynatrace/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ fn init_tracer() -> Result<sdktrace::Tracer, TraceError> {
5252

5353
// Skip first immediate tick from tokio, not needed for async_std.
5454
fn delayed_interval(duration: Duration) -> impl Stream<Item = tokio::time::Instant> {
55-
opentelemetry::util::tokio_interval_stream(duration).skip(1)
55+
opentelemetry::sdk::util::tokio_interval_stream(duration).skip(1)
5656
}
5757

5858
fn init_meter() -> metrics::Result<PushController> {

‎opentelemetry-api/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
## v0.1.0
4+
5+
- API split from `opentelemetry` crate

‎opentelemetry-api/CODEOWNERS

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Code owners file.
2+
# This file controls who is tagged for review for any given pull request.
3+
4+
# For anything not explicitly taken by someone else:
5+
* @open-telemetry/rust-approvers

‎opentelemetry-api/Cargo.toml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[package]
2+
name = "opentelemetry-api"
3+
version = "0.1.0"
4+
edition = "2018"
5+
6+
[dependencies]
7+
fnv = { version = "1.0", optional = true }
8+
futures-channel = "0.3"
9+
futures-util = { version = "0.3", default-features = false, features = ["std", "sink"] }
10+
lazy_static = "1.4"
11+
pin-project = { version = "1.0.2", optional = true }
12+
serde = { version = "1.0", features = ["derive", "rc"], optional = true }
13+
thiserror = "1"
14+
tokio-stream = { version = "0.1", optional = true }
15+
16+
[package.metadata.docs.rs]
17+
all-features = true
18+
rustdoc-args = ["--cfg", "docsrs"]
19+
20+
[target.'cfg(target_arch = "wasm32")'.dependencies]
21+
js-sys = "0.3"
22+
23+
[features]
24+
default = ["trace"]
25+
trace = ["pin-project"]
26+
metrics = ["fnv"]
27+
serialize = ["serde"]
28+
testing = ["trace"]

‎opentelemetry-api/LICENSE

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.

‎opentelemetry-api/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
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 Rust API
6+
7+
The Rust [OpenTelemetry](https://opentelemetry.io/) implementation.
8+
9+
[![Crates.io: opentelemetry-api](https://img.shields.io/crates/v/opentelemetry-api.svg)](https://crates.io/crates/opentelemetry-api)
10+
[![Documentation](https://docs.rs/opentelemetry-api/badge.svg)](https://docs.rs/opentelemetry-api)
11+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-api)](./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+
[![codecov](https://codecov.io/gh/open-telemetry/opentelemetry-rust/branch/main/graph/badge.svg)](https://codecov.io/gh/open-telemetry/opentelemetry-rust)
14+
[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/open-telemetry/opentelemetry-rust)
15+
16+
[Website](https://opentelemetry.io/) |
17+
[Chat](https://gitter.im/open-telemetry/opentelemetry-rust) |
18+
[Documentation](https://docs.rs/opentelemetry)
19+
20+
## Overview
21+
22+
OpenTelemetry is a collection of tools, APIs, and SDKs used to instrument,
23+
generate, collect, and export telemetry data (metrics, logs, and traces) for
24+
analysis in order to understand your software's performance and behavior. You
25+
can export and analyze them using [Prometheus], [Jaeger], and other
26+
observability tools.
27+
28+
*Compiler support: [requires `rustc` 1.46+][msrv]*
29+
30+
[Prometheus]: https://prometheus.io
31+
[Jaeger]: https://www.jaegertracing.io
32+
[msrv]: #supported-rust-versions

‎opentelemetry/src/attributes/encoder.rs renamed to ‎opentelemetry-api/src/attributes/encoder.rs

File renamed without changes.

‎opentelemetry/src/attributes/mod.rs renamed to ‎opentelemetry-api/src/attributes/mod.rs

File renamed without changes.

0 commit comments

Comments
 (0)