Skip to content

Commit 4646796

Browse files
lalitblalitb
authored
feat: [user_events] Linux user_events span exporter (#203)
1 parent 2e7ac4b commit 4646796

File tree

10 files changed

+649
-0
lines changed

10 files changed

+649
-0
lines changed

‎opentelemetry-user-events-trace/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
## vNext
4+
5+
### Added
6+
7+
- Initial Alpha implementation

‎opentelemetry-user-events-trace/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-user-events-trace/Cargo.toml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[package]
2+
name = "opentelemetry-user-events-trace"
3+
description = "OpenTelemetry-Rust exporter to user_events"
4+
version = "0.10.0"
5+
edition = "2021"
6+
homepage = "https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/opentelemetry-user-events-traces"
7+
repository = "https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/opentelemetry-user-events-traces"
8+
readme = "README.md"
9+
rust-version = "1.75.0"
10+
keywords = ["opentelemetry", "log", "trace", "user_events"]
11+
license = "Apache-2.0"
12+
13+
[dependencies]
14+
eventheader = "0.4.0"
15+
eventheader_dynamic = "0.4.0"
16+
opentelemetry = { workspace = true, features = ["trace"] }
17+
opentelemetry_sdk = { workspace = true, features = ["trace"] }
18+
chrono = { version = "0.4", default-features = false, features = ["std"] }
19+
tracing = { version = "0.1", optional = true }
20+
futures-executor = "0.3"
21+
futures-util = "0.3"
22+
23+
[dev-dependencies]
24+
opentelemetry_sdk = { workspace = true, features = ["trace"]}
25+
tracing = { version = "0.1", default-features = false, features = ["std"] }
26+
tracing-core = "0.1.31"
27+
tracing-subscriber = { version = "0.3.0", default-features = false, features = ["env-filter", "fmt", "registry", "std"] }
28+
ctrlc = "3.4"
29+
criterion = "0.5"
30+
serde_json = "1.0.140"
31+
32+
[features]
33+
internal-logs = ["tracing", "opentelemetry/internal-logs", "opentelemetry_sdk/internal-logs"]
34+
default = ["internal-logs"]
35+
36+
[lints]
37+
workspace = true
38+
39+
# machete seems to failing for tracing which is optional dependency and enabled by default.
40+
# So, ignoring it for now.
41+
[package.metadata.cargo-machete]
42+
ignored = ["tracing"]

‎opentelemetry-user-events-trace/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-user-events-trace/README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# OpenTelemetry Span Exporter for Linux user_events
2+
3+
![OpenTelemetry — An observability framework for cloud-native software.][splash]
4+
5+
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png
6+
7+
| Status | |
8+
| ------------- |-----------|
9+
| Stability | alpha |
10+
| Owners | [Cijo Thomas](https://github.com/cijothomas), [Lalit Kumar Bhasin](https://github.com/lalitb) |
11+
12+
This crate contains a Span Exporter to export spans to Linux
13+
[user_events](https://docs.kernel.org/trace/user_events.html), which is a
14+
solution for user process tracing, similar to ETW (Event Tracing for Windows) on
15+
Windows. It builds on top of the Linux Tracepoints, and so allows user processes
16+
to create events and trace data that can be viewed via existing tools like
17+
ftrace and perf.
18+
19+
This kernel feature is supported started in Linux kernel 6.4 onwards. The feature enables
20+
21+
- A faster path for tracing from user mode application utilizing kernel mode memory address space.
22+
- User processes can now export telemetry events only when it is useful i.e, when the registered set of tracepoint events are enabled.
23+
24+
This user_events exporter enables applications to use OpenTelemetry API to capture the telemetry events, and write to user_events subsystem. From user_events, the events can be
25+
26+
- Captured by the agents running locally, and listening for specific events withing user_events subsystem.
27+
- Or real-time monitoring using local Linux tool like [perf](https://perf.wiki.kernel.org/index.php/Main_Page) or ftrace.
28+
29+
[![Crates.io: opentelemetry-user-events-trace](https://img.shields.io/crates/v/opentelemetry-user-events-trace.svg)](https://crates.io/crates/opentelemetry-user-events-trace)
30+
[![Documentation](https://docs.rs/opentelemetry-user-events-trace/badge.svg)](https://docs.rs/opentelemetry-user-events-trace)
31+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-user-events-trace)](./LICENSE)
32+
[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust-contrib/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust-contrib/actions?query=workflow%3ACI+branch%3Amain)
33+
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
34+
35+
## OpenTelemetry Overview
36+
37+
OpenTelemetry is an Observability framework and toolkit designed to create and
38+
manage telemetry data such as traces, metrics, and logs. OpenTelemetry is
39+
vendor- and tool-agnostic, meaning that it can be used with a broad variety of
40+
Observability backends, including open source tools like [Jaeger] and
41+
[Prometheus], as well as commercial offerings.
42+
43+
OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other
44+
commercial vendors. OpenTelemetry is focused on the generation, collection,
45+
management, and export of telemetry. A major goal of OpenTelemetry is that you
46+
can easily instrument your applications or systems, no matter their language,
47+
infrastructure, or runtime environment. Crucially, the storage and visualization
48+
of telemetry is intentionally left to other tools.

‎opentelemetry-user-events-trace/examples/basic-trace.rs

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
//! run with `$ cargo run --example basic-trace`
2+
//! to listen for events, as root:
3+
//! $perf record -e user_events:myprovider_L4K1
4+
5+
use opentelemetry::global;
6+
use opentelemetry::trace::Span;
7+
use opentelemetry::trace::Tracer;
8+
use opentelemetry_sdk::trace::SdkTracerProvider;
9+
use opentelemetry_user_events_trace::UserEventsTracerProviderBuilderExt;
10+
use std::sync::atomic::{AtomicBool, Ordering};
11+
use std::sync::Arc;
12+
use std::{thread, time::Duration};
13+
14+
use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt, EnvFilter, Layer};
15+
16+
fn init_tracer() -> SdkTracerProvider {
17+
let provider = SdkTracerProvider::builder()
18+
.with_user_event_exporter("myprovider")
19+
.build();
20+
global::set_tracer_provider(provider.clone());
21+
provider
22+
}
23+
24+
fn main() {
25+
let filter_fmt = EnvFilter::new("info").add_directive("opentelemetry=debug".parse().unwrap());
26+
let fmt_layer = tracing_subscriber::fmt::layer().with_filter(filter_fmt);
27+
tracing_subscriber::registry().with(fmt_layer).init();
28+
let tracer_provider = init_tracer();
29+
let tracer = global::tracer("user-events-tracer");
30+
// run in a loop to ensure that tracepoints are not removed from kernel fs
31+
32+
let running = Arc::new(AtomicBool::new(true));
33+
let r = running.clone();
34+
35+
ctrlc::set_handler(move || {
36+
r.store(false, Ordering::SeqCst);
37+
})
38+
.expect("Error setting Ctrl-C handler");
39+
40+
while running.load(Ordering::SeqCst) {
41+
let mut span = tracer
42+
.span_builder("my-event-name")
43+
.with_attributes([opentelemetry::KeyValue::new("my-key", "my-value")])
44+
.start(&tracer);
45+
span.end();
46+
thread::sleep(Duration::from_secs(1));
47+
}
48+
49+
let status = tracer_provider.shutdown();
50+
if let Err(e) = status {
51+
println!("Error shutting down: {:?}", e);
52+
}
53+
}

‎opentelemetry-user-events-trace/src/lib.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
//! The user_events exporter will enable applications to use OpenTelemetry API
2+
//! to capture the telemetry events, and write to user_events subsystem.
3+
4+
#![warn(missing_debug_implementations, missing_docs)]
5+
6+
mod trace;
7+
8+
pub use trace::*;

0 commit comments

Comments
 (0)