Skip to content

Commit cbe8052

Browse files
authored
Merge pull request #4485 from ClickHouse/byoc-monitoring
2 parents 994b9bd + f500839 commit cbe8052

File tree

1 file changed

+29
-2
lines changed
  • docs/cloud/features/04_infrastructure

1 file changed

+29
-2
lines changed

docs/cloud/features/04_infrastructure/byoc.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,7 @@ Contact support to schedule maintenance windows. Please expect a minimum of a we
357357
## Observability {#observability}
358358

359359
### Built-in monitoring tools {#built-in-monitoring-tools}
360+
ClickHouse BYOC provides several approaches for various use cases.
360361

361362
#### Observability dashboard {#observability-dashboard}
362363

@@ -378,8 +379,20 @@ You can customize a dashboard using metrics from system tables like `system.metr
378379

379380
<br />
380381

382+
#### Access the BYOC Prometheus stack {#prometheus-access}
383+
ClickHouse BYOC deploys a Prometheus stack on your Kubernetes cluster. You may access and scrape the metrics from there and integrate them with your own monitoring stack.
384+
385+
Contact ClickHouse support to enable the Private Load balancer and ask for the URL. Please note that this URL is only accessible via private network and does not support authentication
386+
387+
**Sample URL**
388+
```bash
389+
https://prometheus-internal.<subdomain>.<region>.aws.clickhouse-byoc.com/query
390+
```
391+
381392
#### Prometheus Integration {#prometheus-integration}
382393

394+
**DEPRECATED: ** Please use the Prometheus stack integration in the above section instead. Besides the ClickHouse Server metrics, it provides more metrics including the K8S metrics and metrics from other services.
395+
383396
ClickHouse Cloud provides a Prometheus endpoint that you can use to scrape metrics for monitoring. This allows for integration with tools like Grafana and Datadog for visualization.
384397

385398
**Sample request via https endpoint /metrics_all**
@@ -419,8 +432,22 @@ ClickHouse_CustomMetric_TotalNumberOfErrors{hostname="c-jet-ax-16-server-43d5baj
419432
A ClickHouse username and password pair can be used for authentication. We recommend creating a dedicated user with minimal permissions for scraping metrics. At minimum, a `READ` permission is required on the `system.custom_metrics` table across replicas. For example:
420433

421434
```sql
422-
GRANT REMOTE ON *.* TO scraping_user
423-
GRANT SELECT ON system.custom_metrics TO scraping_user
435+
GRANT REMOTE ON *.* TO scrapping_user;
436+
GRANT SELECT ON system._custom_metrics_dictionary_custom_metrics_tables TO scrapping_user;
437+
GRANT SELECT ON system._custom_metrics_dictionary_database_replicated_recovery_time TO scrapping_user;
438+
GRANT SELECT ON system._custom_metrics_dictionary_failed_mutations TO scrapping_user;
439+
GRANT SELECT ON system._custom_metrics_dictionary_group TO scrapping_user;
440+
GRANT SELECT ON system._custom_metrics_dictionary_shared_catalog_recovery_time TO scrapping_user;
441+
GRANT SELECT ON system._custom_metrics_dictionary_table_read_only_duration_seconds TO scrapping_user;
442+
GRANT SELECT ON system._custom_metrics_view_error_metrics TO scrapping_user;
443+
GRANT SELECT ON system._custom_metrics_view_histograms TO scrapping_user;
444+
GRANT SELECT ON system._custom_metrics_view_metrics_and_events TO scrapping_user;
445+
GRANT SELECT(description, metric, value) ON system.asynchronous_metrics TO scrapping_user;
446+
GRANT SELECT ON system.custom_metrics TO scrapping_user;
447+
GRANT SELECT(name, value) ON system.errors TO scrapping_user;
448+
GRANT SELECT(description, event, value) ON system.events TO scrapping_user;
449+
GRANT SELECT(description, labels, metric, value) ON system.histogram_metrics TO scrapping_user;
450+
GRANT SELECT(description, metric, value) ON system.metrics TO scrapping_user;
424451
```
425452

426453
**Configuring Prometheus**

0 commit comments

Comments
 (0)