From ff1edfee69dfad06eb7e0cb9dc9ffa5eb90938f7 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 4 Jul 2026 09:59:00 +0000 Subject: [PATCH] docs: add CDC resource utilization metrics for ClickPipes --- integrations/clickpipes/monitoring.mdx | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/integrations/clickpipes/monitoring.mdx b/integrations/clickpipes/monitoring.mdx index 8ba2b29e0..da9e39399 100644 --- a/integrations/clickpipes/monitoring.mdx +++ b/integrations/clickpipes/monitoring.mdx @@ -88,14 +88,30 @@ ClickPipes_Latency{clickhouse_org="11dfa1ec-767d-43cb-bfad-618ce2aaf959",clickho | `ClickPipes_Latency` | Gauge (_avg_) | Time in milliseconds between when a record was produced at the source and when it was written to ClickHouse. | | `ClickPipes_SourceReplicationLatency_MiB` | Gauge (_avg_) | **CDC ClickPipes** Replication lag at the source in MiB. For Postgres ClickPipes, this reflects the replication slot lag. | -### Resource usage {#metrics-resources} +### Resource utilization {#metrics-resources} + +#### Streaming and object storage ClickPipes {#metrics-resources-streaming-os} + +`ClickPipes_Replica_*` metrics report resource utilization for streaming and object storage ClickPipes. Each ClickPipe has **dedicated compute**, so these values reflect utilization for individual ClickPipes. + +| Metric | Type | Description | +|----------------------------------|----------------|-------------| +| `ClickPipes_Replica_CPUUsage` | Gauge (_avg_) | Average CPU usage of the ingestion replicas, in millicores. | +| `ClickPipes_Replica_CPULimit` | Gauge (_last_) | Configured CPU limit of the ingestion replicas, in millicores. | +| `ClickPipes_Replica_MemoryUsage` | Gauge (_avg_) | Average memory usage of the ingestion replicas, in bytes. | +| `ClickPipes_Replica_MemoryLimit` | Gauge (_last_) | Configured memory limit of the ingestion replicas, in bytes. | + +#### CDC ClickPipes {#metrics-resources-cdc} + +`ClickPipes_CDC_*` metrics report resource utilization for CDC ClickPipes. All CDC ClickPipes in the same service **share compute**, so these values reflect the combined usage of every CDC ClickPipe in the service. | Metric | Type | Description | |----------------------------------|----------------|-------------| -| `ClickPipes_Replica_CPUUsage` | Gauge (_avg_) | Average CPU usage of the ingestion replicas, in millicores. | -| `ClickPipes_Replica_CPULimit` | Gauge (_last_) | Configured CPU limit of the ingestion replicas, in millicores. | -| `ClickPipes_Replica_MemoryUsage` | Gauge (_avg_) | Average memory usage of the ingestion replicas, in bytes. | -| `ClickPipes_Replica_MemoryLimit` | Gauge (_last_) | Configured memory limit of the ingestion replicas, in bytes. | +| `ClickPipes_CDC_CPUUsage` | Gauge (_avg_) | Average CPU usage, in millicores. Shared across all CDC ClickPipes in the service. | +| `ClickPipes_CDC_CPULimit` | Gauge (_last_) | Configured CPU limit, in millicores. Shared across all CDC ClickPipes in the service. | +| `ClickPipes_CDC_MemoryUsage` | Gauge (_avg_) | Average memory usage, in bytes. Shared across all CDC ClickPipes in the service. | +| `ClickPipes_CDC_MemoryLimit` | Gauge (_last_) | Configured memory limit, in bytes. Shared across all CDC ClickPipes in the service. | +| `ClickPipes_CDC_NetworkReceiveBytes` | Gauge | Inbound network bandwidth, in bytes (delta per scrape window). Shared across all CDC ClickPipes in the service. | ### State and progress {#metrics-state}