-
Notifications
You must be signed in to change notification settings - Fork 588
fix: make shutdown_with_timeout required on LogProcessor
#3133
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
Merged
lalitb
merged 5 commits into
open-telemetry:main
from
davidhewitt:dh/log-shutdown-with-timeout
Oct 28, 2025
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3057685
make `shutdown_with_timeout` required on `LogProcessor`
davidhewitt b49ee41
fix even more cases
davidhewitt 9803d0c
don't remove the default implementation of `shutdown_with_timeout`
davidhewitt dc1ba71
Merge branch 'main' into dh/log-shutdown-with-timeout
lalitb 2432f92
Merge branch 'main' into dh/log-shutdown-with-timeout
lalitb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,7 +31,7 @@ use crate::{logs::SdkLogRecord, Resource}; | |
|
|
||
| #[cfg(feature = "spec_unstable_logs_enabled")] | ||
| use opentelemetry::logs::Severity; | ||
| use opentelemetry::InstrumentationScope; | ||
| use opentelemetry::{otel_warn, InstrumentationScope}; | ||
|
|
||
| use std::fmt::Debug; | ||
| use std::time::Duration; | ||
|
|
@@ -57,10 +57,21 @@ pub trait LogProcessor: Send + Sync + Debug { | |
| /// Shuts down the processor. | ||
| /// After shutdown returns the log processor should stop processing any logs. | ||
| /// It's up to the implementation on when to drop the LogProcessor. | ||
| /// | ||
| /// All implementors should implement this method. | ||
| fn shutdown_with_timeout(&self, _timeout: Duration) -> OTelSdkResult { | ||
| // It would have been better to make this method required, but that ship | ||
| // sailed when the logs API was declared stable. | ||
| otel_warn!( | ||
| name: "LogProcessor.DefaultShutdownWithTimeout", | ||
| message = format!("LogProcessor::shutdown_with_timeout should be implemented by all LogProcessor types") | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is giving the wrong message - it is not required by all implementations to have shutdown methods. |
||
| ); | ||
| Ok(()) | ||
| } | ||
| /// Shuts down the processor with default timeout. | ||
| /// | ||
| /// Implementors typically do not need to change this method, and can just | ||
| /// implement `shutdown_with_timeout`. | ||
| fn shutdown(&self) -> OTelSdkResult { | ||
| self.shutdown_with_timeout(Duration::from_secs(5)) | ||
| } | ||
|
|
@@ -140,6 +151,10 @@ pub(crate) mod tests { | |
| fn force_flush(&self) -> OTelSdkResult { | ||
| Ok(()) | ||
| } | ||
|
|
||
| fn shutdown_with_timeout(&self, _timeout: std::time::Duration) -> OTelSdkResult { | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| #[derive(Debug)] | ||
|
|
@@ -166,6 +181,10 @@ pub(crate) mod tests { | |
| fn force_flush(&self) -> OTelSdkResult { | ||
| Ok(()) | ||
| } | ||
|
|
||
| fn shutdown_with_timeout(&self, _timeout: std::time::Duration) -> OTelSdkResult { | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is incorrect statement. It is entirely upto the log processor to decide if they need to do anything in shutdown or not.