Конечная точка метрик для всей организации (
GET /v1/organizations/{organizationId}/prometheus) устарела в пользу автоматического обнаружения сервисов. Существующие организации могут продолжать её использовать; вновь созданные организации вместо неё используют конечную точку обнаружения. Если вам нужен доступ к этой конечной точке, обратитесь в службу поддержки ClickHouse.
Полные схемы запросов и ответов для этих конечных точек доступны в справочнике Cloud API.
Используйте API-ключ ClickHouse Cloud для базовой аутентификации:
Для ClickPipes метрики также содержат следующие метки:
ClickHouse Cloud предоставляет специальную метрику
ClickHouse_ServiceInfo — это gauge, который всегда имеет значение 1. Эта метрика содержит все метки метрик, а также следующие метки:
Запросы на получение метрик не выводят сервис из состояния бездействия. Если сервис находится в состоянии
idle, будет возвращена только метрика ClickHouse_ServiceInfo.
Для ClickPipes есть аналогичная метрика ClickPipes_Info типа gauge, которая, помимо меток метрик, содержит следующие метки:
Настройка Prometheus
Сервер Prometheus собирает метрики с настроенных целей с заданной периодичностью. Ниже приведен пример конфигурации, в которой сервер Prometheus использует конечную точку Prometheus ClickHouse Cloud:honor_labels должен быть установлен в true, чтобы метка instance заполнялась корректно. Кроме того, в приведённом выше примере параметр filtered_metrics установлен в true, однако это значение следует задавать в соответствии с предпочтениями пользователя. Чтобы собирать метрики со всех сервисов организации, используйте автоматическое обнаружение сервисов.
Автоматическое обнаружение сервисов
Конечная точка обнаружения возвращает по одной цели сбора метрик для каждого сервиса в вашей организации в формате Prometheus обнаружение сервисов по HTTP (http_sd). Prometheus обновляет список целей при каждом опросе обнаружения и собирает метрики с каждой обнаруженной цели, поэтому вновь созданные сервисы добавляются автоматически, а удалённые исключаются из списка целей. Включаются только сервисы, для просмотра которых авторизован ваш ключ API; сервисы, находящиеся в процессе удаления или уже удалённые, не включаются.
Чтобы использовать её, укажите конечную точку обнаружения для задачи http_sd_configs:
basic_auth в обоих местах: блок в разделе http_sd_configs аутентифицирует запросы обнаружения, а блок в задаче scrape — сбор метрик для каждого сервиса. Как и при статической конфигурации, укажите honor_labels: true, чтобы метка instance заполнялась корректно.
Пример ответа обнаружения:
__meta_clickhouse_region, __meta_clickhouse_provider и __meta_clickhouse_tag_<key>. Метка __meta_clickhouse_tagpresent_<key> принимает значение true для каждого тега, включая теги без значения. Все символы в ключах тегов, кроме букв, цифр и символов подчёркивания, заменяются на _. После переразметки (relabeling) Prometheus удаляет метки __meta_, поэтому используйте relabel_configs, чтобы фильтровать цели или сохранять эти метки:
filtered_metrics=true. Чтобы обнаружить цели, собирающие полный набор метрик, добавьте ?filtered_metrics=false к URL обнаружения. Полная спецификация конечной точки доступна в справочнике Cloud API.
У пользователей есть два основных способа интеграции с Grafana:
- Конечная точка метрик – Преимущество этого подхода в том, что он не требует никаких дополнительных компонентов или инфраструктуры. Этот вариант доступен только в Grafana Cloud и требует лишь URL конечной точки Prometheus ClickHouse Cloud и учетные данные.
- Grafana Alloy - Grafana Alloy — это независимый от вендора дистрибутив OpenTelemetry (OTel) Collector, пришедший на смену Grafana Agent. Его можно использовать для сбора метрик, развернуть в собственной инфраструктуре, и он совместим с любой конечной точкой Prometheus.
Grafana Cloud с конечной точкой метрик
- Войдите в свою учетную запись Grafana Cloud
- Добавьте новое подключение, выбрав конечную точку метрик
- Настройте URL сбора так, чтобы он указывал на конечную точку Prometheus, и используйте базовую аутентификацию для настройки подключения с помощью API key/secret
- Проверьте подключение, чтобы убедиться, что соединение устанавливается

После настройки вы увидите метрики в раскрывающемся списке, где их можно выбрать для настройки панелей мониторинга:


Grafana Cloud с Alloy
Если вы используете Grafana Cloud, Alloy можно установить, открыв меню Alloy в Grafana и следуя инструкциям на экране:
В результате Alloy будет настроен с компонентом
prometheus.remote_write для отправки данных в конечную точку Grafana Cloud с токеном аутентификации. После этого пользователям останется только изменить конфигурацию Alloy (в Linux она находится в /etc/alloy/config.alloy), добавив сборщик для конечной точки Prometheus ClickHouse Cloud.
Ниже показан пример конфигурации Alloy с компонентом prometheus.scrape для сбора метрик из конечной точки ClickHouse Cloud, а также автоматически настроенным компонентом prometheus.remote_write. Обратите внимание, что компонент конфигурации basic_auth содержит идентификатор и секрет нашего ключа API Cloud в качестве имени пользователя и пароля соответственно.
instance заполнялась корректно, параметр конфигурации honor_labels должен быть установлен в true.
Самоуправляемая Grafana с Alloy
Пользователи самоуправляемой версии Grafana могут найти инструкции по установке агента Alloy здесь. Мы исходим из того, что Alloy уже настроен на отправку метрик Prometheus в нужный пункт назначения. Приведённый ниже компонентprometheus.scrape заставляет Alloy опрашивать конечную точку ClickHouse Cloud. Мы также предполагаем, что prometheus.remote_write принимает собранные метрики. Если forward_to key отсутствует, укажите в нём целевой пункт назначения.

Обратите внимание: для корректного заполнения метки instance параметру конфигурации
honor_labels нужно задать значение true.
Интеграция с Datadog
Вы можете использовать агент Datadog и интеграцию OpenMetrics для сбора метрик с конечной точки ClickHouse Cloud. Ниже приведен простой пример конфигурации для этого агента и интеграции. Однако обратите внимание: возможно, стоит выбрать только те метрики, которые для вас наиболее важны. Приведенный ниже универсальный пример будет экспортировать многие тысячи комбинаций метрик и экземпляров, которые Datadog будет считать пользовательскими метриками.
Связанные страницы
- Обзор мониторинга — Сравните все подходы к мониторингу в ClickHouse Cloud
- Мониторинг в Cloud Console — Встроенные панели мониторинга, не требующие внешних инструментов
- Интеграции сообщества и партнеров — Интеграция с агентом Datadog и решения сообщества
- Запросы к системным таблицам — Прямой доступ к системным метрикам через SQL
- ClickHouse Managed Postgres конечная точка Prometheus — Собирайте метрики из сервисов ClickHouse Managed Postgres