开发
开发 RedisTimeSeries
开发 RedisTimeSeries 需要设置开发环境(可以是基于 Linux 或 macOS 的环境),构建 RedisTimeSeries 模块,运行测试和基准测试,并调试 RedisTimeSeries 模块及其测试。
克隆 git 仓库
通过执行以下命令,可以克隆 RedisTimeSeries 模块及其子模块
git clone --recursive https://github.com/RedisTimeSeries/RedisTimeSeries.git
在隔离环境中工作
在隔离环境中开发有多种原因,例如保持工作站整洁,以及为不同的 Linux 发行版进行开发。隔离环境最通用的选择是虚拟机(使用 Vagrant 可以很容易地设置)。Docker 是一种更灵活的解决方案,因为它提供了几乎即时的解决方案
ts=$(docker run -d -it -v $PWD:/build debian:bullseye bash)
docker exec -it $ts bash
然后,在容器内,执行 cd /build
并照常进行。在此模式下,所有安装都保留在 Docker 容器的范围内。退出容器后,您可以再次使用上述 docker exec
调用容器,或将容器的状态提交到镜像并在稍后阶段再次调用它
docker commit $ts ts1
docker stop $ts
ts=$(docker run -d -it -v $PWD:/build ts1 bash)
docker exec -it $ts bash
安装前提条件
要构建和测试 RedisTimeSeries,您需要安装几个包,具体取决于底层操作系统。目前,我们支持 Ubuntu/Debian、CentOS、Fedora 和 macOS。
如果您安装了 gnu make
,您可以执行
cd RedisTimeSeries
make setup
或者,只需执行以下操作
cd RedisTimeSeries
git submodule update --init --recursive
./deps/readies/bin/getpy3
./system-setup.py
请注意,system-setup.py
将使用本机包管理器和 pip 在您的系统上安装各种包。这需要在 Linux 上具有 root 权限(即 sudo
)。
如果您希望避免这种情况,可以
- 查看
system-setup.py
并手动安装包, - 使用上面解释的隔离环境,
- 利用 Python 虚拟环境,因为已知 Python 安装在非隔离环境下很敏感。
安装 Redis
根据经验法则,最好运行最新的 Redis 版本。
如果您的操作系统有 Redis 包,可以使用操作系统包管理器安装。
否则,您可以执行 ./deps/readies/bin/getredis
。
获取帮助
make help
提供开发功能的快速摘要。
从源码构建
make
将构建 RedisTimeSeries。
构建产物将放置在 bin/linux-x64-release
目录中(或类似目录,根据您的平台和构建选项而定)。
使用 make clean
删除构建产物。make clean ALL=1
将删除整个二进制产物目录。
使用 RedisTimeSeries 运行 Redis
以下命令将运行 redis
并加载 RedisTimeSeries 模块。
make run
您可以在另一个终端中打开 redis-cli
与之交互。
运行测试
该模块包含一套基本的单元测试和集成测试
- 位于
src/tests
中的 C 单元测试,通过make unit_tests
运行。 - 位于
tests/flow
中的 Python 集成测试(由 RLTest 启用),通过make flow_tests
运行。
可以通过执行 make test
运行所有测试。可以使用 TEST
参数运行单个测试,例如 make flow_test TEST=file:name
。
调试
要构建用于调试(启用符号信息并禁用优化)的版本,请运行 make DEBUG=1
。然后可以使用 make run DEBUG=1
调用 gdb
。除了在 gdb
中设置断点的常规方法外,还可以使用 BB
宏在 RedisTimeSeries 代码内部设置断点。它只有在 gdb
下运行时才会生效。
类似地,在单测试模式下的 Python 测试中,可以使用测试内部的 BB()
函数设置断点。这将调用 pudb
。
这两种方法可以结合使用:可以在流测试中设置断点,当达到断点时,将 gdb
连接到 redis-server
进程以调试模块。