8000 tracing-appender: Introduce weekly rotation by NickCaplinger · Pull Request #3218 · tokio-rs/tracing · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

tracing-appender: Introduce weekly rotation #3218

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
Merged
merged 9 commits into from
May 30, 2025
Merged

tracing-appender: Introduce weekly rotation #3218

merged 9 commits into from
May 30, 2025

Conversation

NickCaplinger
Copy link
Contributor

Motivation

While configuring tracing-appender, I wanted to specify a weekly log rotation interval. I was unable to do so, as the largest rotation interval was daily.

Solution

Before my introduction of weekly log rotation, rounding the current OffsetDateTime was straightforward: we could simply keep the current date and truncate part or all of the time component. However, we cannot simply truncate the time with weekly rotation; the date must now be modified.

To round the date, I take its ordinal (how many days have passed since the start of the year) and round it backwards to the nearest 7 day period. This gives us consistent date-times that only change weekly.

@NickCaplinger NickCaplinger requested a review from a team as a code owner February 17, 2025 19:34
hds
hds requested changes Apr 11, 2025
View reviewed changes
Copy link
Contributor
@hds hds left a comment

Choose a reason for hiding this comment

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

Thank you for your PR!

In general this looks good. However, I think that we should reconsider the way we pick the beginning of the week (see comment).

@NickCaplinger NickCaplinger requested a review from hds May 22, 2025 19:12
hds
hds requested changes May 23, 2025
View reviewed changes
Copy link
Contributor
@hds hds left a comment

Choose a reason for hiding this comment

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

Looks good. I think this scheme makes more sense.

One last thing is that I think we should clarify whether it's the start of Sunday UTC or local time.

Thanks!

@NickCaplinger NickCaplinger requested a review from hds May 23, 2025 16:53
hds
hds approved these changes May 29, 2025
View reviewed changes
Copy link
Contributor
@hds hds left a comment

Choose a reason for hiding this comment

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

Looks good. Thank you!

CI is failing, but I think this branch just needs master merged in to fix that.

@NickCaplinger
Copy link
Contributor Author
8000

I merged master into this branch, but I'm still seeing CI failures:

8:40:06 AM: error: unexpected `cfg` condition name: `unsound_local_offset`
8:40:06 AM:   --> tracing-subscriber/src/fmt/time/time_crate.rs:27:17
8:40:06 AM:    |
8:40:06 AM: 27 |     doc(cfg(all(unsound_local_offset, feature = "time", feature = "local-time")))
8:40:06 AM:    |                 ^^^^^^^^^^^^^^^^^^^^
8:40:06 AM:    |
8:40:06 AM:    = help: expected names are: `docsrs`, `feature`, `flaky_tests`, `test`, and `tracing_unstable` and 31 more
8:40:06 AM:    = help: consider using a Cargo feature instead
8:40:06 AM:    = help: or consider adding in `Cargo.toml` the `check-cfg` lint config for the lint:
8:40:06 AM:             [lints.rust]
8:40:06 AM:             unexpected_cfgs = { level = "warn", check-cfg = ['cfg(unsound_local_offset)'] }
8:40:06 AM:    = help: or consider adding `println!("cargo::rustc-check-cfg=cfg(unsound_local_offset)");` to the top of the `build.rs`
8:40:06 AM:    = note: see <[https://doc.rust-lang.org/nightly/rustc/check-cfg/cargo-specifics.html&gt;](https://doc.rust-lang.org/nightly/rustc/check-cfg/cargo-specifics.html%3E) for more information about checking conditional configuration
8:40:06 AM:    = note: `-D unexpected-cfgs` implied by `-D warnings`
8:40:06 AM:    = help: to override `-D warnings` add `#[allow(unexpected_cfgs)]`
8:40:06 AM: error: unexpected `cfg` condition name: `unsound_local_offset`
8:40:06 AM:   --> tracing-subscriber/src/fmt/time/mod.rs:16:32
8:40:06 AM:    |
8:40:06 AM: 16 | #[cfg_attr(docsrs, doc(cfg(all(unsound_local_offset, feature = "local-time"))))]
8:40:06 AM:    |                                ^^^^^^^^^^^^^^^^^^^^
8:40:06 AM:    |
8:40:06 AM:    = help: consider using a Cargo feature instead
8:40:06 AM:    = help: or consider adding in `Cargo.toml` the `check-cfg` lint config for the lint:
8:40:06 AM:             [lints.rust]
8:40:06 AM:             unexpected_cfgs = { level = "warn", check-cfg = ['cfg(unsound_local_offset)'] }
8:40:06 AM:    = help: or consider adding `println!("cargo::rustc-check-cfg=cfg(unsound_local_offset)");` to the top of the `build.rs`
8:40:06 AM:    = note: see <[https://doc.rust-lang.org/nightly/rustc/check-cfg/cargo-specifics.html&gt;](https://doc.rust-lang.org/nightly/rustc/check-cfg/cargo-specifics.html%3E) for more information about checking conditional configuration

This appears to be unrelated to my change. For what it's worth, #3237 is an open PR that mentions this problem. How should we proceed?

@hds
Copy link
Contributor
hds commented May 30, 2025

I've created a separate PR to fix these issues #3292, once that's merged you can pull in the latest changes and this PR should go green too.

@hds hds merged commit d81a69e into tokio-rs:master May 30, 2025
56 checks passed
@NickCaplinger
Copy link
Contributor Author

Thank you, Hayden! Have a great weekend

@hds hds mentioned this pull request Jun 2, 2025
Merged
25 tasks
hds pushed a commit that referenced this pull request Jun 2, 2025
@NickCaplinger @hds
appender: introduce weekly rotation (#3218)
5862bc5 
## Motivation

While configuring tracing-appender, I wanted to specify a weekly log
rotation interval. I was unable to do so, as the largest rotation
interval was daily.

## Solution

Before my introduction of weekly log rotation, rounding the current
`OffsetDateTime` was straightforward: we could simply keep the current
date and truncate part or all of the time component. However, we cannot
simply truncate the time with weekly rotation; the date must now be
modified.

To round the date, we roll logs at 00:00 UTC on Sunday. This gives us
consistent date-times that only change weekly.
hds pushed a commit that referenced this pull request Jun 2, 2025
@NickCaplinger @hds
appender: introduce weekly rotation (#3218)
49bde06 
## Motivation

While configuring tracing-appender, I wanted to specify a weekly log
rotation interval. I was unable to do so, as the largest rotation
interval was daily.

## Solution

Before my introduction of weekly log rotation, rounding the current
`OffsetDateTime` was straightforward: we could simply keep the current
date and truncate part or all of the time component. However, we cannot
simply truncate the time with weekly rotation; the date must now be
modified.

To round the date, we roll logs at 00:00 UTC on Sunday. This gives us
consistent date-times that only change weekly.
hds pushed a commit that referenced this pull request Jun 3, 2025
@NickCaplinger @hds
appender: introduce weekly rotation (#3218)
656a7c9 
## Motivation

While configuring tracing-appender, I wanted to specify a weekly log
rotation interval. I was unable to do so, as the largest rotation
interval was daily.

## Solution

Before my introduction of weekly log rotation, rounding the current
`OffsetDateTime` was straightforward: we could simply keep the current
date and truncate part or all of the time component. However, we cannot
simply truncate the time with weekly rotation; the date must now be
modified.

To round the date, we roll logs at 00:00 UTC on Sunday. This gives us
consistent date-times that only change weekly.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hds hds hds 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.
2 participants
@NickCaplinger @hds
0