Skip to content

make ch parallel view processing configurable #223

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

Merged
merged 1 commit into from
Jun 10, 2025

Conversation

iuwqyir
Copy link
Collaborator

@iuwqyir iuwqyir commented Jun 10, 2025

TL;DR

Added configuration option to enable parallel view processing for ClickHouse connections.

What changed?

  • Added a new configuration flag enableParallelViewProcessing for all ClickHouse storage types (orchestrator, main, and staging)
  • Modified the ClickHouse connection setup to make parallel view processing optional instead of always enabled
  • Added the corresponding configuration binding in the root command

How to test?

  1. Run the application with the new flag to enable parallel view processing:
    --storage-orchestrator-clickhouse-enableParallelViewProcessing=true
    --storage-main-clickhouse-enableParallelViewProcessing=true
    --storage-staging-clickhouse-enableParallelViewProcessing=true
    
  2. Verify that the ClickHouse connections are established with the parallel_view_processing setting when the flag is enabled
  3. Verify that the setting is not applied when the flag is disabled (default behavior)

Why make this change?

Parallel view processing in ClickHouse can improve query performance for certain workloads, but it's not always desirable for all environments or use cases. Making this setting configurable allows users to enable it only when beneficial for their specific workload patterns, providing more flexibility in optimizing ClickHouse performance.

Summary by CodeRabbit

  • New Features

    • Added new configuration options to enable or disable parallel view processing for Clickhouse storage in orchestrator, main, and staging environments. These can be set via command-line flags or configuration files.
  • Improvements

    • Parallel view processing in Clickhouse is now configurable, allowing greater flexibility in storage settings.

Copy link

coderabbitai bot commented Jun 10, 2025

Walkthrough

A new boolean configuration flag, enableParallelViewProcessing, was introduced for Clickhouse storage in orchestrator, main, and staging contexts. This flag is now available via command-line, config file, and is mapped to the Clickhouse connection logic, which conditionally applies the parallel_view_processing setting based on the flag's value.

Changes

File(s) Change Summary
cmd/root.go Added persistent boolean flags for enableParallelViewProcessing for orchestrator, main, and staging Clickhouse storage; bound them to Viper config keys.
configs/config.go Added EnableParallelViewProcessing boolean field to ClickhouseConfig struct.
internal/storage/clickhouse.go Modified Clickhouse connection logic to set "parallel_view_processing": "1" only if the new config flag is true.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Viper
    participant Config
    participant ClickhouseConnector

    User->>CLI: Start application with flags/config
    CLI->>Viper: Bind flags to config keys
    Viper->>Config: Populate ClickhouseConfig (including EnableParallelViewProcessing)
    Config->>ClickhouseConnector: Pass ClickhouseConfig
    ClickhouseConnector->>ClickhouseConnector: If EnableParallelViewProcessing is true, set "parallel_view_processing": "1"
    ClickhouseConnector->>Clickhouse: Establish connection with settings
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 03325a3 and 05d1071.

📒 Files selected for processing (3)
  • cmd/root.go (5 hunks)
  • configs/config.go (1 hunks)
  • internal/storage/clickhouse.go (1 hunks)
🔇 Additional comments (5)
configs/config.go (1)

85-85: LGTM! Configuration field added correctly.

The new EnableParallelViewProcessing field is properly added to the ClickhouseConfig struct with the correct mapstructure tag.

internal/storage/clickhouse.go (1)

106-109: LGTM! Conditional logic implemented correctly.

The parallel view processing setting is now correctly applied only when EnableParallelViewProcessing is true. This changes the previous behavior where it was always enabled, making it configurable as intended.

cmd/root.go (3)

85-85: LGTM! CLI flags added consistently.

The new enableParallelViewProcessing flags are properly added for all three storage types (orchestrator, main, staging) with descriptive help text and consistent naming.

Also applies to: 95-95, 103-103


170-170: LGTM! Viper bindings configured correctly.

The viper bindings correctly map the CLI flags to their respective configuration paths, maintaining consistency across all storage types.

Also applies to: 181-181, 192-192


85-85: Note: Behavior change from always-enabled to configurable.

The default value false for these flags means parallel view processing will be disabled by default, changing from the previous behavior where it was always enabled. Ensure this aligns with your intended rollout strategy.

You may want to verify that existing deployments won't be negatively impacted by this change. Consider:

  1. Documenting the behavior change in release notes
  2. Providing migration guidance for users who want to maintain the previous behavior
  3. Testing performance impact with the setting disabled

Also applies to: 95-95, 103-103

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Copy link
Collaborator Author

iuwqyir commented Jun 10, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@iuwqyir iuwqyir marked this pull request as ready for review June 10, 2025 10:33
@iuwqyir iuwqyir merged commit 15d07b7 into main Jun 10, 2025
5 of 6 checks passed
@iuwqyir iuwqyir deleted the 06-10-make_ch_parallel_view_processing_configurable branch June 10, 2025 11:08
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