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.

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

logger v2 #7

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

logger v2 #7

wants to merge 5 commits into from

Conversation

zemingzhu
Copy link

@zemingzhu zemingzhu commented Apr 24, 2024

Summary by CodeRabbit

  • New Features
    • Introduced enhanced logging capabilities allowing configurable log levels and formats, improving the diagnostic and monitoring experience.
    • Added test functions for logging functionality to ensure robust logging behavior.

Copy link

coderabbitai bot commented Apr 24, 2024

Walkthrough

The recent update introduces a new logging system to enhance logging capabilities project-wide. This system brings in configurable log levels, formats, and file creation, aiming to streamline log handling for improved debugging and monitoring tailored to diverse developmental needs.

Changes

Files Change Summary
.../logger/logger_utils.go,
.../logger/logger_utils_test.go
Introduces logging functionality with configurable levels, formats, and file creation. Adds tests for logging functionality with different formats for specific modules.

Poem

🐇 A Poem by CodeRabbit

🌟 In the code forest deep and vast,
📜 A new logger has been cast.
📖 With levels low and levels high,
📚 It logs the tales of bytes that fly.
🌲 Here’s to the code, ever so bright,
🎉 May it run with all its might!


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 6324027 and 4e0a263.
Files selected for processing (2)
  • internal/logger/logger_utils.go (1 hunks)
  • internal/logger/logger_utils_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • internal/logger/logger_utils.go
  • internal/logger/logger_utils_test.go

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
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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Comment on lines 34 to 60
func Initialize(cfg Config) {
config = cfg
logrus.SetFormatter(config.LogFormat)
switch config.LogLevel {
case InfoLevel:
logrus.SetLevel(logrus.InfoLevel)
case WarnLevel:
logrus.SetLevel(logrus.WarnLevel)
case ErrorLevel:
logrus.SetLevel(logrus.ErrorLevel)
default:
logrus.SetLevel(logrus.InfoLevel)
}

for _, file := range config.ModuleToFile {
path := filepath.Dir(file)
if err := os.MkdirAll(path, os.ModePerm); err != nil {
logrus.WithError(err).Fatal("cannot create log directory")
}
file, err := os.OpenFile(file, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
if err != nil {
logrus.WithError(err).Fatal("cannot open log file")
}

logrus.SetOutput(file)
}
}
Copy link

Choose a reason for hiding this comment

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

The logger output is set to the last file in the loop, which likely causes all logs to be written to the same file.

- logrus.SetOutput(file)
+ logger.SetOutput(file)  // Ensure each logger instance has its correct output file.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
func Initialize(cfg Config) {
config = cfg
logrus.SetFormatter(config.LogFormat)
switch config.LogLevel {
case InfoLevel:
logrus.SetLevel(logrus.InfoLevel)
case WarnLevel:
logrus.SetLevel(logrus.WarnLevel)
case ErrorLevel:
logrus.SetLevel(logrus.ErrorLevel)
default:
logrus.SetLevel(logrus.InfoLevel)
}
for _, file := range config.ModuleToFile {
path := filepath.Dir(file)
if err := os.MkdirAll(path, os.ModePerm); err != nil {
logrus.WithError(err).Fatal("cannot create log directory")
}
file, err := os.OpenFile(file, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
if err != nil {
logrus.WithError(err).Fatal("cannot open log file")
}
logrus.SetOutput(file)
}
}
func Initialize(cfg Config) {
config = cfg
logrus.SetFormatter(config.LogFormat)
switch config.LogLevel {
case InfoLevel:
logrus.SetLevel(logrus.InfoLevel)
case WarnLevel:
logrus.SetLevel(logrus.WarnLevel)
case ErrorLevel:
logrus.SetLevel(logrus.ErrorLevel)
default:
logrus.SetLevel(logrus.InfoLevel)
}
for _, file := range config.ModuleToFile {
path := filepath.Dir(file)
if err := os.MkdirAll(path, os.ModePerm); err != nil {
logrus.WithError(err).Fatal("cannot create log directory")
}
file, err := os.OpenFile(file, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
if err != nil {
logrus.WithError(err).Fatal("cannot open log file")
}
logger.SetOutput(file) // Ensure each logger instance has its correct output file.
}
}

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