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

Update registry logger output and format #57

Closed
wants to merge 1 commit into from

Conversation

cd-Barnes
Copy link

@cd-Barnes cd-Barnes commented May 21, 2024

This change updates the registry's logger to output logs in JSON on stdout. This makes it easier for logging/monitoring tools to ingest and correctly categorize beskar logs.

Summary by CodeRabbit

  • Improvements
    • Enhanced logging with JSON formatting for better readability and integration with logging systems.

Copy link
Contributor

coderabbitai bot commented May 21, 2024

Walkthrough

The recent update enhances the logging system by incorporating the logrus library with a JSON formatter, ensuring structured logging output. The logger now outputs to os.Stdout, providing better integration with containerized environments and centralized logging systems.

Changes

File Path Change Summary
internal/pkg/beskar/registry.go Added imports for os and logrus, set a JSON formatter for the logger, and updated logger initialization

Poem

In the code where logs now gleam,
JSON formats, a dream supreme.
logrus sings with structured grace,
To stdout, logs find their place.
🐇✨


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
Contributor

@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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between d2b80e5 and 2592cb1.
Files selected for processing (1)
  • internal/pkg/beskar/registry.go (2 hunks)
Additional comments not posted (3)
internal/pkg/beskar/registry.go (3)

17-17: Import of os package is appropriate for the new logging functionality.


99-99: Logger field correctly added to the Registry struct and initialized.


94-97: Logger initialization updated to output JSON formatted logs to stdout.

Verification successful

The verification confirms that the logger instance in internal/pkg/beskar/registry.go is correctly configured to use JSON formatting. No other logger instances or configurations were found that contradict this setup.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that all logger instances in the application are updated to use JSON formatting.

# Test: Search for logger instances not using JSONFormatter. Expect: No occurrences.
rg --type go $'logrus.New()'

Length of output: 29



Script:

#!/bin/bash
# Description: Verify that all logger instances in the application are updated to use JSON formatting.

# Test: Search for logger instances and their configurations. Expect: All instances should use JSONFormatter.
rg --type go 'logrus\.' | grep -E 'SetFormatter|New'

Length of output: 132

@cd-Barnes
Copy link
Author

Closing this one. We can override this client side. No need to change the default formatter

@cd-Barnes cd-Barnes closed this May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant