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

Feature Request: Enhance blacklist logging visibility (Issue #1333) #1334

Conversation

Perseverance42
Copy link

This PR implements the proposed changes from #1333, addressing the issue with logging levels. Initially, I intended to use the warn log level, but it appears that the Warn() method lacks implementation in "github.com/tendermint/tendermint/libs/log". Therefore, I opted for the error log level to ensure visibility, considering the importance of the logs in question.

To minimize operator confusion, it could be beneficial to further clarify the log messages to indicate that this level of logging is intentional and chosen for its visibility before merging.

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
    Based on release/v1.0.x since it is the origin of the change in Problem: black list addresses are not logged #1328
  • Have you checked your code compiles? (make)
  • [ ] Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • [ ] If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • [ ] If your changes affect the client infrastructure, have you run the integration test?
  • [ ] If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
    - [ ] If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

I'm eager to learn and improve through this contribution process, so I welcome any feedback or suggestions.
Thank you for considering my PR.

Copy link
Contributor

coderabbitai bot commented Mar 3, 2024

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

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

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

@Perseverance42
Copy link
Author

As per the contribution guidelines, I hereby affirm that my contribution is in accordance with the Developer's Certificate of Origin.

@Perseverance42 Perseverance42 marked this pull request as ready for review March 3, 2024 16:28
@Perseverance42 Perseverance42 requested a review from a team as a code owner March 3, 2024 16:28
@Perseverance42 Perseverance42 requested review from yihuang and thomas-nguy and removed request for a team March 3, 2024 16:28
@Perseverance42
Copy link
Author

I tested the build binary on the production environment and the logging worked as expected.

@yihuang
Copy link
Collaborator

yihuang commented Mar 4, 2024

@Perseverance42 can you sign the commits?

@Perseverance42 Perseverance42 force-pushed the warn-blacklist-logging branch from 418a65e to 3c3ce1d Compare March 4, 2024 09:15
Solution: raised logging severity to 'error'
Signed-off-by: Bladerox <perseverance-pool@gmx.de>
@Perseverance42 Perseverance42 force-pushed the warn-blacklist-logging branch from 3c3ce1d to 982f32b Compare March 4, 2024 09:30
@Perseverance42
Copy link
Author

The commit is signed now.

@yihuang yihuang enabled auto-merge (squash) March 5, 2024 03:20
@yihuang yihuang merged commit 92bb449 into crypto-org-chain:release/v1.0.x Mar 5, 2024
36 checks passed
yihuang added a commit to yihuang/cronos that referenced this pull request Mar 26, 2024
Update app/app.go

Signed-off-by: yihuang <huang@crypto.com>

update log

Problem: blacklist logging visibilty to low (crypto-org-chain#1334)

Solution: raised logging severity to 'error'

Signed-off-by: Bladerox <perseverance-pool@gmx.de>
Co-authored-by: Bladerox <pa.sa95@gmx.de>
github-merge-queue bot pushed a commit that referenced this pull request Mar 26, 2024
* Problem: black list addresses are not logged (#1328)

Update app/app.go

Signed-off-by: yihuang <huang@crypto.com>

update log

Problem: blacklist logging visibilty to low (#1334)

Solution: raised logging severity to 'error'

Signed-off-by: Bladerox <perseverance-pool@gmx.de>
Co-authored-by: Bladerox <pa.sa95@gmx.de>

* Update CHANGELOG.md

Signed-off-by: yihuang <huang@crypto.com>

* bump version

* fix conflict

* fix build

---------

Signed-off-by: Bladerox <perseverance-pool@gmx.de>
Signed-off-by: yihuang <huang@crypto.com>
Co-authored-by: Bladerox <pa.sa95@gmx.de>
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.

2 participants