Skip to content

Remove timestamp from entrypoint log file #3279

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
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

voorloopnul
Copy link
Contributor

@voorloopnul voorloopnul commented Apr 16, 2025

Timestamps are added in archives on rotation, the entrypoint having a timestamp creates an awkward situation where the log messages timestamp and log file name drift apart.

( currently entrylog name and rotation routine are not related )

Summary by Sourcery

Enhancements:

  • Simplify log file naming by removing datetime information from the filename

Copy link

sourcery-ai bot commented Apr 16, 2025

Reviewer's Guide by Sourcery

This pull request removes the timestamp from the entrypoint log file name. The timestamp is added during log rotation, so it is redundant to have it in the entrypoint log file name.

Updated class diagram for logs

classDiagram
  class logs.py {
    <<file>>
    +get_new_log_path(service_name: str) Path
    +init_logger(service_name: str) None
  }
  note for logs.py "Removes timestamp from entrypoint log file name"
Loading

File-Level Changes

Change Details Files
Removed timestamp from the entrypoint log file name.
  • Removed the timestamp generation logic.
  • Updated the log file path to be a static name.
core/libs/commonwealth/commonwealth/utils/logs.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @voorloopnul - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a comment explaining why the timestamp was removed from the filename.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Timestamps are added in archives on rotation, the entrypoint having a timestamp creates an awkward situation where the log messages timestamp and log file name drift apart.

( currently entrypoint log name and rotation routine are not related )
@voorloopnul voorloopnul force-pushed the fix-entrypoint-log-name branch from 97aa835 to 8a43557 Compare April 16, 2025 17:47
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

Successfully merging this pull request may close these issues.

1 participant