hs-video-api/QUEUE_CONFIG_README.md
2025-06-07 00:28:35 +08:00

91 lines
3.0 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 队列管理配置说明
本文档说明了视频生成API服务中队列管理相关的配置参数。
## 配置参数
### 基础队列配置
| 参数名 | 环境变量 | 默认值 | 说明 |
|--------|----------|--------|------|
| 最大运行任务数 | `QUEUE_MAX_RUNNING_TASKS` | 5 | 同时运行的最大任务数量 |
| 状态更新间隔 | `QUEUE_UPDATE_INTERVAL` | 5 | 任务状态检查更新间隔(秒) |
| 持久化文件 | `QUEUE_PERSISTENCE_FILE` | task_queue_persistence.json | 队列数据持久化文件路径 |
### 缓存管理配置
| 参数名 | 环境变量 | 默认值 | 说明 |
|--------|----------|--------|------|
| 已完成任务缓存大小 | `QUEUE_MAX_COMPLETED_CACHE_SIZE` | 100 | 最多保留的已完成任务数量 |
| 缓存保留时间 | `QUEUE_COMPLETED_CACHE_TTL_HOURS` | 24 | 已完成任务在缓存中保留的小时数 |
## 环境配置建议
### 开发环境 (.env.dev)
```bash
# 队列管理配置
QUEUE_MAX_RUNNING_TASKS=5
QUEUE_UPDATE_INTERVAL=5
QUEUE_PERSISTENCE_FILE=task_queue_persistence.json
QUEUE_MAX_COMPLETED_CACHE_SIZE=100
QUEUE_COMPLETED_CACHE_TTL_HOURS=24
```
### 测试环境 (.env.dev-server)
```bash
# 队列管理配置
QUEUE_MAX_RUNNING_TASKS=8
QUEUE_UPDATE_INTERVAL=3
QUEUE_PERSISTENCE_FILE=task_queue_persistence.json
QUEUE_MAX_COMPLETED_CACHE_SIZE=200
QUEUE_COMPLETED_CACHE_TTL_HOURS=24
```
### 生产环境 (.env.pro)
```bash
# 队列管理配置
QUEUE_MAX_RUNNING_TASKS=10
QUEUE_UPDATE_INTERVAL=3
QUEUE_PERSISTENCE_FILE=task_queue_persistence.json
QUEUE_MAX_COMPLETED_CACHE_SIZE=500
QUEUE_COMPLETED_CACHE_TTL_HOURS=48
```
## 配置调优建议
### QUEUE_MAX_RUNNING_TASKS最大运行任务数
- **开发环境**: 5个任务适合本地开发测试
- **测试环境**: 8个任务模拟中等负载
- **生产环境**: 10个任务根据服务器性能和API限制调整
### QUEUE_UPDATE_INTERVAL状态更新间隔
- **开发环境**: 5秒便于调试观察
- **测试/生产环境**: 3秒提高响应速度
- **注意**: 间隔太短会增加API调用频率太长会影响用户体验
### QUEUE_MAX_COMPLETED_CACHE_SIZE缓存大小
- **开发环境**: 100个任务满足基本需求
- **测试环境**: 200个任务支持更多测试场景
- **生产环境**: 500个任务支持高并发场景
### QUEUE_COMPLETED_CACHE_TTL_HOURS缓存保留时间
- **开发/测试环境**: 24小时便于调试和测试
- **生产环境**: 48小时给用户更长的查询窗口
## 性能影响
1. **QUEUE_MAX_RUNNING_TASKS**: 影响并发处理能力和资源消耗
2. **QUEUE_UPDATE_INTERVAL**: 影响状态更新及时性和API调用频率
3. **QUEUE_MAX_COMPLETED_CACHE_SIZE**: 影响内存使用和查询性能
4. **QUEUE_COMPLETED_CACHE_TTL_HOURS**: 影响存储空间和数据一致性
## 监控建议
建议监控以下指标:
- 运行中任务数量
- 等待队列长度
- 任务完成率
- 平均处理时间
- 缓存命中率
通过这些指标可以判断当前配置是否合适,并进行相应调整。