Skip to content

Add ClickHouse destination docs#36923

Draft
Jansen-w wants to merge 1 commit into
masterfrom
jansen-w/op-clickhouse-destination
Draft

Add ClickHouse destination docs#36923
Jansen-w wants to merge 1 commit into
masterfrom
jansen-w/op-clickhouse-destination

Conversation

@Jansen-w
Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Adds a public documentation page for the new Observability Pipelines ClickHouse destination, which sends logs to a ClickHouse server over the HTTP interface.

The page documents the v1 field surface:

  • HTTP endpoint URL identifier
  • database (optional) and table (required)
  • Insert formats: json_each_row, json_as_object, json_as_string, arrow_stream
  • skip_unknown_fields, date_time_best_effort
  • Compression (gzip with optional level 1-9, or none)
  • Basic authentication
  • TLS settings
  • Batching (max_events, timeout_secs)
  • batch_encoding for arrow_stream (allow_nullable_fields)

Also adds:

  • A new environment-variables partial at layouts/shortcodes/observability_pipelines/configure_existing_pipelines/destination_env_vars/clickhouse.en.md.
  • An entry under the Logs tab on the destinations index page.

Merge instructions

Merge readiness:

  • Ready for merge

AI assistance

Initial draft generated with Claude Code from the destination schema; then manually reviewed for Vale style compliance and to confirm no internal implementation details leak into the public docs.

Additional notes

Draft until the in-product UI strings and field labels are confirmed against the released UI.

Documents the new Observability Pipelines ClickHouse destination,
including the HTTP endpoint, target table/database, insert formats
(json_each_row, json_as_object, json_as_string, arrow_stream),
skip_unknown_fields, date_time_best_effort, compression, basic auth,
TLS, batching, and arrow_stream batch encoding.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label May 21, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant