Prometheus 메트릭 엔드포인트

Prometheus 메트릭 엔드포인트: ClickHouse 서버 메트릭을 전용 포트에서 스크레이프할 수 있도록 노출합니다.

ClickHouse는 Prometheus 서버가 스크레이프할 수 있도록 전용 포트에서 Prometheus 텍스트 포맷으로 자체 메트릭을 노출합니다.

Prometheus 메트릭을 ClickHouse에 저장하고 PromQL로 쿼리하려면 Prometheus HTTP API 및 PromQL을 참조하십시오.

ClickHouse Cloud를 사용 중이라면 Prometheus 통합을 통해 Prometheus에 메트릭을 노출할 수 있습니다.

​

메트릭 포트 구성

Prometheus 서버가 ClickHouse 자체 메트릭을 스크레이프해야 한다면 전용 포트를 구성하십시오:

<prometheus>
    <port>9363</port>
    <endpoint>/metrics</endpoint>
    <metrics>true</metrics>
    <asynchronous_metrics>true</asynchronous_metrics>
    <events>true</events>
    <errors>true</errors>
    <histograms>true</histograms>
    <dimensional_metrics>true</dimensional_metrics>
</prometheus>

​

확장 handler 구성

<prometheus.handlers> 섹션을 사용하면 동일한 포트에서 더 확장된 handler를 구성할 수 있습니다. 이 섹션은 <http_handlers>와 유사하지만 Prometheus 프로토콜을 대상으로 동작합니다:

<prometheus>
    <port>9363</port>
    <handlers>
        <my_rule_1>
            <url>/metrics</url>
            <handler>
                <type>expose_metrics</type>
                <metrics>true</metrics>
                <asynchronous_metrics>true</asynchronous_metrics>
                <events>true</events>
                <errors>true</errors>
                <histograms>true</histograms>
                <dimensional_metrics>true</dimensional_metrics>
                <labels>
                    <environment>production</environment>
                    <shard from_env="SHARD_NAME"></shard>
                </labels>
            </handler>
        </my_rule_1>
    </handlers>
</prometheus>

​

설정

이러한 설정의 전체 동작은 서버 설정 참고 문서의 Prometheus 섹션을 확인하십시오.

이름	기본값	설명
port	없음	ClickHouse 메트릭을 제공하는 포트입니다.
endpoint	/metrics	메트릭 스크래핑용 HTTP 엔드포인트입니다. /로 시작합니다. <handlers> 섹션과 함께 사용해서는 안 됩니다.
url / headers / method	없음	요청에 일치하는 handler를 찾는 데 사용되는 필터입니다. <http_handlers> 섹션의 동일한 이름을 가진 필드와 유사합니다.
info	true	서버 아이덴티티 레이블(name, version, version_describe, version_major, version_minor, version_patch)이 포함된 ClickHouse_Info gauge를 노출합니다.
metrics	true	system.metrics의 메트릭을 노출합니다.
asynchronous_metrics	true	system.asynchronous_metrics의 메트릭을 노출합니다.
events	true	system.events의 메트릭을 노출합니다.
errors	true	system.errors의 오류 횟수를 노출합니다.
histograms	true	system.histogram_metrics의 메트릭을 노출합니다.
dimensional_metrics	true	system.dimensional_metrics의 메트릭을 노출합니다.
labels	없음	노출되는 모든 메트릭에 추가되는 상수 레이블입니다. 각 하위 요소가 레이블 하나를 정의하며, 요소 이름이 레이블 이름([a-zA-Z_][a-zA-Z0-9_]* 패턴과 일치해야 함), 요소 값이 레이블 값이 됩니다. 레이블 값에는 from_env 속성과 같은 표준 구성 치환을 사용할 수 있습니다. 레이블 이름이 __로 시작하거나(Prometheus 예약어), 이 엔드포인트가 활성화된 섹션을 위해 이미 기록하고 있는 레이블과 충돌하면 해당 이름은 거부됩니다. 따라서 예약된 집합은 엔드포인트가 실제로 내보내는 범위에 따라 달라집니다. 즉, histograms가 활성화된 경우 le, info가 활성화된 경우 ClickHouse_Info 레이블(name, version, version_describe, version_major, version_minor, version_patch), histograms 또는 dimensional_metrics가 활성화된 경우 노출되는 히스토그램 또는 차원 메트릭 family에서 사용하는 모든 레이블(예: group, direction, operation_type)이 이에 해당합니다. 이처럼 엔드포인트가 실제로 노출하는 내용에 따라 달라지므로, 동일한 이름이라도 어떤 엔드포인트에서는 유효하고 다른 엔드포인트에서는 거부될 수 있습니다.

​

엔드포인트 확인

curl http://127.0.0.1:9363/metrics