Skip to content

Automate enable/disable functionality for user-events benchmarks #370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Automate enable/disable functionality for user-events benchmarks #370

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
03aca51
Initial plan
Copilot Jul 11, 2025
b6dc2aa
Implement automatic enable/disable functionality for user-events benc…
Copilot Jul 11, 2025
06fb3cb
Remove fallback tests functionality from user-events benchmarks
Copilot Jul 11, 2025
f563588
Refactor benchmarks to use Criterion groups and eliminate code duplic…
Copilot Jul 11, 2025
bd2f62e
Refactor benchmark to use idiomatic Criterion patterns and eliminate …
Copilot Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
207 changes: 165 additions & 42 deletions opentelemetry-user-events-logs/benches/logs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,30 @@
The benchmark results:
criterion = "0.5.1"

Hardware: Apple M4 Pro
Total Number of Cores: 10
(Inside multipass vm running Ubuntu 22.04)
// When no listener
| Test | Average time|
|-----------------------------|-------------|
| User_Event_4_Attributes | 8 ns |
| User_Event_6_Attributes | 8 ns |

// When listener is enabled
// Run below to enable
// echo 1 | sudo tee /sys/kernel/debug/tracing/events/user_events/myprovider_L2K1/enable
// Run below to disable
// echo 0 | sudo tee /sys/kernel/debug/tracing/events/user_events/myprovider_L2K1/enable
| Test | Average time|
|-----------------------------|-------------|
| User_Event_4_Attributes | 530 ns |
| User_Event_6_Attributes | 586 ns |
Hardware: <Hardware specifications>
Total Number of Cores: <number>
(Environment details)

// When no listener (automatically set by benchmark)
| Test | Average time |
|-----------------------------------|--------------|
| User_Event_4_Attributes_Disabled | X ns |
| User_Event_6_Attributes_Disabled | X ns |

// When listener is enabled (automatically set by benchmark)
| Test | Average time |
|-----------------------------------|--------------|
| User_Event_4_Attributes_Enabled | X ns |
| User_Event_6_Attributes_Enabled | X ns |

// Fallback tests (when user_events is not available)
| Test | Average time |
|-----------------------------|--------------|
| User_Event_4_Attributes | X ns |
| User_Event_6_Attributes | X ns |

Note: The benchmark now automatically enables and disables the user-events listener.
If user_events is not available on the system, it falls back to the original test names.
*/

// running the following from the current directory
Expand All @@ -30,10 +36,51 @@ use opentelemetry_appender_tracing::layer as tracing_layer;
use opentelemetry_sdk::logs::SdkLoggerProvider;
use opentelemetry_sdk::Resource;
use opentelemetry_user_events_logs::Processor;
use std::fs;
use std::io::Write;
use std::process::Command;
use tracing::error;
use tracing_subscriber::prelude::*;
use tracing_subscriber::Registry;

/// Attempts to enable or disable the user_events listener
/// Returns true if the operation was successful, false otherwise
fn set_user_events_listener(enabled: bool) -> bool {
let enable_path = "/sys/kernel/debug/tracing/events/user_events/myprovider_L2K1/enable";
let value = if enabled { "1" } else { "0" };

// First try direct write (if we have permissions)
if let Ok(mut file) = fs::OpenOptions::new().write(true).open(enable_path) {
if file.write_all(value.as_bytes()).is_ok() {
return true;
}
}

// Fallback to using sudo with echo command
let output = Command::new("sudo")
.args(["tee", enable_path])
.stdin(std::process::Stdio::piped())
.stdout(std::process::Stdio::null())
.stderr(std::process::Stdio::null())
.spawn()
.and_then(|mut child| {
if let Some(stdin) = child.stdin.as_mut() {
stdin.write_all(value.as_bytes()).ok();
}
child.wait()
});

match output {
Ok(status) => status.success(),
Err(_) => false,
}
}

/// Checks if user_events is available on the system
fn is_user_events_available() -> bool {
fs::metadata("/sys/kernel/debug/tracing/events/user_events/myprovider_L2K1/enable").is_ok()
}

fn setup_provider() -> SdkLoggerProvider {
let user_event_processor = Processor::builder("myprovider").build().unwrap();
SdkLoggerProvider::builder()
Expand All @@ -52,18 +99,54 @@ fn benchmark_4_attributes(c: &mut Criterion) {
let subscriber = Registry::default().with(ot_layer);

tracing::subscriber::with_default(subscriber, || {
c.bench_function("User_Event_4_Attributes", |b| {
b.iter(|| {
error!(
name : "CheckoutFailed",
field1 = "field1",
field2 = "field2",
field3 = "field3",
field4 = "field4",
message = "Unable to process checkout."
);
// Test with listener disabled
if is_user_events_available() {
set_user_events_listener(false);
c.bench_function("User_Event_4_Attributes_Disabled", |b| {
b.iter(|| {
error!(
name : "CheckoutFailed",
field1 = "field1",
field2 = "field2",
field3 = "field3",
field4 = "field4",
message = "Unable to process checkout."
);
});
});
});

// Test with listener enabled
set_user_events_listener(true);
c.bench_function("User_Event_4_Attributes_Enabled", |b| {
b.iter(|| {
error!(
name : "CheckoutFailed",
field1 = "field1",
field2 = "field2",
field3 = "field3",
field4 = "field4",
message = "Unable to process checkout."
);
});
});

// Cleanup: disable listener
set_user_events_listener(false);
} else {
// Fallback for systems without user_events support
c.bench_function("User_Event_4_Attributes", |b| {
b.iter(|| {
error!(
name : "CheckoutFailed",
field1 = "field1",
field2 = "field2",
field3 = "field3",
field4 = "field4",
message = "Unable to process checkout."
);
});
});
}
});
}

Expand All @@ -73,20 +156,60 @@ fn benchmark_6_attributes(c: &mut Criterion) {
let subscriber = Registry::default().with(ot_layer);

tracing::subscriber::with_default(subscriber, || {
c.bench_function("User_Event_6_Attributes", |b| {
b.iter(|| {
error!(
name : "CheckoutFailed",
field1 = "field1",
field2 = "field2",
field3 = "field3",
field4 = "field4",
field5 = "field5",
field6 = "field6",
message = "Unable to process checkout."
);
// Test with listener disabled
if is_user_events_available() {
set_user_events_listener(false);
c.bench_function("User_Event_6_Attributes_Disabled", |b| {
b.iter(|| {
error!(
name : "CheckoutFailed",
field1 = "field1",
field2 = "field2",
field3 = "field3",
field4 = "field4",
field5 = "field5",
field6 = "field6",
message = "Unable to process checkout."
);
});
});
});

// Test with listener enabled
set_user_events_listener(true);
c.bench_function("User_Event_6_Attributes_Enabled", |b| {
b.iter(|| {
error!(
name : "CheckoutFailed",
field1 = "field1",
field2 = "field2",
field3 = "field3",
field4 = "field4",
field5 = "field5",
field6 = "field6",
message = "Unable to process checkout."
);
});
});

// Cleanup: disable listener
set_user_events_listener(false);
} else {
// Fallback for systems without user_events support
c.bench_function("User_Event_6_Attributes", |b| {
b.iter(|| {
error!(
name : "CheckoutFailed",
field1 = "field1",
field2 = "field2",
field3 = "field3",
field4 = "field4",
field5 = "field5",
field6 = "field6",
message = "Unable to process checkout."
);
});
});
}
});
}

Expand Down