fix: move defaultLogger to a log directory

[mahiro72]

Overview

• move the defaultLogger function to a log directory and rename DefaultLogger
• use DefaultLogger from the other packages

issue:

• Move logger to a log folder #377

Summary by CodeRabbit

• New Features

  • Introduced a default logging configuration for better log management and readability.

• Refactor

  • Replaced custom logger initialization with a standardized default logger to streamline logging practices.

[coderabbitai]

Walkthrough

The recent changes streamline the logging mechanism by replacing custom logger initialization with a standardized default logger setup using logrus. This involves modifying the Knuu constructor to use log.DefaultLogger() and introducing the DefaultLogger() function in the log package to configure the logger with custom settings.

Changes

Files	Change Summary
pkg/knuu/knuu.go	Removed imports for path, runtime, and strconv. Replaced defaultLogger() with log.DefaultLogger().
pkg/log/logger.go	Introduced DefaultLogger() function to configure a default logger using logrus.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant Knuu
    participant Logger

    Client->>Knuu: New(ctx, opts...)
    Knuu->>Logger: log.DefaultLogger()
    Logger-->>Knuu: Configured Logger
    Knuu-->>Client: *Knuu, error

Loading

Poem

In the land of code, a change took flight,
With logrus guiding through the night,
No more custom paths to tread,
A default logger now instead.
Simpler logs, a clearer way,
Celebrate this bright new day!
🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 254f7cd and ead1b7c.

Files selected for processing (2)

• pkg/knuu/knuu.go (4 hunks)
• pkg/log/logger.go (1 hunks)

Additional comments not posted (2)

pkg/knuu/knuu.go (2)

21-21: Correctly updated import to use the new DefaultLogger.

---

104-104: Proper use of DefaultLogger in the New function.

Verification successful

---

The verification confirms that the DefaultLogger function is defined in pkg/log/logger.go and is used in pkg/knuu/knuu.go. There are no remaining references to the old defaultLogger.

• pkg/log/logger.go: Defines the DefaultLogger function.
• pkg/knuu/knuu.go: Uses the DefaultLogger function.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify that all references to the old `defaultLogger` have been updated to `DefaultLogger`.

# Test: Search for the old function usage. Expect: No occurrences.
rg --type go $'defaultLogger'

Length of output: 28

---

---

Script:

#!/bin/bash
# Description: Verify the usage of `DefaultLogger` across the codebase.

# Test: Search for the usage of `DefaultLogger` and list the occurrences.
rg --type go $'DefaultLogger'

Length of output: 134

[mojtaba-esk]

Great job!

[tty47]

thank you!