You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updates the v4 migration guide to document the ClickHouse requirement.
Changes
Added a new "ClickHouse" section to the breaking changes
Documented that v4 now uses ClickHouse by default for storing run traces and analytics data
Listed all required environment variables for ClickHouse configuration:
CLICKHOUSE_URL
CLICKHOUSE_LOG_LEVEL
RUN_REPLICATION_ENABLED
RUN_REPLICATION_CLICKHOUSE_URL
RUN_REPLICATION_LOG_LEVEL
Added instructions for Docker Compose users to update their configuration
Linked to the complete docker-compose.yml example on GitHub
Why
Users migrating from v3 to v4 need to know that ClickHouse is now dependency and how to configure it properly, especially when self-hosting or using Docker Compose.
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.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
A ClickHouse subsection was added to docs/migrating-from-v3.mdx under the OpenTelemetry/BatchTrigger migration area. It documents that V4 uses ClickHouse by default for storing run traces and analytics, provides Docker Compose guidance, lists environment variables (CLICKHOUSE_URL, CLICKHOUSE_LOG_LEVEL, RUN_REPLICATION_ENABLED, RUN_REPLICATION_CLICKHOUSE_URL, RUN_REPLICATION_LOG_LEVEL), and includes sample configuration. The existing OpenTelemetry section remains with updated package version notes.
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~5 minutes
Pre-merge checks and finishing touches
✅ Passed checks (3 passed)
Check name
Status
Explanation
Title Check
✅ Passed
The PR title "docs: add ClickHouse environment variables and Docker Compose" is directly related to the main changes in the changeset. It clearly identifies that this is a documentation update and highlights the two key components being added: ClickHouse environment variables and Docker Compose guidance. The title is concise, specific, and accurately summarizes the primary purpose of the changes without unnecessary verbosity or vague language.
Docstring Coverage
✅ Passed
No functions found in the changes. Docstring coverage check skipped.
Description Check
✅ Passed
The pull request description provides a clear and comprehensive overview of the changes being made to the v4 migration guide documentation. It includes a detailed description section, a well-organized list of changes with specific environment variables documented, and the rationale for the update. The author completed two of three checklist items and provided a screenshot. However, the description deviates from the template in several ways: the required "Closes #" reference is missing, the Testing section is minimal (just "NO" without explanation), the Changelog section is also minimal, and the third checklist item is not marked as completed. While these are present in the template structure, their content is sparse or absent.
✨ Finishing touches
📝 Generate docstrings
🧪 Generate unit tests (beta)
Create PR with unit tests
Post copyable unit tests in a comment
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Updates the v4 migration guide to document the ClickHouse requirement.
Changes
CLICKHOUSE_URLCLICKHOUSE_LOG_LEVELRUN_REPLICATION_ENABLEDRUN_REPLICATION_CLICKHOUSE_URLRUN_REPLICATION_LOG_LEVELWhy
Users migrating from v3 to v4 need to know that ClickHouse is now dependency and how to configure it properly, especially when self-hosting or using Docker Compose.
✅ Checklist
Testing
NO
Changelog
NO
Screenshots
💯