Конечная точка метрик Prometheus - ClickHouse Documentation

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>

Настройка расширенных handlers

Секцию <prometheus.handlers> можно использовать для создания более расширенных handlers на том же порту. Эта секция аналогична <http_handlers>, но работает с Prometheus protocols:

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

Settings

Полное описание поведения этих настроек приведено в разделе Prometheus справочника по настройкам сервера.

Имя	По умолчанию	Описание
`port`	нет	Порт, на котором отдаются метрики ClickHouse.
`endpoint`	`/metrics`	HTTP-конечная точка для сбора метрик. Начинается с `/`. Не должна использоваться вместе с разделом `<handlers>`.
`url` / `headers` / `method`	нет	Фильтры, по которым подбирается подходящий handler для запроса. Аналогичны одноимённым полям в разделе `<http_handlers>`.
`info`	true	Отдаёт gauge `ClickHouse_Info` с labels, идентифицирующими сервер (`name`, `version`, `version_describe`, `version_major`, `version_minor`, `version_patch`).
`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`	нет	Постоянные labels, добавляемые к каждой отдаваемой метрике. Каждый дочерний элемент задаёт один label: имя элемента становится именем label (оно должно соответствовать `[a-zA-Z_][a-zA-Z0-9_]*`), а значение элемента — значением label. Значения labels поддерживают стандартные подстановки конфигурации, например атрибут `from_env`. Имя label отклоняется, если оно начинается с `__` (зарезервировано Prometheus) либо если оно конфликтует с label, который эта конечная точка уже записывает для одного из своих включённых разделов. Таким образом, зарезервированный набор определяется тем, что конечная точка экспортирует в данный момент: `le` — если включён `histograms`; labels `ClickHouse_Info` (`name`, `version`, `version_describe`, `version_major`, `version_minor`, `version_patch`) — если включён `info`; а также любой label, используемый отдаваемой histogram или семейством размерностных метрик (например, `group`, `direction` или `operation_type`) — если включён `histograms` или `dimensional_metrics`. Поскольку это зависит от того, что конечная точка отдаёт фактически, одно и то же имя может быть допустимым на одной конечной точке и отклонённым на другой.

Проверьте конечную точку

curl http://127.0.0.1:9363/metrics

Последнее изменение 26 сентября 2026 г.