Telemetry

TelemetryEnterprise Edition+

Tổng quan

Module Telemetry của NocoBase được đóng gói dựa trên OpenTelemetry, cung cấp khả năng quan sát thống nhất, có thể mở rộng cho ứng dụng NocoBase. Module này hỗ trợ thu thập và xuất nhiều metric ứng dụng, bao gồm request HTTP, sử dụng tài nguyên hệ thống, v.v.

Cấu hình biến môi trường

Để kích hoạt module Telemetry, cần cấu hình biến môi trường liên quan.

TELEMETRY_ENABLED

Cấu hình thành on.

TELEMETRY_ENABLED=on

TELEMETRY_SERVICE_NAME

Tên dịch vụ.

TELEMETRY_SERVICE_NAME=nocobase

TELEMETRY_METRIC_READER

Exporter metric, hỗ trợ nhiều exporter, phân tách bằng dấu phẩy. Các giá trị tùy chọn tham khảo tài liệu các exporter đã có.

TELEMETRY_METRIC_READER=console,http,prometheus

TELEMETRY_METRICS

Các metric cần xuất, phân tách bằng dấu phẩy. Các giá trị tùy chọn tham khảo Metric.

TELEMETRY_METRICS=http_request_cost,process_cpu_percent,process_memory_mb,process_heap_mb,sub_app_status

TELEMETRY_HTTP_RECORD_THRESHOLD

Ngưỡng ghi thời gian request HTTP (http_request_cost), đơn vị mili giây. Giá trị mặc định là 0, nghĩa là ghi tất cả các request. Khi đặt thành giá trị lớn hơn 0, chỉ ghi các request có thời gian vượt quá ngưỡng đó.

TELEMETRY_HTTP_RECORD_THRESHOLD=1000

Metric

Các metric hiện được ghi trong ứng dụng như sau, nếu bạn có nhu cầu thêm, có thể tham khảo tài liệu phát triển để mở rộng hoặc liên hệ với chúng tôi.

Tên metricLoại metricMô tả
process_cpu_percentObservableGaugeTỷ lệ phần trăm sử dụng CPU của tiến trình
process_memory_mbObservableGaugeLượng bộ nhớ sử dụng của tiến trình, đơn vị MB
process_heap_mbObservableGaugeLượng heap memory sử dụng của tiến trình, đơn vị MB
http_request_costHistogramThời gian request HTTP, đơn vị ms
http_request_countCounterSố lượng request HTTP
http_request_activeUpDownCounterSố request HTTP đang hoạt động
sub_app_statusObservableGaugeThống kê số lượng sub-app ở các trạng thái khác nhau, được báo cáo bởi plugin plugin-multi-app-manager