docs: clarify DialTimeout and Cloud idle behavior#94
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
3 tasks
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Ports ClickHouse/clickhouse-docs#6301: clarifies
DialTimeoutguidance for idled ClickHouse Cloud services in the Go client docs.Changes
integrations/language-clients/go/config-reference.mdx: updatedDialTimeoutrow with Cloud idle guidance and added a<Note>callout explaining wake-up behavior and the1m–2mrecommendation (converted from Docusaurus:::note).integrations/language-clients/go/configuration.mdx: extended theDialTimeoutdescription with a pointer to the Timeouts section.Context
Upstream change: a larger
DialTimeoutavoids first-query failures against an idled Cloud service while it wakes.Note
Low Risk
Documentation-only changes to Go client integration pages; no runtime or API behavior changes.
Overview
Documents how paused ClickHouse Cloud services wake on the first connection and why the default
DialTimeout(30s) can fail the first query after idle.The config reference expands the
DialTimeoutbest-practice and misconfiguration rows for Cloud idle wake-up, and adds a<Note>recommending1m–2mwhen the client may be first to hit an idled service, with tradeoffs (slower outage detection; context deadlines as an alternative). The configuration overview links theDialTimeoutrow to that Timeouts section with the same Cloud guidance.Reviewed by Cursor Bugbot for commit 7379aca. Bugbot is set up for automated code reviews on this repo. Configure here.