*Redis HOTKEYS-HELP 命令
HOTKEYS-HELP 用于显示 HotKeys 模块的帮助信息,列出所有可用的 HotKeys 命令及其基本用法。
*语法
HOTKEYS-HELP
*参数说明
无参数。
*返回值
- Array:包含 HotKeys 模块所有命令及简介的字符串数组
- Error:HotKeys 模块未加载时返回
*时间复杂度
O(1)
*
*示例
*查看 HotKeys 帮助信息
> HOTKEYS-HELP
1) "HOTKEYS [MAX count] [MIN frequency] - Show hot keys and their frequencies"
2) "HOTKEYS-GET key - Get frequency of a specific key"
3) "HOTKEYS-START [options] - Start hot keys monitoring"
4) "HOTKEYS-STOP - Stop hot keys monitoring"
5) "HOTKEYS-RESET - Reset hot keys statistics"
6) "HOTKEYS-HELP - Show this help message"
*确认模块已加载
> HOTKEYS-HELP
1) "HOTKEYS [MAX count] [MIN frequency] - Show hot keys and their frequencies"
*在模块未加载时调用
> HOTKEYS-HELP
(error) ERR unknown command 'hotkeys-help'
*常见错误
| 错误 | 原因 | 解决 |
|---|---|---|
| ERR unknown command 'hotkeys-help' | HotKeys 模块未加载 | 在 redis.conf 中加载 hotkeys.so 模块 |
| 返回空数组 | 模块加载异常或版本不兼容 | 检查模块版本与 Redis 版本兼容性,重新加载模块 |
| 命令描述为空或乱码 | 模块编译或加载异常 | 重新编译并加载模块,检查日志中的错误信息 |
*最佳实践
- 场景:首次使用 HotKeys 模块时快速了解可用命令
- 在排查 HotKeys 功能异常时,先执行
HOTKEYS-HELP确认模块已正确加载 - 可集成到运维脚本中,用于检查 Redis 实例是否具备热点键分析能力
- 建议将帮助信息保存到运维文档,供团队快速参考
- 升级 Redis 或 HotKeys 模块后重新执行,确认命令列表是否有变更
*FAQ
Q1: HOTKEYS-HELP 会返回命令的详细语法吗? A: 返回的是命令简介,详细语法请参考各命令的独立文档。
Q2: 为什么返回的命令列表和文档描述不一致? A: 不同版本的 HotKeys 模块命令可能略有差异,以实际加载模块的帮助信息为准。
Q3: 可以在 Redis 集群的所有节点上同时执行吗? A: 可以,但需逐个节点执行。热点键分析通常建议在主节点上执行。
Q4: HOTKEYS-HELP 返回的命令列表和文档版本不一致怎么办? A: 以实际加载的模块版本为准。不同版本的 HotKeys 模块可能增减命令,建议升级模块后重新查看帮助信息。
Q5: 为什么某些命令在帮助信息中有但无法执行?
A: 可能是权限限制(如非管理员用户)或命令被禁用(通过 rename-command 配置)。检查 Redis 配置和当前用户权限。