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 module github.com/go-logr/logr to v1 #16

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Oct 29, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
github.com/go-logr/logr v0.4.0 -> v1.4.2 age adoption passing confidence

Release Notes

go-logr/logr (github.com/go-logr/logr)

v1.4.2

Compare Source

What's Changed

Dependencies:

Full Changelog: go-logr/logr@v1.4.1...v1.4.2

v1.4.1

Compare Source

What's Changed

Full Changelog: go-logr/logr@v1.4.0...v1.4.1

v1.4.0

Compare Source

This release dramatically improves interoperability with Go's log/slog package. In particular, logr.NewContext and logr.NewContextWithSlogLogger use the same context key, which allows logr.FromContext and logr.FromContextAsSlogLogger to return logr.Logger or *slog.Logger respectively, including transparently converting each to the other as needed.

Functions logr/slogr.NewLogr and logr/slogr.ToSlogHandler have been superceded by logr.FromSlogHandler and logr.ToSlogHandler respectively, and type logr/slogr.SlogSink has been superceded by logr.SlogSink. All of the old names in logr/slogr remain, for compatibility.

Package logr/funcr now supports logr.SlogSink, meaning that it's output passes all but one of the Slog conformance tests (that exception being that funcr handles the timestamp itself).

Users who have a logr.Logger and need a *slog.Logger can call slog.New(logr.ToSlogHandler(...)) and all output will go through the same stack.

Users who have a *slog.Logger or slog.Handler can call logr.FromSlogHandler(...) and all output will go through the same stack.

What's Changed

New Contributors

Full Changelog: go-logr/logr@v1.3.0...v1.4.0

v1.3.0

Compare Source

This release adds support for slog in a new, self-contained logr/slogr package. Implementers of a logr.LogSink are encouraged, but not required, to extend their implementation to improve the quality of log output coming from a slog API call.

Breaking change: the call depth for LogSink.Enabled when called via Logger.Enabled was fixed to be the same as for other call paths. Implementers of a LogSink who have worked around this bug will need to remove their workarounds.

Security best practices were improved. Only Go versions >= 1.18 are supported by this release.

What's Changed


New Contributors

Full Changelog: go-logr/logr@v1.2.4...v1.3.0

v1.2.4

Compare Source

This is a collection of small bugfixes and documentation updates.

NOTE: A change (https://github.com/go-logr/logr/pull/166) which was thought to be compatible seems to be a breaking change. In particular, one used to be able to differentiate the result of Discard() from Logger{}. After this change, those are the same. We are considering how to address this, but do not currently plan to revert this change. Apologies!

What's Changed

New Contributors

Full Changelog: go-logr/logr@v1.2.3...v1.2.4

v1.2.3

Compare Source

This is a minor release.

What's Changed

New Contributors

Full Changelog: go-logr/logr@v1.2.2...v1.2.3

v1.2.2

Compare Source

Bugfix release

  • funcr: Add a new Option MaxLogDepth which controls how many levels of nested fields (e.g. a struct that contains a struct that contains a struct, etc.) it may log. Every time it finds a struct, slice, array, or map the depth is increased by one. When the maximum is reached, the value will be converted to a string indicating that the max depth has been exceeded. If this field is not specified, a default value will be used.

v1.2.1

Compare Source

This is a minor bugfix release.

  • logr: Clarify the Error() semantics. 1) Error messages are always printed (they do not follow V()) and the error argument may be nil.
  • funcr: When using RenderValuesHook func would save the "cooked" result, so repeated calls to WithValues() would not merge properly.

v1.2.0

Compare Source

This release has several bug fixes and feature improvements.

  • logr: define an optional logr.Marshaler interface for types which want to control how they get logged
  • funcr: support fmt.Stringer and error interfaces on values which implement them
  • funcr: support logging complex{64,128}
  • funcr: fix handling of typed nil when logging a struct via reflection
  • funcr: add (optional) JSON output formatting mode
  • funcr: better handling of Go's json struct tags (all except "string")
  • funcr: handle embedded types more like Go's json package
  • funcr: misc performance optimizations
  • funcr: add support for modifying or remapping key/value pairs via hook functions
  • funcr: optionally log the caller function name
  • funcr: fix escaping of strings which contain special characters like line breaks or quotation marks
  • funcr: support encoding.TextMarshaler for map keys
  • funcr: allow customization of the timestamp format
  • funcr: improved testing
  • link to zerologr at its new location in the go-logr organization
  • various documentation and go doc enhancements

v1.1.0

Compare Source

This release has several bugfixes and feature improvements.

  • logr: fix incremental WithCallDepth() calls.
  • logr: expose the LogSink via GetSink() and SetSink() for custom WithSomething(logr, something) integrations.
  • logr: add an optional CallStackHelperLogSink interface so that implementations which have a function to flag helper functions (e.g. testing.T has Helper()) can attribute callers correctly. Log helper functions should prefer to use WithCallStackHelper() instead WithCallDepth(1) for maximum reach. Note the signature of WithCallStackHelper() - the caller must ALSO call the returned function.
  • funcr: add a LogTimestamp option.
  • funcr: support embedding a funcr.Formatter in other logger implementations. Used in testing.NewTestLogger()
  • testing: proper caller attribution when using NewTestLogger()
  • testing: enable options for LogTimestamp and Verbosity in NewTestLoggerWithOptions()
  • misc: Godoc clarifications

v1.0.0

Compare Source

This is the first logged release. Major changes (including breaking changes)
have occurred since earlier tags.


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Copy link

coderabbitai bot commented Oct 29, 2024

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

sourcery-ai bot commented Oct 29, 2024

Reviewer's Guide by Sourcery

This PR updates the go-logr/logr dependency from v0.4.0 to v1.4.2. This is a major version upgrade that introduces significant improvements in logging functionality, particularly around slog interoperability and various bug fixes.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Major version upgrade of the go-logr/logr logging library
  • Upgrade from v0.4.0 to v1.4.2
  • Added support for Go's log/slog package interoperability
  • Added support for logr.Marshaler interface for custom logging control
  • Improved handling of nested fields, complex types, and error values
  • Added JSON output formatting capabilities
  • Fixed various bugs around caller depth handling and nil value processing
go.mod

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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.

We have skipped reviewing this pull request. It seems to have been created by a bot (hey, renovate[bot]!). We assume it knows what it's doing!

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.

0 participants