BYOC 배포에는 포괄적인 관측성 기능이 포함되어 있어, 전용 Prometheus 모니터링 스택과 ClickHouse 서버에서 직접 제공되는 메트릭 엔드포인트를 통해 ClickHouse 서비스를 모니터링할 수 있습니다. 모든 관측성 데이터는 클라우드 계정 내에 유지되므로 모니터링 인프라를 완전히 제어할 수 있습니다.
BYOC는 Prometheus를 사용해 메트릭을 수집하고 시각화하는 두 가지 주요 방법을 제공합니다.
- 기본 제공 Prometheus 스택에 연결: BYOC Kubernetes 클러스터 내부에서 실행되는 중앙 집중식 사전 설치 Prometheus 인스턴스에 연결합니다.
- ClickHouse 메트릭 직접 스크레이프: 자체 Prometheus 배포가 각 ClickHouse 서비스에서 노출하는
/metrics_all 엔드포인트를 스크레이프하도록 설정합니다.
| Capability | 기본 제공 Prometheus 스택 | ClickHouse 서비스에서 직접 스크레이프 |
|---|
| 메트릭 범위 | ClickHouse, Kubernetes 및 지원 서비스를 포함한 메트릭을 통합하여 클러스터 전체를 볼 수 있음 | 개별 ClickHouse 서버의 메트릭만 제공 |
| 설정 과정 | 프라이빗 네트워크 액세스를 설정해야 함(예: private load balancer 사용) | Prometheus가 퍼블릭 또는 프라이빗 ClickHouse 엔드포인트를 스크레이프하도록 간단히 구성 |
| 연결 방식 | VPC/네트워크 내의 private load balancer를 통해 연결 | 데이터베이스에 접근할 때 사용하는 것과 동일한 엔드포인트 사용 |
| 인증 | 필요 없음(프라이빗 네트워크로 제한됨) | ClickHouse 서비스 자격 증명 사용 |
| 네트워크 요구 사항 | private load balancer 및 적절한 네트워크 연결 필요 | ClickHouse 엔드포인트에 접근할 수 있는 모든 네트워크에서 사용 가능 |
| 가장 적합한 용도 | 인프라와 서비스를 아우르는 통합 모니터링 | 서비스별 모니터링 및 통합 |
| 통합 방법 | 외부 Prometheus에서 페더레이션을 구성해 클러스터 메트릭을 수집 | ClickHouse 메트릭 엔드포인트를 Prometheus 구성에 직접 추가 |
- ClickHouse 서버와 ClickHouse Keeper
- Kubernetes 클러스터 및 시스템 구성 요소
- 기반 인프라의 노드
기본 제공 Prometheus 스택에 연결하려면 다음 단계를 따르십시오.
- BYOC 환경에서 private load balancer를 활성화하려면 ClickHouse 지원팀에 문의하십시오.
- Prometheus 엔드포인트 URL을 ClickHouse 지원팀에 요청하십시오.
- Prometheus 엔드포인트에 대한 프라이빗 네트워크 연결을 확인하십시오. 일반적으로 VPC peering 또는 기타 프라이빗 네트워크 구성을 통해 확인합니다.
엔드포인트 포맷은 연결 방식에 따라 다릅니다.
| 연결 방식 | 엔드포인트 포맷 |
|---|
| VPC / VPC peering | https://prometheus-internal.<subdomain>.<region>.<cloud>.clickhouse-byoc.com |
| PrivateLink | https://prometheus.vpce.<subdomain>.<region>.<cloud>.clickhouse-byoc.com |
Prometheus 스택 URL은 프라이빗 네트워크 연결을 통해서만 액세스할 수 있으며 인증이 필요하지 않습니다. 액세스는 VPC peering 또는 기타 프라이빗 연결 옵션을 통해 BYOC VPC에 도달할 수 있는 네트워크로 제한됩니다.
- 선호하는 모니터링 플랫폼 또는 사용자 지정 대시보드에서 Prometheus API 엔드포인트에 직접 액세스합니다.
- PromQL 쿼리를 사용하여 필요한 메트릭을 추출, 집계, 시각화합니다.
- 맞춤형 대시보드 또는 알림 파이프라인을 구축하는 데 적합합니다.
Prometheus 쿼리 엔드포인트 /query:
https://prometheus-internal.<subdomain>.<region>.<cloud>.clickhouse-byoc.com/query
- 외부 Prometheus 인스턴스가 ClickHouse BYOC Prometheus 스택의 메트릭을 페더레이션 방식으로 가져오도록 구성하세요.
- 이렇게 하면 여러 환경이나 클러스터의 메트릭 수집을 한곳으로 통합하고 중앙에서 관리할 수 있습니다.
- 예시 Prometheus 페더레이션 구성:
scrape_configs:
- job_name: 'federate-clickhouse-byoc'
scrape_interval: 15s
honor_labels: true
metrics_path: '/federate'
params:
'match[]':
- '{job="clickhouse"}'
- '{job="kubernetes"}'
static_configs:
- targets:
- 'prometheus-internal.<subdomain>.<region>.<cloud>.clickhouse-byoc.com'
ClickHouse 서비스 Prometheus 통합
/metrics_all 경로에서 사용할 수 있습니다:
curl --user <username>:<password> https://<service-subdomain>.<byoc-subdomain>.<region>.<provider>.byoc.clickhouse-byoc.com:8443/metrics_all
# HELP ClickHouse_CustomMetric_StorageSystemTablesS3DiskBytes system 데이터베이스의 `s3disk` 디스크에 저장된 바이트 수
# TYPE ClickHouse_CustomMetric_StorageSystemTablesS3DiskBytes gauge
ClickHouse_CustomMetric_StorageSystemTablesS3DiskBytes{hostname="c-jet-ax-16-server-43d5baj-0"} 62660929
# HELP ClickHouse_CustomMetric_NumberOfBrokenDetachedParts 손상된 분리된 파트 수
# TYPE ClickHouse_CustomMetric_NumberOfBrokenDetachedParts gauge
ClickHouse_CustomMetric_NumberOfBrokenDetachedParts{hostname="c-jet-ax-16-server-43d5baj-0"} 0
# HELP ClickHouse_CustomMetric_TotalNumberOfErrors 마지막 재시작 이후 서버에서 발생한 총 오류 수
# TYPE ClickHouse_CustomMetric_TotalNumberOfErrors gauge
ClickHouse_CustomMetric_TotalNumberOfErrors{hostname="c-jet-ax-16-server-43d5baj-0"} 9
default 사용자를 사용하거나, 메트릭 scraping 전용으로 최소 권한만 가진 사용자를 별도로 생성하는 것을 권장합니다.
필수 권한:
- 서비스에 연결하기 위한
REMOTE 권한
- 관련 시스템 테이블에 대한
SELECT 권한
예시 사용자 설정:
CREATE USER scrapping_user IDENTIFIED BY 'secure_password';
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;
global:
scrape_interval: 15s
scrape_configs:
- job_name: "clickhouse"
static_configs:
- targets: ["<service-subdomain>.<byoc-subdomain>.<region>.<provider>.byoc.clickhouse-byoc.com:8443"]
scheme: https
metrics_path: "/metrics_all"
basic_auth:
username: <username>
password: <password>
honor_labels: true
<service-subdomain>.<byoc-subdomain>.<region>.<provider>.byoc.clickhouse-byoc.com:8443를 실제 서비스 endpoint로 대체하십시오<username> 및 <password>를 스크래핑에 사용할 사용자 자격 증명으로 대체하십시오
즉시 사용할 수 있는 대시보드 모음을 원하는 팀을 위해 ClickHouse는 Prometheus ClickHouse Mixin을 제공합니다. 이는 ClickHouse 클러스터 모니터링을 위해 특별히 설계된 사전 구축된 Grafana 대시보드입니다.
Grafana 설정 및 ClickHouse Mix-in 가져오기
- Grafana에서 Prometheus를 데이터 소스로 추가
Grafana 사이드바에서 “Data sources”로 이동한 다음 “Add data source”를 클릭하고 “Prometheus”를 선택하십시오. 연결에 필요한 Prometheus 인스턴스 URL과 자격 증명을 입력하십시오.
- ClickHouse 대시보드 가져오기
Grafana에서 대시보드 영역으로 이동한 다음 “Import”를 선택하십시오. 대시보드 JSON 파일을 업로드하거나 파일 내용을 직접 붙여넣을 수 있습니다. JSON 파일은 ClickHouse mixin 리포지토리에서 가져올 수 있습니다.
ClickHouse Mix-in Dashboard JSON
- 메트릭 살펴보기
대시보드를 가져와 Prometheus 데이터 소스로 구성하면 ClickHouse Cloud 서비스의 실시간 메트릭을 확인할 수 있습니다.
