¶ 1. Конфигурация для кастомных sql-метрик заполняется в формате yaml
В тексте ниже представлен пример заполнения конфигурации кастомной sql-метрики.
# Имя метрики - как она будет отображаться в экспортере.
- metric_name: clickhouse_test
# Тип метрики в понятиях Prometheus. counter - это кумулятивная метрика, которая представляет собой один монотонно увеличивающийся счетчик , значение которого может только увеличиваться или сбрасываться до нуля при перезапуске. Например, вы можете использовать счетчик для представления количества обработанных запросов, выполненных задач или ошибок. Не используйте счетчик для отображения значения, которое может уменьшаться. Например, не используйте счетчик для числа текущих запущенных процессов; вместо этого используйте gauge. gauge - это метрика, представляющая собой одно числовое значение, которое может произвольно увеличиваться и уменьшаться. Датчики обычно используются для измерения таких значений, как температура или текущее использование памяти, а также «счетчиков», которые могут увеличиваться и уменьшаться, например, количества одновременных запросов.
type: counter
# Подсказка по метрике - будет отображаться как комментарий в экспортере
help: 'Help text for metric.'
# Дополнительный набор меток, полученных из столбцов запроса.
key_labels:
- field1
- field2
# Статичные метрики в формате название/значение
static_labels:
env: dev
product: my_product
region: europe
# Необязательное timestamp_value для указания на существующий столбец временной метки для возврата метрики с явной временной меткой
# timestamp_value: CreatedAt
# Этот запрос возвращает ровно одно значение на строку в столбце `counter`.
values: [counter]
query: |
SELECT field1, field2, cntr_value AS counter
FROM table_counters
WHERE counter_name = 'counter1'
# value_label: operation
# Несколько столбцов значений: их имя записывается в метку (например: operation="counter1"). Является обязательным если метрика возвращает несколько значений метрик
# values:
# - counter1
# - counter2
Важно: необходимо соблюдать количество пробелов в отступах в формате yaml, иначе экспортер может не запуститься, если формат будет не валидным.
¶ 2. Пример добавления метрики в интерфейсе RT.ClusterManager
Для реализации данного примера в интерфейсе RT.ClusterManager выполните следующее:
- Авторизуйтесь в RT.ClusterManager.
- На форме “Кластеры” выберите соответствующий кластер созданный с помощью плагина RT.WideStore.
- Выберите вкладку “Метрики”.
- Нажмите на кнопку “+” в верхней части формы с графиками метрик.
- В открывшемся окне “Добавить график” заполните поля (см. Рис. 1) и нажмите кнопку “Добавить”.
6. Будет добавлен график отображающий метрику “clickhouse_test”.