Aviso de tradução por IA

Este documento foi traduzido por IA. Para informações precisas, consulte a versão em inglês.

Telemetria

TelemetriaEnterprise Edition+

Visão Geral

O módulo de Telemetria (Telemetry) do NocoBase é baseado no OpenTelemetry, fornecendo recursos de observabilidade unificados e extensíveis para aplicações NocoBase. Este módulo suporta a coleta e exportação de várias métricas da aplicação, incluindo requisições HTTP e uso de recursos do sistema.

Configuração de Variáveis de Ambiente

Para habilitar o módulo de telemetria, você precisa configurar as variáveis de ambiente relacionadas.

TELEMETRY_ENABLED

Configure como on.

TELEMETRY_ENABLED=on

TELEMETRY_SERVICE_NAME

Nome do serviço.

TELEMETRY_SERVICE_NAME=nocobase

TELEMETRY_METRIC_READER

Exportadores de métricas. Suporta múltiplos exportadores separados por vírgulas. Os valores disponíveis podem ser consultados na documentação dos exportadores existentes.

TELEMETRY_METRIC_READER=console,http,prometheus

TELEMETRY_METRICS

Métricas a serem exportadas, separadas por vírgulas. Os valores disponíveis podem ser encontrados em Métricas.

TELEMETRY_METRICS=http_request_cost,process_cpu_percent,process_memory_mb,process_heap_mb,sub_app_status

TELEMETRY_HTTP_RECORD_THRESHOLD

Limite para registro do tempo de resposta de requisições HTTP (http_request_cost), em milissegundos. O valor padrão é 0, o que significa que todas as requisições são registradas. Quando definido para um valor maior que 0, apenas as requisições cujo tempo de resposta exceder esse limite serão registradas.

TELEMETRY_HTTP_RECORD_THRESHOLD=1000

Métricas

As métricas registradas atualmente pela aplicação estão listadas abaixo. Se você precisar de mais métricas, pode consultar a documentação de desenvolvimento para extensões ou entrar em contato conosco.

Nome da MétricaTipo da MétricaDescrição
process_cpu_percentObservableGaugePorcentagem de uso de CPU do processo
process_memory_mbObservableGaugeUso de memória do processo em MB
process_heap_mbObservableGaugeUso de memória heap do processo em MB
http_request_costHistogramTempo de resposta da requisição HTTP em ms
http_request_countCounterNúmero de requisições HTTP
http_request_activeUpDownCounterNúmero atual de requisições HTTP ativas
sub_app_statusObservableGaugeEstatísticas da contagem de sub-aplicações por status, reportadas pelo plugin plugin-multi-app-manager