From 58b681e06cf6c5e3760a6fbc3b91aed180acaf37 Mon Sep 17 00:00:00 2001
From: Doug Smith <doug.smith@datadoghq.com>
Date: Thu, 22 Jun 2023 14:15:50 -0400
Subject: [PATCH] add module doc

---
 src/sinks/clickhouse/mod.rs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/sinks/clickhouse/mod.rs b/src/sinks/clickhouse/mod.rs
index b2640cb573c58..488df9181a8bf 100644
--- a/src/sinks/clickhouse/mod.rs
+++ b/src/sinks/clickhouse/mod.rs
@@ -1,3 +1,14 @@
+//! The Clickhouse [`vector_core::sink::VectorSink`]
+//!
+//! This module contains the [`vector_core::sink::VectorSink`] instance that is responsible for
+//! taking a stream of [`vector_core::event::Event`] instances and forwarding them to Clickhouse.
+//!
+//! Events are sent to Clickhouse using the HTTP interface with a query of the following structure:
+//! `INSERT INTO my_db.my_table FORMAT JSONEachRow`. The event payload is encoded as new-line
+//! delimited JSON.
+//!
+//! This sink only supports logs for now but could support metrics and traces as well in the future.
+
 mod config;
 #[cfg(all(test, feature = "clickhouse-integration-tests"))]
 mod integration_tests;