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

Restructuring Benchmarks #3

Merged
merged 3 commits into from
Jul 7, 2024
Merged

Conversation

madflojo
Copy link
Member

@madflojo madflojo commented Jul 7, 2024

This pull request removes the generic Benchmarks module and moves all the benchmarks into their respective driver locations.

As I split each driver into its own module, a massive benchmark module doesn't make sense, as it would complicate validating benchmark results.

Summary by CodeRabbit

  • New Features
    • Introduced benchmarking functionality for bbolt, Cassandra, hashmap, NATS, and Redis drivers to measure performance under various operations.
    • Enhanced GitHub Actions workflow to automate downloading and storing benchmark data.

Copy link
Contributor

coderabbitai bot commented Jul 7, 2024

Warning

Rate limit exceeded

@madflojo has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 30 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between d740cda and 2147723.

Walkthrough

The recent updates focus on enhancing benchmarking functionality across various database drivers. The primary changes involve altering benchmark execution paths and introducing new GitHub Actions steps for handling benchmark data. Benchmarking functions have been newly implemented or updated in drivers for bbolt, Cassandra, hashmap, NATS, and Redis, enabling performance evaluations for key operations.

Changes

Files Change Summary
.github/workflows/benchmarks.yml Adjusted paths for benchmarks and added steps for data handling in GitHub Actions.
drivers/bbolt/benchmark_test.go
drivers/nats/benchmark_test.go
drivers/redis/benchmark_test.go
Introduced benchmarking for Drivers function.
drivers/cassandra/benchmark_test.go
drivers/hashmap/benchmark_test.go
Implemented benchmarking functions for database operations.

Sequence Diagram(s)

No sequence diagrams are necessary for these changes, as they involve routine additions and adjustments to benchmarking code.

Poem

In the land of code where databases weave,
Benchmarks now dance, their numbers cleave.
From bbolt to NATS, they all must race,
To prove their speed in this digital space.
GitHub Actions join the lore,
Storing data, ever more.
🌟 The rabbit cheers, "Benchmark galore!" 🌟


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

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: 19

Outside diff range and nitpick comments (3)
drivers/redis/benchmark_test.go (3)

54-54: Improve error messages.

Include context in the error message to make debugging easier.

- b.Fatalf("Got unexpected error when connecting to Redis - %s", err)
+ b.Fatalf("Got unexpected error when connecting to Redis (%s) - %s", datastore, err)

68-68: Improve error messages.

Include context in the error message to make debugging easier.

- b.Fatalf("Error while checking health of DB - %s", err)
+ b.Fatalf("Error while checking health of DB (%s) - %s", datastore, err)

111-113: Improve error messages.

Include context in the error message to make debugging easier.

- b.Fatalf("Error when executing Benchmark test - %s", err)
+ b.Fatalf("Error when executing Benchmark test (%s) - %s", datastore, err)
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3c6584c and 2ea4a0e.

Files ignored due to path filters (1)
  • benchmarks/go.sum is excluded by !**/*.sum
Files selected for processing (6)
  • .github/workflows/benchmarks.yml (6 hunks)
  • drivers/bbolt/benchmark_test.go (1 hunks)
  • drivers/cassandra/benchmark_test.go (1 hunks)
  • drivers/hashmap/benchmark_test.go (1 hunks)
  • drivers/nats/benchmark_test.go (1 hunks)
  • drivers/redis/benchmark_test.go (1 hunks)
Additional comments not posted (1)
drivers/redis/benchmark_test.go (1)

1-120: LGTM!

The function is well-structured and includes comprehensive benchmarking for Redis, Dragonfly, and KeyDB datastores.

drivers/redis/benchmark_test.go Show resolved Hide resolved
drivers/redis/benchmark_test.go Show resolved Hide resolved
.github/workflows/benchmarks.yml Show resolved Hide resolved
.github/workflows/benchmarks.yml Show resolved Hide resolved
.github/workflows/benchmarks.yml Show resolved Hide resolved
drivers/bbolt/benchmark_test.go Show resolved Hide resolved
drivers/bbolt/benchmark_test.go Outdated Show resolved Hide resolved
drivers/cassandra/benchmark_test.go Show resolved Hide resolved
drivers/cassandra/benchmark_test.go Show resolved Hide resolved
drivers/cassandra/benchmark_test.go Show resolved Hide resolved
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 2ea4a0e and d740cda.

Files selected for processing (1)
  • .github/workflows/benchmarks.yml (7 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/benchmarks.yml

Copy link

codecov bot commented Jul 7, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@madflojo madflojo merged commit 7f8ac9f into tarmac-project:main Jul 7, 2024
24 of 25 checks passed
@madflojo madflojo deleted the benchmarks branch July 7, 2024 15:27
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.

1 participant