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

enable json output format for logger #58

Merged
merged 3 commits into from
Jan 29, 2024
Merged

Conversation

hunter-bera
Copy link
Contributor

@hunter-bera hunter-bera commented Jan 29, 2024

Summary by CodeRabbit

  • Refactor
    • Updated the logging functionality to utilize a new library for improved performance and flexibility.
    • Introduced options for JSON formatted logging and a minimal logging setup.

@hunter-bera hunter-bera requested a review from calbera January 29, 2024 15:31
Copy link

coderabbitai bot commented Jan 29, 2024

Walkthrough

The log package has been refactored to use the cosmossdk.io/log logging library instead of github.com/rs/zerolog. The Logger interface has been updated to use the log.Logger type, and its implementation has been modified accordingly. The NewLogger function now initializes the logger using the cosmossdk.io/log package, and two new functions, NewJsonLogger and NewBlankLogger, have been added to create loggers with specific configurations.

Changes

Files Change Summary
log/log.go Refactored to use cosmossdk.io/log, updated Logger interface, added NewJsonLogger, NewBlankLogger

🐇✨
In the realm of code, a change took flight,
From zerolog's grasp to cosmossdk.io/log's light.
New loggers born, with json and blank in sight,
A rabbit's cheer, for logging done right.
🌟📜

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 1e3eeb1 and d53304c.
Files ignored due to path filters (2)
  • go.mod is excluded by: !**/*.mod
  • go.sum is excluded by: !**/*.sum
Files selected for processing (1)
  • log/log.go (2 hunks)
Additional comments: 3
log/log.go (3)
  • 7-7: The import statement correctly switches from github.com/rs/zerolog to cosmossdk.io/log, aligning with the PR objectives.
  • 49-56: The NewLogger function is correctly implemented to initialize a logger using cosmossdk.io/log with color and custom time format options. However, it's important to ensure that the ColorOption(true) is appropriate for all environments, as colored logs might not be desirable in non-terminal outputs.

Consider verifying the appropriateness of ColorOption(true) for all intended output destinations of the logger.

  • 71-80: The NewBlankLogger function is implemented to create a logger with minimal configuration. The choice of time.Kitchen for the time format is unusual and might not be suitable for all use cases. It's important to ensure that this choice aligns with the intended use cases of the NewBlankLogger.

Verify the appropriateness of using time.Kitchen as the time format for the NewBlankLogger function, considering its intended use cases.

log/log.go Show resolved Hide resolved
log/log.go Outdated Show resolved Hide resolved
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between d53304c and d5cfe6d.
Files selected for processing (1)
  • log/log.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • log/log.go

@hunter-bera hunter-bera added this pull request to the merge queue Jan 29, 2024
Merged via the queue into main with commit 4981f8e Jan 29, 2024
3 checks passed
calbera pushed a commit that referenced this pull request Feb 1, 2024
* enable json output format for logger

* address

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

2 participants