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

Problem: block-stm executor status not logged #1548

Merged
merged 1 commit into from
Aug 14, 2024

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Aug 14, 2024

Solution:

  • add a log with the number of workers

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

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

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

  • New Features

    • Enhanced worker configuration by automatically setting the number of workers based on available CPU cores when no explicit value is provided.
    • Added logging for improved monitoring of the number of workers in use.
  • Bug Fixes

    • Improved application performance by ensuring a sensible default for worker count, potentially reducing crashes or slowdowns in worker-driven tasks.

Solution:
- add a log with the number of workers
@yihuang yihuang requested a review from a team as a code owner August 14, 2024 01:34
@yihuang yihuang requested review from mmsqe and thomas-nguy and removed request for a team August 14, 2024 01:34
Copy link
Contributor

coderabbitai bot commented Aug 14, 2024

Walkthrough

The recent changes enhance the New function in app/app.go by introducing a mechanism to set the number of workers dynamically. When the specified worker count is zero, it defaults to the number of available CPU cores using stdruntime.NumCPU(). This adjustment promotes better performance while simplifying configuration. Additionally, a logging statement has been added to provide insights into the worker count in use, improving debugging and monitoring capabilities.

Changes

Files Change Summary
app/app.go Modified the New function to conditionally assign the number of workers based on stdruntime.NumCPU(), and added a logging statement for worker count.

Poem

In the land of code where the rabbits play,
Workers now hop in a smarter way! 🐇✨
With cores aplenty, they dance and weave,
Making tasks lighter, we all believe!
So let’s celebrate this clever fix,
A more agile app, it’s a coding mix! 🌟


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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@yihuang yihuang enabled auto-merge August 14, 2024 01:34
Copy link

codecov bot commented Aug 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 34.79%. Comparing base (bc5dfc5) to head (4d5c96a).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1548      +/-   ##
==========================================
- Coverage   36.12%   34.79%   -1.34%     
==========================================
  Files          97       97              
  Lines        7725     7725              
==========================================
- Hits         2791     2688     -103     
- Misses       4585     4722     +137     
+ Partials      349      315      -34     

see 7 files with indirect coverage changes

@@ -12,6 +12,7 @@
"net/http"
"os"
"path/filepath"
stdruntime "runtime"

Check notice

Code scanning / CodeQL

Sensitive package import Note

Certain system packages contain functions which may be a possible source of non-determinism
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bc5dfc5 and 4d5c96a.

Files selected for processing (1)
  • app/app.go (2 hunks)
Additional context used
GitHub Check: CodeQL
app/app.go

[notice] 15-15: Sensitive package import
Certain system packages contain functions which may be a possible source of non-determinism

Additional comments not posted (2)
app/app.go (2)

15-15: Usage of stdruntime is appropriate.

The import of stdruntime is necessary to determine the number of CPU cores for setting a default worker count. While flagged by CodeQL, this use case is justified and not a source of concern.

Tools
GitHub Check: CodeQL

[notice] 15-15: Sensitive package import
Certain system packages contain functions which may be a possible source of non-determinism


428-431: Confirm logic and verify log level for worker count.

The logic for setting the number of workers using stdruntime.NumCPU() when none is specified is correct. The logging statement enhances visibility. Ensure that the log level used here is appropriate for your logging strategy.

Verification successful

Log level for worker count is appropriate.

The use of Info level for logging the number of workers is suitable, as it provides relevant information about the application state without being overly verbose. This aligns well with typical logging strategies.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the log level for the worker count logging statement.

# Test: Search for logging statements in the `New` function. Expect: Appropriate log level for worker count.
rg --type go -A 3 'logger\.Info\("block-stm executor enabled", "workers", workers\)'

Length of output: 321

@yihuang yihuang added this pull request to the merge queue Aug 14, 2024
Merged via the queue into crypto-org-chain:main with commit af15fa3 Aug 14, 2024
44 of 45 checks passed
@yihuang yihuang deleted the log-stm-workers branch August 14, 2024 06:21
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