Loggers: use log format rather than terminal format for files

[BedrockSquirrel]

Why this change is needed

I'm getting frustrated fairly regularly by shortened hashes, like the tx hash in this log msg:

INFO [01-17|11:36:12.973] Host issuing l1 tx                       node_id=0xE09a37ABc1A63441404007019E5BC7517bE2c43f component=host     tx=27cb85..41b663 size=6 retries=0

It means you can't do a lookup by hash for whatever the item is. And it's happening automatically because we use a Terminal log formatter even for loggers that write to files.

What changes were made as part of this PR

Changes the formatter to log formatter unless it's streaming to SysOut.

PR checks pre-merging

Please indicate below by ticking the checkbox that you have read and performed the required
PR checks

• PR checks reviewed and performed

[coderabbitai]

Walkthrough

The change involves modifying the logging behavior in two Go files. When setting up file handlers for logging, the format has been switched from a terminal-based format to a logfmt-based format, provided that the output destination is not the system's standard output. This adjustment likely aims to enhance the readability or processing of log files by using a structured logging format that is more suitable for files.

Changes

Files	Change Summary
.../log/log.go, .../testlog/testlog.go	Updated the logging setup to use gethlog.LogfmtFormat() for file handlers instead of gethlog.TerminalFormat(false) when the output is not SysOut.

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

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 0198095 and 2565823.

Files selected for processing (2)

• go/common/log/log.go (1 hunks)
• integration/common/testlog/testlog.go (1 hunks)

Additional comments: 2

integration/common/testlog/testlog.go (1)

• 48-48: The change from TerminalFormat to LogfmtFormat aligns with the PR's objective to ensure full hashes are logged in file outputs. This change should resolve the issue with truncated hashes.

go/common/log/log.go (1)

• 61-61: The update to use LogfmtFormat for file handlers when the output is not SysOut is consistent with the PR's goal to improve log detail in file outputs. This should ensure that logs contain complete hashes for better debugging.