Chuyển tới nội dung chính

API Health

Tiền tố /api/v1/health. Controller: health.controller.ts. Xem observability.

Công khai (@Public) và không giới hạn tốc độ (@SkipThrottle). Log HTTP bỏ qua đường dẫn này.

Danh sách route​

RouteAuthMô tả
GET /api/v1/health/liveCông khaiProcess còn phục vụ HTTP, không kiểm tra phụ thuộc
GET /api/v1/health/readyCông khaiKiểm tra kết nối MongoDB và Redis; 503 khi một trong hai lỗi
GET /api/v1/healthCông khaiAlias của ready, giữ cho monitor cũ

Ghi chú​

  • ready (và /health) kiểm tra database (MongoDB pingCheck) và redis (ping); live không kiểm tra gì.
  • Dùng @nestjs/terminus. Route không có @SkipTransform (chỉ hai route stream chat có), nên kết quả của Terminus nằm trong data của envelope { statusCode, message, data }, với message là null. Chưa chạy thử để xác nhận cấu trúc bên trong data.
  • Không kiểm tra hàng đợi BullMQ, dịch vụ AI hay SMTP.
  • Docker HEALTHCHECK gọi /health/live mỗi 30 giây (Dockerfile).

Chi tiết từng route​

GET /api/v1/health​

Kiểm tra kết nối MongoDB và Redis