Уведомление об ИИ-переводе

Этот документ был переведён с помощью ИИ. Для получения точной информации обратитесь к английской версии.

Телеметрия

ТелеметрияEnterprise Edition+

Обзор

Модуль телеметрии (Telemetry) NocoBase основан на OpenTelemetry и предоставляет унифицированные и расширяемые возможности мониторинга (observability) для приложений 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Использование кучи (heap) памяти процессом, в МБ
http_request_costHistogramДлительность HTTP-запроса, в мс
http_request_countCounterКоличество HTTP-запросов
http_request_activeUpDownCounterТекущее количество активных HTTP-запросов
sub_app_statusObservableGaugeСтатистика количества суб-приложений по разным статусам, передаваемая плагином plugin-multi-app-manager