feat: 重构项目心跳数据结构并实现相关功能
- 重构Redis心跳数据结构，使用统一的项目列表键 - 新增数据迁移工具和API端点 - 更新前端以使用真实项目数据 - 添加系统部署配置和文档 - 修复代码格式和样式问题
This commit is contained in:
@@ -1,54 +1,44 @@
|
||||
# Command Capability Specification
|
||||
|
||||
## Overview
|
||||
|
||||
This specification defines the command capability for the BLS Project Console, which allows users to send console commands to Redis queues for other programs to read and execute.
|
||||
|
||||
## Requirements
|
||||
|
||||
### Requirement: Command Sending to Redis
|
||||
|
||||
The system SHALL send commands to a Redis queue.
|
||||
|
||||
#### Scenario: Sending a command to Redis queue
|
||||
|
||||
- **WHEN** the user enters a command in the console
|
||||
- **AND** clicks the "Send" button
|
||||
- **THEN** the command SHALL be sent to the Redis queue
|
||||
- **AND** the user SHALL receive a success confirmation
|
||||
|
||||
### Requirement: Command Validation
|
||||
|
||||
The system SHALL validate commands before sending them to Redis.
|
||||
|
||||
#### Scenario: Validating an empty command
|
||||
|
||||
- **WHEN** the user tries to send an empty command
|
||||
- **THEN** the system SHALL display an error message
|
||||
- **AND** the command SHALL NOT be sent to Redis
|
||||
|
||||
#### Scenario: Validating a command with invalid characters
|
||||
|
||||
- **WHEN** the user tries to send a command with invalid characters
|
||||
- **THEN** the system SHALL display an error message
|
||||
- **AND** the command SHALL NOT be sent to Redis
|
||||
|
||||
### Requirement: Command History
|
||||
|
||||
The system SHALL maintain a history of sent commands.
|
||||
|
||||
#### Scenario: Viewing command history
|
||||
|
||||
- **WHEN** the user opens the command history
|
||||
- **THEN** the system SHALL display a list of previously sent commands
|
||||
- **AND** the user SHALL be able to select a command from the history to resend
|
||||
|
||||
### Requirement: Command Response Handling
|
||||
|
||||
The system SHALL handle responses from commands sent to Redis.
|
||||
|
||||
#### Scenario: Receiving a command response
|
||||
|
||||
- **WHEN** a command response is received from Redis
|
||||
- **THEN** the system SHALL display the response in the console
|
||||
- **AND** the response SHALL be associated with the original command
|
||||
@@ -56,7 +46,6 @@ The system SHALL handle responses from commands sent to Redis.
|
||||
## Data Model
|
||||
|
||||
### Command
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
@@ -67,7 +56,6 @@ The system SHALL handle responses from commands sent to Redis.
|
||||
```
|
||||
|
||||
### Command Response
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
@@ -81,7 +69,6 @@ The system SHALL handle responses from commands sent to Redis.
|
||||
## API Endpoints
|
||||
|
||||
### POST /api/commands
|
||||
|
||||
- **Description**: Send a command to a project's API endpoint
|
||||
- **Request Body**:
|
||||
```json
|
||||
@@ -103,7 +90,6 @@ The system SHALL handle responses from commands sent to Redis.
|
||||
```
|
||||
|
||||
### GET /api/projects
|
||||
|
||||
- **Description**: Get list of all projects with their heartbeat status
|
||||
- **Response**:
|
||||
```json
|
||||
@@ -125,7 +111,6 @@ The system SHALL handle responses from commands sent to Redis.
|
||||
```
|
||||
|
||||
### POST /api/projects/migrate
|
||||
|
||||
- **Description**: Migrate heartbeat data from old structure to new unified structure
|
||||
- **Request Body**:
|
||||
```json
|
||||
@@ -147,7 +132,6 @@ The system SHALL handle responses from commands sent to Redis.
|
||||
```
|
||||
|
||||
### GET /api/commands/history
|
||||
|
||||
- **Description**: Get command history (deprecated - use project logs instead)
|
||||
- **Query Parameters**:
|
||||
- `limit`: Maximum number of commands to return (default: 50)
|
||||
@@ -155,6 +139,5 @@ The system SHALL handle responses from commands sent to Redis.
|
||||
- **Response**: Array of command objects
|
||||
|
||||
### GET /api/commands/:id/response
|
||||
|
||||
- **Description**: Get response for a specific command (deprecated - use project logs instead)
|
||||
- **Response**: Command response object
|
||||
|
||||
@@ -1,53 +1,43 @@
|
||||
# Logging Capability Specification
|
||||
|
||||
## Overview
|
||||
|
||||
This specification defines the logging capability for the BLS Project Console, which allows the system to read log records from Redis queues and display them in the console interface.
|
||||
|
||||
## Requirements
|
||||
|
||||
### Requirement: Log Reading from Redis
|
||||
|
||||
The system SHALL read log records from a Redis queue.
|
||||
|
||||
#### Scenario: Reading logs from Redis queue
|
||||
|
||||
- **WHEN** the server starts
|
||||
- **THEN** it SHALL establish a connection to the Redis queue
|
||||
- **AND** it SHALL begin listening for new log records
|
||||
- **AND** it SHALL store log records in memory for display
|
||||
|
||||
### Requirement: Log Display in Console
|
||||
|
||||
The system SHALL display log records in a user-friendly format.
|
||||
|
||||
#### Scenario: Displaying logs in the console
|
||||
|
||||
- **WHEN** a log record is received from Redis
|
||||
- **THEN** it SHALL be added to the log list in the console
|
||||
- **AND** it SHALL display the log timestamp, level, and message
|
||||
- **AND** it SHALL support scrolling through historical logs
|
||||
|
||||
### Requirement: Log Filtering
|
||||
|
||||
The system SHALL allow users to filter logs by level and time range.
|
||||
|
||||
#### Scenario: Filtering logs by level
|
||||
|
||||
- **WHEN** the user selects a log level filter
|
||||
- **THEN** only logs with the selected level SHALL be displayed
|
||||
|
||||
#### Scenario: Filtering logs by time range
|
||||
|
||||
- **WHEN** the user selects a time range
|
||||
- **THEN** only logs within the specified range SHALL be displayed
|
||||
|
||||
### Requirement: Log Auto-Refresh
|
||||
|
||||
The system SHALL automatically refresh logs in real-time.
|
||||
|
||||
#### Scenario: Real-time log updates
|
||||
|
||||
- **WHEN** a new log is added to the Redis queue
|
||||
- **THEN** it SHALL be automatically displayed in the console
|
||||
- **AND** the console SHALL scroll to the latest log if the user is viewing the end
|
||||
@@ -55,7 +45,6 @@ The system SHALL automatically refresh logs in real-time.
|
||||
## Data Model
|
||||
|
||||
### Log Record
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
@@ -69,7 +58,6 @@ The system SHALL automatically refresh logs in real-time.
|
||||
## API Endpoints
|
||||
|
||||
### GET /api/logs
|
||||
|
||||
- **Description**: Get log records for a specific project
|
||||
- **Query Parameters**:
|
||||
- `projectName`: Project name (required)
|
||||
@@ -97,6 +85,5 @@ The system SHALL automatically refresh logs in real-time.
|
||||
```
|
||||
|
||||
### GET /api/logs/live
|
||||
|
||||
- **Description**: Establish a WebSocket connection for real-time log updates
|
||||
- **Response**: Continuous stream of log records
|
||||
|
||||
@@ -1,59 +1,48 @@
|
||||
# Redis Connection Capability Specification
|
||||
|
||||
## Overview
|
||||
|
||||
This specification defines the Redis connection capability for the BLS Project Console, which manages the connection between the system and the Redis server for reading logs and sending commands.
|
||||
|
||||
## Requirements
|
||||
|
||||
### Requirement: Redis Connection Establishment
|
||||
|
||||
The system SHALL establish a connection to the Redis server.
|
||||
|
||||
#### Scenario: Establishing Redis connection on server start
|
||||
|
||||
- **WHEN** the server starts
|
||||
- **THEN** it SHALL attempt to connect to the Redis server
|
||||
- **AND** it SHALL log the connection status
|
||||
|
||||
### Requirement: Redis Connection Configuration
|
||||
|
||||
The system SHALL allow configuration of Redis connection parameters.
|
||||
|
||||
#### Scenario: Configuring Redis connection via environment variables
|
||||
|
||||
- **WHEN** the server starts with Redis environment variables set
|
||||
- **THEN** it SHALL use those variables to configure the Redis connection
|
||||
- **AND** it SHALL override default values
|
||||
|
||||
### Requirement: Redis Connection Reconnection
|
||||
|
||||
The system SHALL automatically reconnect to Redis if the connection is lost.
|
||||
|
||||
#### Scenario: Reconnecting to Redis after connection loss
|
||||
|
||||
- **WHEN** the Redis connection is lost
|
||||
- **THEN** the system SHALL attempt to reconnect with exponential backoff
|
||||
- **AND** it SHALL log each reconnection attempt
|
||||
- **AND** it SHALL notify the user when connection is restored
|
||||
|
||||
### Requirement: Redis Connection Error Handling
|
||||
|
||||
The system SHALL handle Redis connection errors gracefully.
|
||||
|
||||
#### Scenario: Handling Redis connection failure
|
||||
|
||||
- **WHEN** the system fails to connect to Redis
|
||||
- **THEN** it SHALL log the error
|
||||
- **AND** it SHALL display an error message to the user
|
||||
- **AND** it SHALL continue attempting to reconnect
|
||||
|
||||
### Requirement: Redis Connection Monitoring
|
||||
|
||||
The system SHALL monitor the Redis connection status.
|
||||
|
||||
#### Scenario: Monitoring Redis connection status
|
||||
|
||||
- **WHEN** the Redis connection status changes
|
||||
- **THEN** the system SHALL update the connection status in the UI
|
||||
- **AND** it SHALL log the status change
|
||||
@@ -61,7 +50,6 @@ The system SHALL monitor the Redis connection status.
|
||||
## Data Model
|
||||
|
||||
### Redis Connection Configuration
|
||||
|
||||
```json
|
||||
{
|
||||
"host": "string",
|
||||
@@ -77,7 +65,6 @@ The system SHALL monitor the Redis connection status.
|
||||
```
|
||||
|
||||
### Redis Connection Status
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "string", // e.g., connecting, connected, disconnected, error
|
||||
@@ -90,7 +77,6 @@ The system SHALL monitor the Redis connection status.
|
||||
## API Endpoints
|
||||
|
||||
### GET /api/redis/status
|
||||
|
||||
- **Description**: Get Redis connection status
|
||||
- **Response**:
|
||||
```json
|
||||
@@ -103,7 +89,6 @@ The system SHALL monitor the Redis connection status.
|
||||
```
|
||||
|
||||
### POST /api/redis/reconnect
|
||||
|
||||
- **Description**: Manually reconnect to Redis
|
||||
- **Response**:
|
||||
```json
|
||||
@@ -114,7 +99,6 @@ The system SHALL monitor the Redis connection status.
|
||||
```
|
||||
|
||||
### GET /api/projects
|
||||
|
||||
- **Description**: Get list of all projects from Redis
|
||||
- **Response**:
|
||||
```json
|
||||
@@ -136,7 +120,6 @@ The system SHALL monitor the Redis connection status.
|
||||
```
|
||||
|
||||
### POST /api/projects/migrate
|
||||
|
||||
- **Description**: Migrate heartbeat data from old structure to new unified structure
|
||||
- **Request Body**:
|
||||
```json
|
||||
|
||||
Reference in New Issue
Block a user