Yêu cầu Phần mềm
Module Logger
LOG
1. Giới thiệu
1.1 Mục đích
Tài liệu này định nghĩa các yêu cầu phần mềm cho module Logger của Hệ thống Xác thực.
1.2 Phạm vi
Module Logger xử lý:
- Ghi log sự kiện tập trung từ tất cả dịch vụ qua RabbitMQ
- Lưu trữ trên OpenSearch để tìm kiếm toàn văn và phân tích
- Truy vấn và lọc log
- Bảng điều khiển giám sát thời gian thực
1.3 Phụ thuộc Module
Nhận sự kiện từ: AUTH, SMS, EMAIL, RECR, WALLET (tất cả module gửi log)
1.4 Định nghĩa
| Thuật ngữ | Định nghĩa |
|---|
| FR | Yêu cầu Chức năng |
| NFR | Yêu cầu Phi chức năng |
| OpenSearch | Công cụ tìm kiếm và phân tích phân tán |
| RabbitMQ | Trung gian tin nhắn để gửi sự kiện bất đồng bộ |
2. Tổng quan Module
| Khía cạnh | Giá trị |
|---|
| Mã Module | LOG |
| Tên Module | Logger |
| Mô tả | Ghi log sự kiện tập trung qua RabbitMQ, lưu trên OpenSearch |
| Cơ sở dữ liệu | OpenSearch (chỉ mục log-events) |
| Công nghệ | NestJS, RabbitMQ (amqplib), OpenSearch |
3. Yêu cầu Chức năng
| Mã YC |
Module |
Yêu cầu |
Ưu tiên |
Mô tả |
| FR-001 |
LOG |
Thu thập Sự kiện Log |
Cao |
Hệ thống phải tiêu thụ sự kiện log từ RabbitMQ và chỉ mục lên OpenSearch |
| FR-002 |
LOG |
Truy vấn Log |
Cao |
Hệ thống phải cung cấp API truy vấn log với bộ lọc (mức độ, nguồn, khoảng thời gian) |
| FR-003 |
LOG |
Phân tích Log |
Trung bình |
Hệ thống phải cung cấp phân tích dữ liệu log (tỷ lệ lỗi, thời gian phản hồi) |
| FR-004 |
LOG |
Giám sát Thời gian thực |
Trung bình |
Hệ thống phải hỗ trợ phát trực tuyến log thời gian thực qua WebSocket |
4. Yêu cầu Phi chức năng
| Mã YC | Danh mục | Yêu cầu | Mục tiêu |
|---|
| NFR-001 |
Hiệu suất |
Throughput thu thập log |
10.000 sự kiện/giây |
| NFR-002 |
Hiệu suất |
Thời gian phản hồi truy vấn |
< 500ms (p95) |
| NFR-003 |
Khả dụng |
Uptime dịch vụ log |
99.9% |
| NFR-004 |
Lưu trữ |
Thời gian lưu log |
90 ngày (có thể cấu hình) |
5. Ma trận Truy suất Yêu cầu
| Mã YC | Yêu cầu | Công nghệ | Tích hợp |
|---|
| FR-001 | Thu thập Sự kiện Log | RabbitMQ + OpenSearch | Tất cả module gửi đến hàng đợi log.events |
| FR-002 | Truy vấn Log | OpenSearch Query API | REST API |
| FR-003 | Phân tích Log | OpenSearch Aggregations | Tích hợp bảng điều khiển |
| FR-004 | Giám sát Thời gian thực | WebSocket + OpenSearch | Phát trực tuyến bảng điều khiển |
