Skip to content
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

feature: refactor and extend log_exporter benchmark #2143

Closed
wants to merge 6 commits into from
Closed

feature: refactor and extend log_exporter benchmark #2143

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
abbd9f5
feature: refactor and extend `log_exporter` benchmark
demurgos Sep 24, 2024
673bf2e
Merge branch 'main' into feature/bench-log-exporter-native-async
cijothomas Sep 30, 2024
c8281ff
Merge branch 'main' into feature/bench-log-exporter-native-async
cijothomas Oct 2, 2024
1a0575e
Merge branch 'main' into feature/bench-log-exporter-native-async
cijothomas Oct 3, 2024
031a52c
Merge branch 'main' into feature/bench-log-exporter-native-async
cijothomas Oct 4, 2024
de4ee51
Merge branch 'main' into feature/bench-log-exporter-native-async
cijothomas Oct 8, 2024
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
303 changes: 197 additions & 106 deletions opentelemetry-sdk/benches/log_exporter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,28 @@
/*
The benchmark results:
criterion = "0.5.1"
OS: Ubuntu 22.04.3 LTS (5.15.146.1-microsoft-standard-WSL2)
Hardware: AMD EPYC 7763 64-Core Processor - 2.44 GHz, 16vCPUs,
RAM: 64.0 GB
| Test | Average time|
|--------------------------------|-------------|
| LogExporterWithFuture | 111 ns |
| LogExporterWithoutFuture | 92 ns |
*/
//! Benchmark different definition styles for the `LogExporter` trait.
//!
//! Run this benchmark with the following command:
//! ```sh
//! cargo bench --bench log_exporter
//! ```
//!
//! Example benchmark results:
//! - date: 2024-09-24
//! - OS: Linux 6.10.10 x86_64 (Arch Linux)
//! - CPU: AMD Ryzen 9 7950X
//! - RAM: 64 GiB
//! ```text
//! LogExporterAsyncTrait time: [60.918 ns 61.146 ns 61.404 ns]
//! LogExporterAsyncNative time: [51.846 ns 51.905 ns 51.979 ns]
//! LogExporterSync time: [50.197 ns 50.332 ns 50.472 ns]
//! ```

use std::sync::Mutex;
use std::time::SystemTime;

use async_trait::async_trait;
use criterion::{criterion_group, criterion_main, Criterion};

use opentelemetry::logs::{LogRecord as _, LogResult, Logger as _, LoggerProvider as _, Severity};
use opentelemetry::logs::{LogRecord as _, LogResult, Logger, LoggerProvider as _, Severity};

use opentelemetry::InstrumentationLibrary;
use opentelemetry_sdk::export::logs::LogBatch;
Expand All @@ -25,147 +31,232 @@ use opentelemetry_sdk::logs::LogRecord;
use opentelemetry_sdk::logs::LoggerProvider;
use pprof::criterion::{Output, PProfProfiler};
use std::fmt::Debug;
use std::hint::black_box;

// Run this benchmark with:
// cargo bench --bench log_exporter
#[async_trait]
pub trait LogExporterWithFuture: Send + Sync + Debug {
async fn export(&mut self, batch: LogBatch<'_>);
}
mod style_async_trait {
use super::*;

pub trait LogExporterWithoutFuture: Send + Sync + Debug {
fn export(&mut self, batch: LogBatch<'_>);
}
/// Async style using the `async_trait` crate
#[async_trait]
pub trait LogExporterAsyncTrait: Send + Sync + Debug {
async fn export(&mut self, batch: LogBatch<'_>);
}

#[derive(Debug)]
struct NoOpExporterWithFuture {}
#[derive(Debug)]
pub struct NoOpExporterAsyncTrait;

#[async_trait]
impl LogExporterWithFuture for NoOpExporterWithFuture {
async fn export(&mut self, _batch: LogBatch<'_>) {}
}
#[async_trait]
impl LogExporterAsyncTrait for NoOpExporterAsyncTrait {
async fn export(&mut self, batch: LogBatch<'_>) {
// As of writing this benchmark, the `rust-version` is `1.65`, but
// this benchmark relies on native async trait support from `1.75`
// so we may as well use the `black_box` hint from `1.66`. Benchmark
// are expected to be executed with a recent Rust toolchain anyway.
#[allow(clippy::incompatible_msrv)]
black_box(batch);
}
}

#[derive(Debug)]
struct NoOpExporterWithoutFuture {}
impl LogExporterWithoutFuture for NoOpExporterWithoutFuture {
fn export(&mut self, _batch: LogBatch<'_>) {}
}
#[derive(Debug)]
pub struct ExportingProcessorAsyncTrait {
exporter: Mutex<NoOpExporterAsyncTrait>,
}

#[derive(Debug)]
struct ExportingProcessorWithFuture {
exporter: Mutex<NoOpExporterWithFuture>,
}
impl ExportingProcessorAsyncTrait {
pub fn new(exporter: NoOpExporterAsyncTrait) -> Self {
Self {
exporter: Mutex::new(exporter),
}
}
}

impl LogProcessor for ExportingProcessorAsyncTrait {
fn emit(&self, record: &mut LogRecord, library: &InstrumentationLibrary) {
let mut exporter = self.exporter.lock().expect("lock error");
let logs = [(record as &LogRecord, library)];
futures_executor::block_on(exporter.export(LogBatch::new(&logs)));
}

impl ExportingProcessorWithFuture {
fn new(exporter: NoOpExporterWithFuture) -> Self {
ExportingProcessorWithFuture {
exporter: Mutex::new(exporter),
fn force_flush(&self) -> LogResult<()> {
Ok(())
}

fn shutdown(&self) -> LogResult<()> {
Ok(())
}
}
}

impl LogProcessor for ExportingProcessorWithFuture {
fn emit(&self, record: &mut LogRecord, library: &InstrumentationLibrary) {
let mut exporter = self.exporter.lock().expect("lock error");
let logs = [(record as &LogRecord, library)];
futures_executor::block_on(exporter.export(LogBatch::new(&logs)));
mod style_async_native {
use super::*;

/// Async style using Rustc support for async traits
pub trait LogExporterAsyncNative: Send + Sync + Debug {
fn export(&mut self, batch: LogBatch<'_>) -> impl std::future::Future<Output = ()> + Send;
Copy link
Member

@cijothomas cijothomas Oct 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the benchmarks, this looks to be close enough with sync counterpart. Wondering if there is a reason we can't try this in the Exporter traits? The <T> for output might make things complex...?
(I only added this benchmarks to see if there is actually some price to be paid for introducing async.)

@demurgos Do you have some bandwidth to modify existing exporter trait to use async native style? The existing benchmarks should show improvement with this change, based on what i observe in this PR.

(Still pretty new to Rust async, so I might be missing something obvious!)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey 👋
I was also interested in trying to impl a version using native async. I'm pretty familiar with it, but the lib is pretty large. I'll try to send something, but I can't promise any timeline.

}

fn force_flush(&self) -> LogResult<()> {
Ok(())
#[derive(Debug)]
pub struct NoOpExporterAsyncNative;

impl LogExporterAsyncNative for NoOpExporterAsyncNative {
#[inline]
async fn export(&mut self, batch: LogBatch<'_>) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add this consistently to other ones too, to ensure a fair comparison.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I missed the #[inline], I thought I applied it everywhere. I'll update my PR.

// As of writing this benchmark, the `rust-version` is `1.65`, but
// this benchmark relies on native async trait support from `1.75`
// so we may as well use the `black_box` hint from `1.66`. Benchmark
// are expected to be executed with a recent Rust toolchain anyway.
#[allow(clippy::incompatible_msrv)]
black_box(batch);
}
}

fn shutdown(&self) -> LogResult<()> {
Ok(())
#[derive(Debug)]
pub struct ExportingProcessorAsyncNative {
exporter: Mutex<NoOpExporterAsyncNative>,
}
}

#[derive(Debug)]
struct ExportingProcessorWithoutFuture {
exporter: Mutex<NoOpExporterWithoutFuture>,
}
impl ExportingProcessorAsyncNative {
pub fn new(exporter: NoOpExporterAsyncNative) -> Self {
Self {
exporter: Mutex::new(exporter),
}
}
}

impl LogProcessor for ExportingProcessorAsyncNative {
#[inline]
fn emit(&self, record: &mut LogRecord, library: &InstrumentationLibrary) {
let mut exporter = self.exporter.lock().expect("lock error");
let logs = [(record as &LogRecord, library)];
futures_executor::block_on(exporter.export(LogBatch::new(&logs)));
}

fn force_flush(&self) -> LogResult<()> {
Ok(())
}

impl ExportingProcessorWithoutFuture {
fn new(exporter: NoOpExporterWithoutFuture) -> Self {
ExportingProcessorWithoutFuture {
exporter: Mutex::new(exporter),
fn shutdown(&self) -> LogResult<()> {
Ok(())
}
}
}

impl LogProcessor for ExportingProcessorWithoutFuture {
fn emit(&self, record: &mut LogRecord, library: &InstrumentationLibrary) {
let logs = [(record as &LogRecord, library)];
self.exporter
.lock()
.expect("lock error")
.export(LogBatch::new(&logs));
mod style_sync {
use super::*;

/// Sync style
pub trait LogExporterSync: Send + Sync + Debug {
fn export(&mut self, batch: LogBatch<'_>);
}

fn force_flush(&self) -> LogResult<()> {
Ok(())
#[derive(Debug)]
pub struct NoOpExporterSync;

impl LogExporterSync for NoOpExporterSync {
fn export(&mut self, batch: LogBatch<'_>) {
// As of writing this benchmark, the `rust-version` is `1.65`, but
// this benchmark relies on native async trait support from `1.75`
// so we may as well use the `black_box` hint from `1.66`. Benchmark
// are expected to be executed with a recent Rust toolchain anyway.
#[allow(clippy::incompatible_msrv)]
black_box(batch);
}
}

fn shutdown(&self) -> LogResult<()> {
Ok(())
#[derive(Debug)]
pub struct ExportingProcessorSync {
exporter: Mutex<NoOpExporterSync>,
}

impl ExportingProcessorSync {
pub fn new(exporter: NoOpExporterSync) -> Self {
Self {
exporter: Mutex::new(exporter),
}
}
}

impl LogProcessor for ExportingProcessorSync {
fn emit(&self, record: &mut LogRecord, library: &InstrumentationLibrary) {
let mut exporter = self.exporter.lock().expect("lock error");
let logs = [(record as &LogRecord, library)];
exporter.export(LogBatch::new(&logs));
}

fn force_flush(&self) -> LogResult<()> {
Ok(())
}

fn shutdown(&self) -> LogResult<()> {
Ok(())
}
}
}

fn criterion_benchmark(c: &mut Criterion) {
exporter_with_future(c);
exporter_without_future(c);
bench_async_trait(c);
bench_async_native(c);
bench_sync(c);
}

fn exporter_with_future(c: &mut Criterion) {
fn bench_async_trait(c: &mut Criterion) {
let provider = LoggerProvider::builder()
.with_log_processor(ExportingProcessorWithFuture::new(NoOpExporterWithFuture {}))
.with_log_processor(style_async_trait::ExportingProcessorAsyncTrait::new(
style_async_trait::NoOpExporterAsyncTrait,
))
.build();
let logger = provider.logger("benchmark");

c.bench_function("LogExporterAsyncTrait", |b| {
b.iter(|| workload(&logger));
});
}

fn bench_async_native(c: &mut Criterion) {
let provider = LoggerProvider::builder()
.with_log_processor(style_async_native::ExportingProcessorAsyncNative::new(
style_async_native::NoOpExporterAsyncNative,
))
.build();
let logger = provider.logger("benchmark");

c.bench_function("LogExporterWithFuture", |b| {
b.iter(|| {
let mut log_record = logger.create_log_record();
let now = SystemTime::now();
log_record.set_observed_timestamp(now);
log_record.set_target("my-target".to_string());
log_record.set_event_name("CheckoutFailed");
log_record.set_severity_number(Severity::Warn);
log_record.set_severity_text("WARN");
log_record.add_attribute("book_id", "12345");
log_record.add_attribute("book_title", "Rust Programming Adventures");
log_record.add_attribute("message", "Unable to process checkout.");

logger.emit(log_record);
});
c.bench_function("LogExporterAsyncNative", |b| {
b.iter(|| workload(&logger));
});
}

fn exporter_without_future(c: &mut Criterion) {
fn bench_sync(c: &mut Criterion) {
let provider = LoggerProvider::builder()
.with_log_processor(ExportingProcessorWithoutFuture::new(
NoOpExporterWithoutFuture {},
.with_log_processor(style_sync::ExportingProcessorSync::new(
style_sync::NoOpExporterSync,
))
.build();
let logger = provider.logger("benchmark");

c.bench_function("LogExporterWithoutFuture", |b| {
b.iter(|| {
let mut log_record = logger.create_log_record();
let now = SystemTime::now();
log_record.set_observed_timestamp(now);
log_record.set_target("my-target".to_string());
log_record.set_event_name("CheckoutFailed");
log_record.set_severity_number(Severity::Warn);
log_record.set_severity_text("WARN");
log_record.add_attribute("book_id", "12345");
log_record.add_attribute("book_title", "Rust Programming Adventures");
log_record.add_attribute("message", "Unable to process checkout.");

logger.emit(log_record);
});
c.bench_function("LogExporterSync", |b| {
b.iter(|| workload(&logger));
});
}

/// Dummy workload to exercise a logger
fn workload<TyLogger>(logger: &TyLogger)
where
TyLogger: Logger,
{
let mut log_record = logger.create_log_record();
let now = SystemTime::now();
log_record.set_observed_timestamp(now);
log_record.set_target("my-target".to_string());
log_record.set_event_name("CheckoutFailed");
log_record.set_severity_number(Severity::Warn);
log_record.set_severity_text("WARN");
log_record.add_attribute("book_id", "12345");
log_record.add_attribute("book_title", "Rust Programming Adventures");
log_record.add_attribute("message", "Unable to process checkout.");

logger.emit(log_record);
}

#[cfg(not(target_os = "windows"))]
criterion_group! {
name = benches;
Expand Down
Loading