Телеметрия

TelemetryEnterprise Edition+

Обзор

Модуль телеметрии в NocoBase построен на базе OpenTelemetry и предоставляет единые расширяемые возможности наблюдаемости для приложений NocoBase. Модуль поддерживает сбор и экспорт различных показателей приложения, включая HTTP-запросы и использование системных ресурсов.

Переменные окружения

Чтобы включить модуль телеметрии, необходимо настроить соответствующие переменные окружения.

TELEMETRY_ENABLED

Установите on.

TELEMETRY_ENABLED=on

TELEMETRY_SERVICE_NAME

Имя сервиса.

TELEMETRY_SERVICE_NAME=nocobase

TELEMETRY_METRIC_READER

Экспортёры показателей. Поддерживается несколько экспортёров, перечисленных через запятую. Допустимые значения смотрите в документации конкретных экспортёров.

TELEMETRY_METRIC_READER=console,http,prometheus

TELEMETRY_METRICS

Показатели для экспорта, перечисленные через запятую. Доступные значения см. в разделе Метрики.

TELEMETRY_METRICS=http_request_cost,process_cpu_percent,process_memory_mb,process_heap_mb,sub_app_status

TELEMETRY_HTTP_RECORD_THRESHOLD

Порог записи длительности HTTP-запроса (http_request_cost) в миллисекундах. Значение по умолчанию — 0, то есть записываются все запросы. Если установить значение больше 0, будут записываться только запросы с длительностью выше порога.

TELEMETRY_HTTP_RECORD_THRESHOLD=1000

Метрики

Текущие показатели, записываемые приложением, перечислены ниже. Если нужны дополнительные показатели, см. документацию для разработки по расширению или свяжитесь с нами.

Название показателяТип показателяОписание
process_cpu_percentObservableGaugeПроцент использования CPU процесса
process_memory_mbObservableGaugeИспользование памяти процесса в МБ
process_heap_mbObservableGaugeИспользование динамической памяти процесса в МБ
http_request_costHistogramДлительность HTTP-запроса в мс
http_request_countCounterКоличество HTTP-запросов
http_request_activeUpDownCounterТекущее число активных HTTP-запросов
sub_app_statusObservableGaugeСтатистика количества подприложений по статусам, отправляемая плагином plugin-multi-app-manager