-
Notifications
You must be signed in to change notification settings - Fork 400
Update BYOC Monitoring integration #4485
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -357,6 +357,7 @@ | |||||||||
| ## Observability {#observability} | ||||||||||
|
|
||||||||||
| ### Built-in monitoring tools {#built-in-monitoring-tools} | ||||||||||
| ClickHouse BYOC provides several approaches for various use cases. | ||||||||||
|
|
||||||||||
| #### Observability dashboard {#observability-dashboard} | ||||||||||
|
|
||||||||||
|
|
@@ -378,8 +379,20 @@ | |||||||||
|
|
||||||||||
| <br /> | ||||||||||
|
|
||||||||||
| #### Access the BYOC Prometheus stack {#prometheus-access} | ||||||||||
| 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. | ||||||||||
|
|
||||||||||
| 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 | ||||||||||
|
|
||||||||||
| **Sample URL** | ||||||||||
| ```bash | ||||||||||
| https://prometheus-internal.<subdomain>.<region>.aws.clickhouse-byoc.com/query | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| #### Prometheus Integration {#prometheus-integration} | ||||||||||
|
|
||||||||||
| **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. | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
It will show up something like this with "DEPRECATED" as the header of the block |
||||||||||
|
|
||||||||||
| 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. | ||||||||||
|
|
||||||||||
| **Sample request via https endpoint /metrics_all** | ||||||||||
|
|
@@ -419,8 +432,22 @@ | |||||||||
| 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: | ||||||||||
|
|
||||||||||
| ```sql | ||||||||||
| GRANT REMOTE ON *.* TO scraping_user | ||||||||||
| GRANT SELECT ON system.custom_metrics TO scraping_user | ||||||||||
| GRANT REMOTE ON *.* TO scrapping_user; | ||||||||||
| GRANT SELECT ON system._custom_metrics_dictionary_custom_metrics_tables TO scrapping_user; | ||||||||||
| GRANT SELECT ON system._custom_metrics_dictionary_database_replicated_recovery_time TO scrapping_user; | ||||||||||
| GRANT SELECT ON system._custom_metrics_dictionary_failed_mutations TO scrapping_user; | ||||||||||
| GRANT SELECT ON system._custom_metrics_dictionary_group TO scrapping_user; | ||||||||||
| GRANT SELECT ON system._custom_metrics_dictionary_shared_catalog_recovery_time TO scrapping_user; | ||||||||||
| GRANT SELECT ON system._custom_metrics_dictionary_table_read_only_duration_seconds TO scrapping_user; | ||||||||||
| GRANT SELECT ON system._custom_metrics_view_error_metrics TO scrapping_user; | ||||||||||
| GRANT SELECT ON system._custom_metrics_view_histograms TO scrapping_user; | ||||||||||
| GRANT SELECT ON system._custom_metrics_view_metrics_and_events TO scrapping_user; | ||||||||||
| GRANT SELECT(description, metric, value) ON system.asynchronous_metrics TO scrapping_user; | ||||||||||
| GRANT SELECT ON system.custom_metrics TO scrapping_user; | ||||||||||
| GRANT SELECT(name, value) ON system.errors TO scrapping_user; | ||||||||||
| GRANT SELECT(description, event, value) ON system.events TO scrapping_user; | ||||||||||
| GRANT SELECT(description, labels, metric, value) ON system.histogram_metrics TO scrapping_user; | ||||||||||
| GRANT SELECT(description, metric, value) ON system.metrics TO scrapping_user; | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| **Configuring Prometheus** | ||||||||||
|
|
||||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.