TCF (Admin Guide): Метрики Tarantool/TCF

[xuniq]

Product: TCF
Since: -
Root document: https://www.tarantool.io/ru/clustersfederation/doc/latest/admin_guide/monitoring/
SME: @ DifferentialOrange @ oleg-jukovec

Details

В админ гайд нужен раздел с описанием метрик Tarantool и метрик TCF

Какие метрики есть в TCF:

• метрики Tarantool;
• метрики TCF - что-то уже написано в доке, нужно актуализировать: https://docs.d.tarantool.io/ru/clustersfederation/doc/latest-0.3.x/references/metrics_reference/.

За шаблон структуры в доке можно взять аналогичные разделы по мониторингу в документации TDG. Скорее всего введение по мониторингу в доке tdg валидно и тут.

Структуру файлов в разделе с мониторингом я уже набрасывала тут: https://github.com/tarantool/cluster-federation/pull/351/files#diff-0d09ef5b3788558fcbc0c9f22b367243bf1a77ddf1dbcfae51b4eddd1ce739f2R1-R12

• Руководство администратора
  • Мониторинг
    • Метрики TCF
    • Метрики Tarantool
    • Рекомендации по анализу метрик (страница будет добавлена в рамках TCF (Admin Guide): Рекомендации по анализу метрик TCF и Tarantool #4961)

Метрики TCF

Существующий справочник с метриками TCF нужно перенести в админ гайд и актуализировать:
https://docs.d.tarantool.io/ru/clustersfederation/doc/latest-0.3.x/references/metrics_reference/

Ксения Антонова (18.02.2025 14:05):
Привет! В доке сейчас есть такой справочник по метрикам TCF: https://docs.d.tarantool.io/ru/clustersfederation/doc/latest-0.3.x/references/metrics_reference/

Вижу в нем следующие разделы:

• Метрики TCF-координатора
• Метрики Destination

Насколько этот справочник актуален? Есть что-то, чего в нем не хватает? Метрики Gateway?

Георгий Моисеев (18.02.2025 14:10):
https://github.com/tarantool/cluster-federation/blob/master/src/internal/gateway/metrics/metrics.go
https://github.com/tarantool/cluster-federation/blob/master/src/internal/destination/metrics/metrics.go

Вот дополнительно по gateway/destination. Там какие-то маленькие описания есть, если их не хватит — пишите, поизучаю суть.

"Метрики TCF-координатора" на самом деле "Метрики TCF-воркера", а роль воркера должна быть включена на каждом узле source и destination кластеров.

Георгий Моисеев (18.02.2025 14:10):
Вроде больше нечего добавить или изменить

Метрики Tarantool

Что есть полезного:

• описание метрик в доке Tarantool https://www.tarantool.io/ru/doc/latest/admin/monitoring/metrics_reference/
• руководство пользователя для ФСТЭКа (в тч чтобы посмотреть перевод описаний для тарантульных метрик)

У нас есть во фстэковских доках тарантульные метрики на русском, актуальные для тарантул 3. Можно для начала занести их, завалидировав этот список. Метрики, доступные с версии тарантул 3, я бы помечала явно, как тут: https://www.tarantool.io/en/doc/latest/admin/monitoring/metrics_reference/#tarantool-configuration
(вроде как Tarantool configuration - это как раз единственная секция метрик, которая доступна с версии tarantool 3)