Improve clickhouse client debug logging

[ericallam]

When this is merged we need to set the RUN_REPLICATION_CLICKHOUSE_LOG_LEVEL env var to debug

[changeset-bot]

⚠️ No Changeset found

Latest commit: 12fa884

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

A new environment variable, RUN_REPLICATION_CLICKHOUSE_LOG_LEVEL, was introduced to control the logging level specifically for ClickHouse replication, with possible values including "log", "error", "warn", "info", and "debug", defaulting to "info". The ClickHouse client configuration now uses this variable to set its log level. Additionally, each query and insert operation in the ClickHouse client now generates a unique queryId for enhanced traceability, which is included in logs, span attributes, and request parameters. The logger initialization in the ClickHouse class was updated to use the configured log level, and debug logging was enabled in a related test case.

---

📜 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 aaf40c3 and 12fa884.

📒 Files selected for processing (5)

• apps/webapp/app/env.server.ts (1 hunks)
• apps/webapp/app/services/runsReplicationInstance.server.ts (1 hunks)
• internal-packages/clickhouse/src/client/client.ts (9 hunks)
• internal-packages/clickhouse/src/index.ts (1 hunks)
• internal-packages/clickhouse/src/taskRuns.test.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

`apps/webapp/**/*`: The webapp at apps/webapp is a Remix 2.1 app that uses Node.js v20. Use zod extensively in the webapp.

apps/webapp/**/*: The webapp at apps/webapp is a Remix 2.1 app that uses Node.js v20.
Use zod extensively in the webapp.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

• apps/webapp/app/services/runsReplicationInstance.server.ts
• apps/webapp/app/env.server.ts

`apps/webapp/app/env.server.ts`: All environment variables in the webapp must be accessed through the 'env' export of env.server.ts, never directly via process.env.

apps/webapp/app/env.server.ts: All environment variables in the webapp must be accessed through the 'env' export of env.server.ts, never directly via process.env.

📄 Source: CodeRabbit Inference Engine (.cursor/rules/webapp.mdc)

List of files the instruction was applied to:

• apps/webapp/app/env.server.ts

⏰ Context from checks skipped due to timeout of 90000ms (25)

• GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 10)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (9, 10)
• GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
• GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (10, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 10)
• GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 10)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
• GitHub Check: typecheck / typecheck
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (9)

apps/webapp/app/env.server.ts (1)

834-836: LGTM! Proper environment variable addition.

The new RUN_REPLICATION_CLICKHOUSE_LOG_LEVEL environment variable follows the established pattern and coding guidelines. The enum values and default "info" level are appropriate for ClickHouse-specific logging control.

internal-packages/clickhouse/src/taskRuns.test.ts (1)

11-11: Good addition for testing debug logging functionality.

Adding logLevel: "debug" to the test configuration appropriately exercises the new configurable logging feature and ensures debug output during test execution.

apps/webapp/app/services/runsReplicationInstance.server.ts (1)

32-32: Excellent use of the new ClickHouse-specific log level variable.

This change provides better granular control by separating ClickHouse logging from general replication logging, using the newly added RUN_REPLICATION_CLICKHOUSE_LOG_LEVEL environment variable.

internal-packages/clickhouse/src/index.ts (1)

59-59: Excellent improvement to respect configurable log levels.

The logger initialization now properly uses the configured logLevel instead of hardcoding "debug", while maintaining backward compatibility with the default fallback. This aligns with the dynamic logging improvements.

internal-packages/clickhouse/src/client/client.ts (5)

24-24: Good import addition for UUID generation.

The randomUUID import from node:crypto is the correct choice for generating unique query identifiers.

---

107-107: Excellent addition of unique query identifiers.

Generating a unique queryId for each query and insert operation significantly improves traceability throughout the request lifecycle.

Also applies to: 247-247

---

116-116: Comprehensive queryId integration in query operations.

The queryId is properly integrated into debug logs, error logs, span attributes, and ClickHouse request parameters, providing complete traceability for query operations.

Also applies to: 122-122, 137-137, 155-155, 170-170, 206-206

---

250-259: Enhanced debug logging for insert operations.

The detailed debug logging at the start of insert operations provides valuable visibility into operation parameters and configuration. The structured logging format is well-organized.

---

258-258: Consistent queryId integration in insert operations.

The queryId is consistently added to insert logs, span attributes, request parameters, and success logging, matching the pattern established for query operations.

Also applies to: 265-265, 297-297, 318-324

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • 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.