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

Jump to bottom

explicitly flush previous BufWriter before dropping #1604

Merged
merged 1 commit into from
Oct 1, 2021
Merged

explicitly flush previous BufWriter before dropping #1604

merged 1 commit into from
Oct 1, 2021

Conversation

zvkemp
Copy link
Contributor

@zvkemp zvkemp commented Sep 30, 2021

Motivation

When a RollingFileAppender is refreshed, the previous BufWriter may encounter and suppress errors in drop.

From https://doc.rust-lang.org/std/io/struct.BufWriter.html:

It is critical to call flush before BufWriter is dropped. Though dropping will attempt to flush the contents of the buffer, any errors that happen in the process of dropping will be ignored.

Solution

Explicitly flush the previous buffer before dropping, printing any error to stderr.

@zvkemp zvkemp requested a review from a team as a code owner September 30, 2021 21:25
hawkw
hawkw approved these changes Oct 1, 2021
View reviewed changes
Copy link
Member

@hawkw hawkw left a comment

Choose a reason for hiding this comment

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

Thanks for the fix, this looks good to me!

@hawkw hawkw merged commit bfb925b into tokio-rs:master Oct 1, 2021
hawkw pushed a commit that referenced this pull request Oct 1, 2021
@zvkemp @hawkw
appender: explicitly flush previous BufWriter before dropping (#1604)
37c4b5c 
## Motivation

When a `RollingFileAppender` is refreshed, the previous `BufWriter` may
encounter and suppress errors in `drop`.

From https://doc.rust-lang.org/std/io/struct.BufWriter.html:

> It is critical to call flush before BufWriter<W> is dropped. Though
> dropping will attempt to flush the contents of the buffer, any errors
> that happen in the process of dropping will be ignored.

## Solution

Explicitly flush the previous buffer before dropping, printing any error
to stderr.
@hawkw hawkw mentioned this pull request Oct 1, 2021
Merged
hawkw pushed a commit that referenced this pull request Oct 1, 2021
@zvkemp @hawkw
appender: explicitly flush previous BufWriter before dropping (#1604)
024d6ab 
## Motivation

When a `RollingFileAppender` is refreshed, the previous `BufWriter` may
encounter and suppress errors in `drop`.

From https://doc.rust-lang.org/std/io/struct.BufWriter.html:

> It is critical to call flush before BufWriter<W> is dropped. Though
> dropping will attempt to flush the contents of the buffer, any errors
> that happen in the process of dropping will be ignored.

## Solution

Explicitly flush the previous buffer before dropping, printing any error
to stderr.
hawkw added a commit that referenced this pull request Oct 22, 2021
@hawkw
appender: prepare to release v0.2.0
a4a121c 
# 0.2.0 (October 22, 2021)

This breaking change release adds support for the new v0.3.x series of
`tracing-subscriber`. In addition, it resolves the security advisory for
the `chrono` crate, [RUSTSEC-2020-0159].

This release increases the minimum supported Rust version (MSRV) to
1.51.0.
### Breaking Changes

- Updated `tracing-subscriber` to v0.3.x ([#1677])
- Changed `NonBlocking::error_counter` to return an `ErrorCounter` type,
  rather than an `Arc<AtomicU64>` ([#1675])
  ### Changed

- Updated `tracing-subscriber` to v0.3.x ([#1677])
  ### Fixed

- **non-blocking**: Fixed compilation on 32-bit targets ([#1675])
- **rolling**: Replaced `chrono` dependency with `time` to resolve
  [RUSTSEC-2020-0159] ([#1652])
- **rolling**: Fixed an issue where `RollingFileAppender` would fail to
  print errors that occurred while flushing a previous logfile ([#1604])

Thanks to new contributors @dzvon and @zvkemp for contributing to this
release!

[RUSTSEC-2020-0159]: https://rustsec.org/advisories/RUSTSEC-2020-0159.html
[#1677]: #1677
[#1675]: #1675
[#1652]: #1675
[#1604]: #1604
@hawkw hawkw mentioned this pull request Oct 22, 2021
Merged
hawkw added a commit that referenced this pull request Oct 23, 2021
@hawkw
appender: prepare to release v0.2.0 (#1678)
aaa419b 
# 0.2.0 (October 22, 2021)

This breaking change release adds support for the new v0.3.x series of
`tracing-subscriber`. In addition, it resolves the security advisory for
the `chrono` crate, [RUSTSEC-2020-0159].

This release increases the minimum supported Rust version (MSRV) to
1.51.0.
### Breaking Changes

- Updated `tracing-subscriber` to v0.3.x ([#1677])
- Changed `NonBlocking::error_counter` to return an `ErrorCounter` type,
  rather than an `Arc<AtomicU64>` ([#1675])
  ### Changed

- Updated `tracing-subscriber` to v0.3.x ([#1677])
  ### Fixed

- **non-blocking**: Fixed compilation on 32-bit targets ([#1675])
- **rolling**: Replaced `chrono` dependency with `time` to resolve
  [RUSTSEC-2020-0159] ([#1652])
- **rolling**: Fixed an issue where `RollingFileAppender` would fail to
  print errors that occurred while flushing a previous logfile ([#1604])

Thanks to new contributors @dzvon and @zvkemp for contributing to this
release!

[RUSTSEC-2020-0159]: https://rustsec.org/advisories/RUSTSEC-2020-0159.html
[#1677]: #1677
[#1675]: #1675
[#1652]: #1675
[#1604]: #1604
@davidbarsky davidbarsky mentioned this pull request Sep 26, 2023
Merged
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request May 22, 2024
@hawkw @kaffarell
appender: prepare to release v0.2.0 (tokio-rs#1678)
b7c8ee0 
# 0.2.0 (October 22, 2021)

This breaking change release adds support for the new v0.3.x series of
`tracing-subscriber`. In addition, it resolves the security advisory for
the `chrono` crate, [RUSTSEC-2020-0159].

This release increases the minimum supported Rust version (MSRV) to
1.51.0.
### Breaking Changes

- Updated `tracing-subscriber` to v0.3.x ([tokio-rs#1677])
- Changed `NonBlocking::error_counter` to return an `ErrorCounter` type,
  rather than an `Arc<AtomicU64>` ([tokio-rs#1675])
  ### Changed

- Updated `tracing-subscriber` to v0.3.x ([tokio-rs#1677])
  ### Fixed

- **non-blocking**: Fixed compilation on 32-bit targets ([tokio-rs#1675])
- **rolling**: Replaced `chrono` dependency with `time` to resolve
  [RUSTSEC-2020-0159] ([tokio-rs#1652])
- **rolling**: Fixed an issue where `RollingFileAppender` would fail to
  print errors that occurred while flushing a previous logfile ([tokio-rs#1604])

Thanks to new contributors @dzvon and @zvkemp for contributing to this
release!

[RUSTSEC-2020-0159]: https://rustsec.org/advisories/RUSTSEC-2020-0159.html
[tokio-rs#1677]: tokio-rs#1677
[tokio-rs#1675]: tokio-rs#1675
[tokio-rs#1652]: tokio-rs#1675
[tokio-rs#1604]: tokio-rs#1604
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hawkw hawkw hawkw approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@zvkemp @hawkw