Aviso de traducción IA

Este documento ha sido traducido por IA. Para información precisa, consulte la versión en inglés.

Telemetría

TelemetríaEnterprise Edition+

Descripción general

El módulo de telemetría (Telemetry) de NocoBase está basado en OpenTelemetry, proporcionando capacidades de observabilidad unificadas y extensibles para las aplicaciones de NocoBase. Este módulo permite la recopilación y exportación de diversas métricas de la aplicación, incluyendo solicitudes HTTP y el uso de recursos del sistema.

Configuración de variables de entorno

Para habilitar el módulo de telemetría, debe configurar las variables de entorno correspondientes.

TELEMETRY_ENABLED

Establézcalo en on.

TELEMETRY_ENABLED=on

TELEMETRY_SERVICE_NAME

Nombre del servicio.

TELEMETRY_SERVICE_NAME=nocobase

TELEMETRY_METRIC_READER

Exportadores de métricas. Se admiten varios exportadores separados por comas. Consulte la documentación de los exportadores existentes para conocer los valores disponibles.

TELEMETRY_METRIC_READER=console,http,prometheus

TELEMETRY_METRICS

Métricas a exportar, separadas por comas. Los valores disponibles se pueden consultar en Métricas.

TELEMETRY_METRICS=http_request_cost,process_cpu_percent,process_memory_mb,process_heap_mb,sub_app_status

TELEMETRY_HTTP_RECORD_THRESHOLD

Umbral para el registro de la duración de las solicitudes HTTP (http_request_cost), en milisegundos. El valor predeterminado es 0, lo que significa que se registran todas las solicitudes. Cuando se establece en un valor superior a 0, solo se registrarán las solicitudes cuya duración supere dicho umbral.

TELEMETRY_HTTP_RECORD_THRESHOLD=1000

Métricas

Las métricas registradas actualmente por la aplicación se enumeran a continuación. Si necesita más, puede consultar la documentación de desarrollo para realizar extensiones o ponerse en contacto con nosotros.

Nombre de la métricaTipo de métricaDescripción
process_cpu_percentObservableGaugePorcentaje de uso de CPU del proceso
process_memory_mbObservableGaugeUso de memoria del proceso en MB
process_heap_mbObservableGaugeUso de memoria heap del proceso en MB
http_request_costHistogramDuración de la solicitud HTTP en ms
http_request_countCounterNúmero de solicitudes HTTP
http_request_activeUpDownCounterNúmero actual de solicitudes HTTP activas
sub_app_statusObservableGaugeEstadísticas del recuento de sub-aplicaciones por estado, reportadas por el plugin plugin-multi-app-manager