Option using fields in snake_case.

[roman-wb]

Hi!

Added option FieldsSnakeCase:bool
Use snake case for fields: FieldResBody, FieldQueryParams, FieldBytesReceived, FieldBytesSent, FieldRequestId, FieldReqHeaders, FieldResHeaders.

If false (default): {"method":"POST", "resBody":"v", "queryParams":"v"}
If true: {"method":"POST", "res_body":"v", "query_params":"v"}

Summary by CodeRabbit

• New Features
  • Introduced new logging fields including response body, query parameters, bytes received/sent, request ID, and request/response headers.
  • Added a configuration option to toggle field naming convention between snake case and default.

[ReneWerner87]

why is this feature necessary ?
we can't support every spelling, if another spelling should be enabled, we have to add another much more generic way to not extend the configuration for each spelling to customize it

[roman-wb]

why is this feature necessary ? we can't support every spelling, if another spelling should be enabled, we have to add another much more generic way to not extend the configuration for each spelling to customize it

Often JSON keys in text presentation used as snake case.

As variant 2: adding new keys (example FieldResBodySC etc) and developer will set in option Fields.

[sixcolors]

@ReneWerner87 snake_case is pretty common with JSON; ref https://developer.apple.com/documentation/foundation/jsondecoder/keydecodingstrategy/convertfromsnakecase#

[ReneWerner87]

Ok valid

[coderabbitai]

Walkthrough

The recent update enriches the logging capabilities of the library by introducing additional fields such as response body, query parameters, bytes received, bytes sent, request ID, and both request and response headers. It also offers a new configuration option, FieldsSnakeCase, allowing users to choose between snake case and the default naming convention for these fields, enhancing flexibility in log formatting.

Changes

File(s)	Change Summary
fiberzerolog/README.md, .../config.go	Added fields (res_body, query_params, etc.) and FieldsSnakeCase option for flexible log formatting. Updated logging logic.

🐇✨
In the land of code, where the data streams flow,
A rabbit hopped in, with new fields in tow.
"Log as you like, with snake case or not,"
It said with a smile, "A choice, you've got!"
Bytes in and out, headers and IDs,
Captured in logs, as easy as a breeze.
🌟🐾

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

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 86655b7 and ed24b0f.

Files selected for processing (3)

• fiberzerolog/README.md (1 hunks)
• fiberzerolog/config.go (3 hunks)
• fiberzerolog/zerolog_test.go (2 hunks)

Additional comments: 5

fiberzerolog/README.md (1)

• 42-42: The addition of the FieldsSnakeCase option to the README is clear and well-documented. It effectively communicates the purpose and usage of the new feature, including examples of the output format based on the option's value.

fiberzerolog/config.go (2)

• 36-42: The addition of snake_case constants for log fields is correctly implemented. These constants provide a clear and maintainable way to switch between camelCase and snake_case representations based on the FieldsSnakeCase configuration.
• 98-103: The FieldsSnakeCase option is correctly added to the Config struct with a clear description and default value. This addition follows best practices for configurable middleware in Go, allowing users to easily enable or disable snake_case field names in their logs.

fiberzerolog/zerolog_test.go (2)

• 16-16: The addition of the requestid middleware import is necessary for the new test Test_FieldsSnakeCase, which checks the logging of fields in snake_case. This import is correctly placed and used within the test setup.
• 475-535: The Test_FieldsSnakeCase function is well-implemented, thoroughly testing the FieldsSnakeCase feature by asserting the log output format. It covers various fields and configurations, ensuring the feature works as expected. Great job on covering different aspects of the feature in a single test.

[ReneWerner87]

Will merge it tomorrow