chore!: docker log to stdout and minor logging tweaks

[lklimek]

Issue being fixed or feature implemented

We must redirect stderr to stdout before grepping output of docker logs command.
It's quite hard to use.

What was done?

1. Updated entrypoint.sh to redirect stderr to stdout
2. tuned one log

How Has This Been Tested?

Locally

Breaking Changes

logs captured from docker logs must now be read from stdout instead of stderr.

Checklist:

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated relevant unit/integration/functional/e2e tests
• I have made corresponding changes to the documentation

For repository code-owners and collaborators only

• I have assigned this pull request to a milestone

Summary by CodeRabbit

• Bug Fixes

  • Improved error handling and logging in the catchup replay process, adjusting log severity for better clarity.

• Chores

  • Enhanced script consistency by removing leading spaces in the entrypoint script.

[coderabbitai]

Walkthrough

The changes involve formatting adjustments in the docker-entrypoint.sh script, specifically removing leading spaces for improved indentation consistency. The functionality of the script remains unchanged. In internal/consensus/state.go, the modifications focus on error handling in the OnStart method, where the log level for an error during the catchup replay process has been adjusted from Error to Warn. No new logic has been introduced, and the overall structure remains intact.

Changes

File Path	Change Summary
DOCKER/docker-entrypoint.sh	Removed leading spaces for consistent indentation.
internal/consensus/state.go	Changed log level from Error to Warn in OnStart method.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DockerEntryPoint
    participant State

    User->>DockerEntryPoint: Start container
    DockerEntryPoint->>DockerEntryPoint: Initialize configuration
    DockerEntryPoint->>State: Call OnStart
    State->>State: Execute catchup replay
    State-->>State: Log warning if error occurs
    State-->>DockerEntryPoint: Complete process
    DockerEntryPoint-->>User: Container running

Loading

🐰 In the script, a tidy hop,
Spaces removed, no need to stop.
In the state, a warning's now clear,
Catchup replay, we have no fear!
With logs that softly chime,
All is well, it's rabbit time! 🐇

---

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

[shumkov]

Are you sure you want to send all stderr from Tenderdash? We should probably let Tenderdash control output and adjust the logger to use stdout instead of stderr. There might be some confusion in the future when you do some stderr output from Tenderdash and do not see it when you run a docker container.

[lklimek]

My AI junior says:

For server software running on Linux, it is generally recommended to send logs to `stderr`. This is because `stdout` is typically used for regular output, while `stderr` is used for logging errors and diagnostic information. Sending logs to `stderr` helps to separate log messages from the normal output of the program, making it easier to manage and analyze logs.

Here's a summary of the best practices:

- **stdout**: Use for regular program output, such as the results of a command or data that the program is designed to produce.
- **stderr**: Use for logging errors, warnings, and diagnostic information.

By following this convention, you can ensure that logs are properly handled and can be redirected or processed separately from the main output of your server software.

So, Tenderdash behavior to send logs to stderr is correct. For a particular use case of Docker, I decided to join these streams for usability.

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[shumkov]

👍