100 lines
2.9 KiB
Markdown
100 lines
2.9 KiB
Markdown
|
# 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
|
||
|
|
|
||
|
|
## Data Model
|
||
|
|
|
||
|
|
### Redis Connection Configuration
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"host": "string",
|
||
|
|
"port": "number",
|
||
|
|
"password": "string",
|
||
|
|
"db": "number",
|
||
|
|
"socket": {
|
||
|
|
"reconnectStrategy": "function",
|
||
|
|
"connectTimeout": "number",
|
||
|
|
"keepAlive": "number"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Redis Connection Status
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"status": "string", // e.g., connecting, connected, disconnected, error
|
||
|
|
"lastConnectedAt": "ISO-8601 string",
|
||
|
|
"lastDisconnectedAt": "ISO-8601 string",
|
||
|
|
"error": "string" // optional error message
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## API Endpoints
|
||
|
|
|
||
|
|
### GET /api/redis/status
|
||
|
|
- **Description**: Get Redis connection status
|
||
|
|
- **Response**:
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"status": "string",
|
||
|
|
"lastConnectedAt": "ISO-8601 string",
|
||
|
|
"lastDisconnectedAt": "ISO-8601 string",
|
||
|
|
"error": "string" // optional
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### POST /api/redis/reconnect
|
||
|
|
- **Description**: Manually reconnect to Redis
|
||
|
|
- **Response**:
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"success": true,
|
||
|
|
"message": "Reconnection attempt initiated"
|
||
|
|
}
|
||
|
|
```
|