Skip to content

Eliminate Dynamic Dispatching in Log Pipeline for Performance Optimization #1942

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.

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

Open
lalitb opened this issue Jul 17, 2024 · 3 comments
Open
Assignees

Comments

@lalitb
Copy link
Member

lalitb commented Jul 17, 2024

Currently, the log pipeline employs dynamic dispatching within its workflow:

                        (dynamic)                                      (dynamic)
Logger::emit(record)  ------------> LogProcessor::emit(data)   ------------->   LogExporter::export(batch)

While it is possible to implement custom LogProcessor to avoid the second dynamic dispatch, the first dynamic dispatch remains unavoidable. This overhead should be eliminated.

This issue has been created to track the necessary improvements.

Reference:

  1. LogEmitter.rs:

    #[derive(Debug)]
    struct LoggerProviderInner {
    processors: Vec<Box<dyn LogProcessor>>,
    resource: Resource,
    }

  2. SimpleLogProcessor:

    pub struct SimpleLogProcessor {
    exporter: Mutex<Box<dyn LogExporter>>,
    is_shutdown: AtomicBool,
    }

  3. BatchLogProcessor:

    impl<R: RuntimeChannel> BatchLogProcessor<R> {
    pub(crate) fn new(mut exporter: Box<dyn LogExporter>, config: BatchConfig, runtime: R) -> Self {
    let (message_sender, message_receiver) =

@lalitb lalitb self-assigned this Jul 17, 2024
@lalitb lalitb added this to the Logging SDK Stable milestone Jul 17, 2024
@lalitb
Copy link
Member Author

lalitb commented Aug 5, 2024

Assuming SimpleConcurrentProcessor is part of the specs. The simple solution could be

  • Add static dispatch for SimpleLogProcessor and SimpleConcurrentProcessor because their types are known at compile time.
  • We require dynamic dispatch for BatchLogProcessor as its runtime type can vary based on configuration, making it difficult to use a static type.
  • Any other custom log processor would be dispatched at runtime.
enum LogProcessorEnum {
    SimpleLogProcessor(SimpleLogProcessor),
    SimpleConcurrentProcessor(SimpleConcurrentProcessor),
    Batch(BatchLogProcessor<Box<dyn RuntimeChannel>>),
    DynLogProcessor(Box<dyn LogProcessor>),

}

impl LogProcessor for LogProcessorEnum {
    fn emit(&self, data: &mut LogData) {
        match self {
            LogProcessorEnum::SimpleLogProcessor(p) => p.emit(data),
            LogProcessorEnum::SimpleConcurrentProcessor(p) => p.emit(data),
            LogProcessorEnum::Batch(p) => p.emit(data),
            LogProcessorEnum::DynLogProcessor(p) => p.emit(data),
        }
    }
    // --- and other methods ForceFlush() and Shutdown() similarly implemented.
}
#[derive(Debug)]
struct LoggerProviderInner {
    processors: Vec<LogProcessorEnum>,
    resource: Resource,
}

Because of the async-runtime dependency, it is difficult to have the static dispatch for Batch Processor. However, it can be implemented through some macro , which would register this processor with async-runtime at compile time. Something like:

macro_rules! register_batch_log_processor {
    ($runtime:ty) => {
        enum LogProcessorEnum {
            Simple(SimpleLogProcessor),
            Batch(BatchLogProcessor<$runtime>),
            // and others
        }

 /// and called as:
register_batch_log_processor!(TokioRuntime);

@cijothomas
Copy link
Member

Assuming open-telemetry/opentelemetry-specification#4163 is part of the specs.

We don't need it to be part of the spec, it is sufficient that it is part of opentelemtry-sdk crate. Spec does not prohibit additional processors.

@cijothomas
Copy link
Member

Looked at this more closely, and we don't have public API risk with this. The method used by Logger to get a list of processors form the provider is not public, so we should be able to change this in back-compat way in future. Removing from Log SDK Stable milestone due to this.

@cijothomas cijothomas removed this from the Logging SDK Stable milestone Mar 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants