Skip to content

Commit 97dc6ea

Browse files
dhtclkBlargian
andauthored
Apply suggestions from code review
Co-authored-by: Shaun Struwig <41984034+Blargian@users.noreply.github.com>
1 parent 22238e4 commit 97dc6ea

File tree

5 files changed

+18
-20
lines changed

5 files changed

+18
-20
lines changed

docs/_snippets/_community_monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Community Monitoring Solutions {#community-monitoring}
1+
## Community monitoring solutions {#community-monitoring}
22

33
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.
44

docs/_snippets/_direct_observability_integration_options.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ For plugin installation and configuration details, see the ClickHouse data sourc
1010
### Direct Datadog Integration {#direct-datadog}
1111

1212
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+
:::
1416

1517
### Using system tables directly {#system-tables}
1618

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.
1820

1921
**Query Performance Analysis**
2022

docs/_snippets/_observability_integration_options.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ import NativeAdvancedDashboard from '@site/static/images/cloud/manage/monitoring
55
## Integration examples {#examples}
66

77
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.
99

10-
### Grafana Cloud Monitoring {#grafana}
10+
### Grafana Cloud monitoring {#grafana}
1111

1212
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.
1313
Datadog monitoring

docs/use-cases/observability/cloud-monitoring.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,35 +12,33 @@ import ObservabilityIntegrations from '@site/docs/_snippets/_observability_integ
1212
import DirectIntegrations from '@site/docs/_snippets/_direct_observability_integration_options.md';
1313
import CommunityMonitoring from '@site/docs/_snippets/_community_monitoring.md';
1414

15-
# ClickHouse Cloud Monitoring {#cloud-monitoring}
15+
# ClickHouse Cloud monitoring {#cloud-monitoring}
1616

1717
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.
1818

19-
## Advanced Observability Dashboard {#advanced-observability}
19+
## Advanced observability dashboard {#advanced-observability}
2020

2121
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.
2222

2323
- **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.
2424

2525
:::note
26-
2726
Accessing these metrics does not issue a query to the underlying service and will not wake idle services.
28-
2927
:::
3028

3129
<Image img={AdvancedDashboard} size="lg" alt="Advanced dashboard"/>
3230

33-
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.
3432

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.
3634

3735
<Image img={NativeAdvancedDashboard} size="lg" alt="Advanced dashboard"/>
3836

3937
Both dashboards offer immediate visibility into service health and performance without external dependencies, distinguishing them from external debugging-focused tools like ClickStack.
4038

4139
For detailed dashboard features and available metrics, see the [advanced dashboard documentation](/cloud/manage/monitor/advanced-dashboard).
4240

43-
## Query Insights and Resource Monitoring {#query-insights}
41+
## Query insights and resource monitoring {#query-insights}
4442

4543
ClickHouse Cloud includes additional monitoring capabilities:
4644

@@ -58,9 +56,7 @@ The organization-level endpoint federates metrics from all services, while per-s
5856
- Cached metric delivery: Uses materialized views refreshed every minute to minimize query load on production systems
5957

6058
:::note
61-
6259
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-
6460
:::
6561

6662
<ObservabilityIntegrations/>
@@ -75,7 +71,7 @@ This approach is ideal for debugging complex issues, performance analysis, and d
7571
Note that this approach will wake idle services as HyperDX queries the system tables directly.
7672
:::
7773

78-
### ClickStack Deployment Options {#clickstack-deployment}
74+
### ClickStack deployment options {#clickstack-deployment}
7975

8076
- **HyperDX in Clickhouse Cloud** (private preview): HyperDX can be launched on any Clickhouse Cloud service.
8177
- [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
9288

9389
<CommunityMonitoring/>
9490

95-
## System Impact Considerations {#system-impact}
91+
## System impact considerations {#system-impact}
9692

9793
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.

docs/use-cases/observability/self-managed-monitoring.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import ObservabilityIntegrations from '@site/docs/_snippets/_observability_integ
99
import DirectIntegrations from '@site/docs/_snippets/_direct_observability_integration_options.md';
1010
import CommunityMonitoring from '@site/docs/_snippets/_community_monitoring.md';
1111

12-
# Self-Managed Monitoring {#cloud-monitoring}
12+
# Self-managed monitoring {#cloud-monitoring}
1313

1414
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.
1515

16-
### Prometheus-Based Integration Architecture {#prometheus}
16+
### Prometheus-based integration architecture {#prometheus}
1717
ClickHouse exposes Prometheus-compatible metrics through different endpoints depending on your deployment model, each with distinct operational characteristics:
1818

1919
**Self-Managed/OSS ClickHouse**
@@ -28,7 +28,7 @@ Queries production system tables, which adds monitoring load and prevents cost-s
2828

2929
<ObservabilityIntegrations/>
3030

31-
### ClickStack Deployment Options {#clickstack-deployment}
31+
### ClickStack deployment options {#clickstack-deployment}
3232

3333
- [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`.
3434
- [Docker Compose](/use-cases/observability/clickstack/deployment/docker-compose): Deploys each component (ClickHouse, HyperDX, OTel collector, MongoDB) individually.

0 commit comments

Comments
 (0)