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
Copy file name to clipboardExpand all lines: docs/_snippets/_community_monitoring.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
## Community Monitoring Solutions {#community-monitoring}
1
+
## Community monitoring solutions {#community-monitoring}
2
2
3
3
The ClickHouse community has developed comprehensive monitoring solutions that integrate with popular observability stacks. [ClickHouse Monitoring](https://github.com/duyet/clickhouse-monitoring) provides a complete monitoring setup with pre-built dashboards. This open source project offers a quick-start approach for teams looking to implement ClickHouse monitoring with established best practices and proven dashboard configurations.
Copy file name to clipboardExpand all lines: docs/_snippets/_direct_observability_integration_options.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,13 @@ For plugin installation and configuration details, see the ClickHouse data sourc
10
10
### Direct Datadog Integration {#direct-datadog}
11
11
12
12
Datadog offers a Clickhouse Monitoring plugin for its agent which queries system tables directly. This integration provides comprehensive database monitoring with cluster awareness through clusterAllReplicas functionality.
13
-
Note: This integration is not recommended for ClickHouse Cloud deployments due to incompatibility with cost-optimizing idle behavior and operational limitations of the cloud proxy layer.
13
+
:::note
14
+
This integration is not recommended for ClickHouse Cloud deployments due to incompatibility with cost-optimizing idle behavior and operational limitations of the cloud proxy layer.
15
+
:::
14
16
15
17
### Using system tables directly {#system-tables}
16
18
17
-
Users can perform deep query performance analysis by connecting to ClickHouse system tables, particularly system.query_log and querying directly. Using either the SQL console or clickhouse client, teams can identify slow queries, analyze resource usage, and track usage patterns across the organization.
19
+
Users can perform deep query performance analysis by connecting to ClickHouse system tables, particularly `system.query_log` and querying directly. Using either the SQL console or clickhouse client, teams can identify slow queries, analyze resource usage, and track usage patterns across the organization.
Copy file name to clipboardExpand all lines: docs/_snippets/_observability_integration_options.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,9 @@ import NativeAdvancedDashboard from '@site/static/images/cloud/manage/monitoring
5
5
## Integration examples {#examples}
6
6
7
7
External integration allows organizations to maintain established monitoring workflows, leverage existing team expertise with familiar tools, and integrate ClickHouse monitoring with broader infrastructure observability without disrupting current processes or requiring significant retraining investments.
8
-
Teams can apply existing alerting rules and escalation procedures to ClickHouse metrics, while correlating database performance with application and infrastructure health within a unified observability platform. This approach maximizes ROI on current monitoring investments and enables faster troubleshooting through consolidated dashboards and familiar tooling interfaces.
8
+
Teams can apply existing alerting rules and escalation procedures to ClickHouse metrics, while correlating database performance with application and infrastructure health within a unified observability platform. This approach maximizes ROI on current monitoring setups and enables faster troubleshooting through consolidated dashboards and familiar tooling interfaces.
9
9
10
-
### Grafana Cloud Monitoring {#grafana}
10
+
### Grafana Cloud monitoring {#grafana}
11
11
12
12
Grafana provides ClickHouse monitoring through both direct plugin integration and Prometheus-based approaches. The Prometheus endpoint integration maintains operational separation between monitoring and production workloads while enabling visualization within existing Grafana Cloud infrastructure. See Grafana's ClickHouse documentation for configuration guidance.
Copy file name to clipboardExpand all lines: docs/use-cases/observability/cloud-monitoring.md
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,35 +12,33 @@ import ObservabilityIntegrations from '@site/docs/_snippets/_observability_integ
12
12
import DirectIntegrations from '@site/docs/_snippets/_direct_observability_integration_options.md';
13
13
import CommunityMonitoring from '@site/docs/_snippets/_community_monitoring.md';
14
14
15
-
# ClickHouse Cloud Monitoring {#cloud-monitoring}
15
+
# ClickHouse Cloud monitoring {#cloud-monitoring}
16
16
17
17
This guide provides enterprise teams evaluating ClickHouse Cloud with comprehensive information on monitoring and observability capabilities for production deployments. Enterprise customers frequently ask about out-of-the-box monitoring features, integration with existing observability stacks including tools like Datadog and AWS CloudWatch, and how ClickHouse’s monitoring compares to self-hosted deployments.
ClickHouse Cloud provides comprehensive monitoring through built-in dashboard interfaces accessible via the Monitoring section. These dashboards visualize system and performance metrics in real-time without requiring additional setup and serve as the primary tools for real-time production monitoring within ClickHouse Cloud.
22
22
23
23
-**Advanced Dashboard**: The main dashboard interface accessible via Monitoring → Advanced dashboard provides real-time visibility into query rates, resource usage, system health, and storage performance. This dashboard doesn't require separate authentication, won't prevent instances from idling, and doesn't add query load to your production system. Each visualization is powered by customizable SQL queries, with out-of-the-box charts grouped into ClickHouse-specific, system health, and Cloud-specific metrics. Users can extend monitoring by creating custom queries directly in the SQL console.
24
24
25
25
:::note
26
-
27
26
Accessing these metrics does not issue a query to the underlying service and will not wake idle services.
Users looking to extend these visualizations can use the Dashboards feature in ClickHouse Cloud, querying system tables directly.
31
+
Users looking to extend these visualizations can use the dashboards feature in ClickHouse Cloud, querying system tables directly.
34
32
35
-
-**Native Advanced Dashboard**: An alternative dashboard interface accessible through "You can still access the native advanced dashboard" within the Monitoring section. This opens in a separate tab with authentication and provides an alternative UI for system and service health monitoring. This dashboard allows advanced analytics, where users can modify the underlying SQL queries.
33
+
-**Native advanced dashboard**: An alternative dashboard interface accessible through "You can still access the native advanced dashboard" within the Monitoring section. This opens in a separate tab with authentication and provides an alternative UI for system and service health monitoring. This dashboard allows advanced analytics, where users can modify the underlying SQL queries.
Both dashboards offer immediate visibility into service health and performance without external dependencies, distinguishing them from external debugging-focused tools like ClickStack.
40
38
41
39
For detailed dashboard features and available metrics, see the [advanced dashboard documentation](/cloud/manage/monitor/advanced-dashboard).
42
40
43
-
## Query Insights and Resource Monitoring {#query-insights}
41
+
## Query insights and resource monitoring {#query-insights}
44
42
45
43
ClickHouse Cloud includes additional monitoring capabilities:
46
44
@@ -58,9 +56,7 @@ The organization-level endpoint federates metrics from all services, while per-s
58
56
- Cached metric delivery: Uses materialized views refreshed every minute to minimize query load on production systems
59
57
60
58
:::note
61
-
62
59
This approach respects service idling behavior, allowing for cost optimization when services are not actively processing queries. This API endpoint relies on ClickHouse Cloud API credentials. For complete endpoint configuration details, see the cloud [Prometheus documentation](/integrations/prometheus).
63
-
64
60
:::
65
61
66
62
<ObservabilityIntegrations/>
@@ -75,7 +71,7 @@ This approach is ideal for debugging complex issues, performance analysis, and d
75
71
Note that this approach will wake idle services as HyperDX queries the system tables directly.
-**HyperDX in Clickhouse Cloud** (private preview): HyperDX can be launched on any Clickhouse Cloud service.
81
77
-[Helm](/use-cases/observability/clickstack/deployment/helm): Recommended for Kubernetes-based debugging environments. Supports integration with ClickHouse Cloud and allows for environment-specific configuration, resource limits, and scaling via `values.yaml`.
@@ -92,7 +88,7 @@ Users can also collect metrics from the ClickHouse Cloud Prometheus endpoint via
92
88
93
89
<CommunityMonitoring/>
94
90
95
-
## System Impact Considerations {#system-impact}
91
+
## System impact considerations {#system-impact}
96
92
97
93
All of the above approaches use a mixture of either relying on Prometheus endpoints, being managed by ClickHouse Cloud, or querying of system tables directly.
98
-
The latter of these options relies on querying the production ClickHouse service. This adds query load to the system under observation and prevents ClickHouse Cloud instances from idling, impacting cost optimization. Additionally, if the production system fails, monitoring may also be affected since they are coupled. This approach works well for deep introspection and debugging but is less appropriate for real-time production monitoring. Consider these trade-offs between detailed system analysis capabilities and operational overhead when evaluating direct Grafana integration versus the external tool integration approaches discussed in the following section.
94
+
The latter of these options relies on querying the production ClickHouse service. This adds query load to the system under observation and prevents ClickHouse Cloud instances from idling, impacting cost optimization. Additionally, if the production system fails, monitoring may also be affected, since the two are coupled. This approach works well for deep introspection and debugging but is less appropriate for real-time production monitoring. Consider these trade-offs between detailed system analysis capabilities and operational overhead when evaluating direct Grafana integration versus the external tool integration approaches discussed in the following section.
Copy file name to clipboardExpand all lines: docs/use-cases/observability/self-managed-monitoring.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,11 @@ import ObservabilityIntegrations from '@site/docs/_snippets/_observability_integ
9
9
import DirectIntegrations from '@site/docs/_snippets/_direct_observability_integration_options.md';
10
10
import CommunityMonitoring from '@site/docs/_snippets/_community_monitoring.md';
11
11
12
-
# Self-Managed Monitoring {#cloud-monitoring}
12
+
# Self-managed monitoring {#cloud-monitoring}
13
13
14
14
This guide provides enterprise teams evaluating ClickHouse open-source with comprehensive information on monitoring and observability capabilities for production deployments. Enterprise customers frequently ask about out-of-the-box monitoring features, integration with existing observability stacks including tools like Datadog and AWS CloudWatch, and how ClickHouse’ss monitoring compares to self-hosted deployments.
ClickHouse exposes Prometheus-compatible metrics through different endpoints depending on your deployment model, each with distinct operational characteristics:
18
18
19
19
**Self-Managed/OSS ClickHouse**
@@ -28,7 +28,7 @@ Queries production system tables, which adds monitoring load and prevents cost-s
-[Helm](/use-cases/observability/clickstack/deployment/helm): Recommended for Kubernetes-based debugging environments. Allows for environment-specific configuration, resource limits, and scaling via `values.yaml`.
0 commit comments