BetterDB Monitor API参考手册RESTful接口详解与使用示例【免费下载链接】monitorReal-time monitoring, slowlog analysis, and audit trails for Valkey and Redis项目地址: https://gitcode.com/gh_mirrors/monitor53/monitorBetterDB Monitor 是一款功能强大的 Valkey 和 Redis 实时监控与分析工具提供了完整的 RESTful API 接口让开发者能够轻松集成监控功能到自己的应用中。本文将详细介绍 BetterDB Monitor 的核心 API 接口帮助您快速上手并充分利用其强大的监控能力。 连接管理 API连接管理是使用 BetterDB Monitor 的第一步这些接口让您能够配置和管理数据库连接。获取所有连接GET /connections获取所有已配置的数据库连接及其状态信息。返回的 JSON 包含连接列表和当前默认连接ID。测试连接配置POST /connections/test Content-Type: application/json { name: 生产环境, host: redis.example.com, port: 6379, username: default, password: your-password, tls: true }在不保存的情况下测试连接参数验证数据库可达性和功能支持。创建新连接POST /connections Content-Type: application/json { name: 生产环境, host: redis.example.com, port: 6379, setAsDefault: true }创建并保存一个新的数据库连接支持自动设置为默认连接。设置默认连接POST /connections/{id}/default将指定ID的连接设置为默认连接后续API调用无需指定连接ID头。 监控指标 APIBetterDB Monitor 提供了丰富的监控指标接口帮助您深入了解数据库性能。获取数据库信息GET /metrics/info获取数据库的基本信息包括版本、内存使用、连接数等关键指标。慢查询日志GET /metrics/slowlog?count10获取最近发生的慢查询记录支持分页和时间范围过滤。命令统计GET /metrics/commandstats获取命令执行统计信息包括每个命令的调用次数和总耗时。延迟分析GET /metrics/latency-history?hours24获取指定时间段内的延迟历史数据支持按小时聚合。 性能分析 API延迟直方图GET /latency-analytics/histograms?startTime1704067200000endTime1704153600000获取延迟分布的直方图数据用于深度性能分析。延迟快照GET /latency-analytics/snapshots?limit100offset0获取存储的延迟快照数据支持分页查询。内存分析GET /metrics/memory-stats获取详细的内存使用统计包括碎片率、峰值内存等关键指标。 审计与安全 API获取审计记录GET /audit/entries?usernameadminstartTime1704067200limit50检索ACL审计日志条目支持按用户、时间范围和失败原因过滤。审计统计GET /audit/stats?startTime1704067200endTime1704153600获取审计日志的聚合统计信息包括失败尝试次数和分类。失败认证记录GET /audit/failed-auth?limit100专门获取失败的认证尝试记录帮助识别安全威胁。️ 集群管理 API集群节点发现GET /metrics/cluster-nodes发现并列出集群中的所有节点信息。集群槽位统计GET /metrics/cluster-slot-stats?nodeIdnode-1获取集群槽位的分布和使用统计。集群慢查询GET /metrics/cluster-slowlog?nodeIdnode-1count20获取集群中特定节点的慢查询日志。 客户端分析 API客户端列表GET /metrics/clients获取当前连接到数据库的所有客户端信息。客户端详情GET /metrics/clients/{clientId}获取特定客户端的详细信息包括连接时间和执行命令。终止客户端连接POST /metrics/clients/{clientId}/kill强制终止指定客户端的连接用于处理异常连接。️ 实用工具 API健康检查GET /health检查API服务状态返回服务健康状态和版本信息。数据库大小GET /metrics/db-size获取当前数据库的键数量。最后保存时间GET /metrics/last-save-time获取数据库最后一次持久化的时间戳。 连接头与认证所有API都支持可选的X-Connection-Id请求头用于指定要操作的数据库连接X-Connection-Id: connection-id-here如果未提供连接头将使用默认连接。您可以通过 connections.controller.ts 了解更多连接管理细节。 响应格式所有API都返回统一的JSON响应格式成功响应{ data: { ... }, timestamp: 1704067200000 }错误响应{ error: 错误描述, code: ERROR_CODE, timestamp: 1704067200000 } 快速开始示例1. 测试连接curl -X POST http://localhost:3001/connections/test \ -H Content-Type: application/json \ -d { name: 测试连接, host: localhost, port: 6379 }2. 创建连接curl -X POST http://localhost:3001/connections \ -H Content-Type: application/json \ -d { name: 生产Redis, host: redis.prod.com, port: 6379, password: secret, setAsDefault: true }3. 获取监控数据curl -X GET http://localhost:3001/metrics/info?X-Connection-Idyour-connection-id4. 分析慢查询curl -X GET http://localhost:3001/metrics/slowlog?count50hours24 最佳实践连接复用创建连接后保存ID后续请求使用X-Connection-Id头错误处理检查HTTP状态码和错误响应体分页查询对于大量数据使用limit和offset参数时间过滤使用startTime和endTime参数限制查询范围定期健康检查定期调用/health接口监控服务状态 深入学习官方文档docs/official.md - 完整的API文档和配置指南AI功能源码plugins/ai/ - AI驱动的异常检测和智能分析功能监控模块apps/api/src/metrics/ - 监控指标采集和处理的完整实现BetterDB Monitor 的API设计遵循RESTful原则提供了直观、一致的接口体验。无论您是需要实时监控、性能分析还是安全审计这些API都能满足您的需求。通过合理的API调用组合您可以构建出强大的监控和分析解决方案。现在就开始使用BetterDB Monitor API为您的Valkey和Redis部署提供专业的监控保障吧【免费下载链接】monitorReal-time monitoring, slowlog analysis, and audit trails for Valkey and Redis项目地址: https://gitcode.com/gh_mirrors/monitor53/monitor创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考