Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joyieldInc/predixy

A high performance and fully featured proxy for redis, support redis sentinel and redis cluster
https://github.com/joyieldInc/predixy

codis corvus redis redis-cluster redis-sentinel twemproxy

Last synced: 2 months ago
JSON representation

A high performance and fully featured proxy for redis, support redis sentinel and redis cluster

Host: GitHub
URL: https://github.com/joyieldInc/predixy
Owner: joyieldInc
License: bsd-3-clause
Created: 2017-07-24T02:41:01.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-07-19T02:32:39.000Z (6 months ago)
Last Synced: 2024-10-29T15:35:44.781Z (3 months ago)
Topics: codis, corvus, redis, redis-cluster, redis-sentinel, twemproxy
Language: C++
Homepage:
Size: 1.39 MB
Stars: 1,471
Watchers: 77
Forks: 348
Open Issues: 109
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-repositories - joyieldInc/predixy - A high performance and fully featured proxy for redis, support redis sentinel and redis cluster (C++)

README

# Predixy [中文版](https://github.com/joyieldInc/predixy/blob/master/README_CN.md)

**Predixy** is a high performance and fully featured proxy for redis sentinel and redis cluster

## Features

+ High performance and lightweight.
+ Multi-threads support.
+ Works on Linux, OSX, BSD, Windows([Cygwin](http://www.cygwin.com/)).
+ Supports Redis Sentinel, single/multi redis group[s].
+ Supports Redis Cluster.
+ Supports redis block command, eg:blpop, brpop, brpoplpush.
+ Supports scan command, even multi redis instances.
+ Multi-keys command support: mset/msetnx/mget/del/unlink/touch/exists.
+ Multi-databases support, means redis command select is avaliable.
+ Supports redis transaction, limit in Redis Sentinel single redis group.
+ Supports redis Scripts, script load, eval, evalsha.
+ Supports redis Pub/Sub.
+ Multi-DataCenters support, read from slaves.
+ Extend AUTH, readonly/readwrite/admin permission, keyspace limit.
+ Log level sample, async log record.
+ Log file auto rotate by time and/or file size.
+ Stats info, CPU/Memory/Requests/Responses and so on.
+ Latency monitor.

## Build

Predixy can be compiled and used on Linux, OSX, BSD, Windows([Cygwin](http://www.cygwin.com/)). Requires C++11 compiler.

It is as simple as:

$ make

To build in debug mode:

$ make debug

Some other build options:
+ CXX=c++compiler, default is g++, you can specify other, eg:CXX=clang++
+ EV=epoll|poll|kqueue, default it is auto detect according by platform.
+ MT=false, disable multi-threads support.
+ TS=true, enable predixy function call time stats, debug only for developer.

For examples:

$ make CXX=clang++
$ make EV=poll
$ make MT=false
$ make debug MT=false TS=true

## Install

Just copy src/predixy to the install path

$ cp src/predixy /path/to/bin

## Configuration

See below files:
+ predixy.conf, basic config, will refrence below config files.
+ cluster.conf, Redis Cluster backend config.
+ sentinel.conf, Redis Sentinel backend config.
+ auth.conf, authority control config.
+ dc.conf, multi-datacenters config.
+ latency.conf, latency monitor config.

## Running

$ src/predixy conf/predixy.conf

With default predixy.conf, Predixy will listen at 0.0.0.0:7617 and
proxy to Redis Cluster 127.0.0.1:6379.
In general, 127.0.0.1:6379 is not running in Redis Cluster mode.
So you will look mass log output, but you can still test it with redis-cli.

$ redis-cli -p 7617 info

More command line arguments:

$ src/predixy -h

## Stats

Like redis, predixy use INFO command to give stats.

Show predixy running info and latency monitors

redis> INFO

Show latency monitors by latency name

redis> INFO Latency

A latency monitor example:

LatencyMonitorName:all
latency(us) sum(us) counts
<= 100 3769836 91339 91.34%
<= 200 777185 5900 97.24%
<= 300 287565 1181 98.42%
<= 400 185891 537 98.96%
<= 500 132773 299 99.26%
<= 600 85050 156 99.41%
<= 700 85455 133 99.54%
<= 800 40088 54 99.60%
<= 1000 67788 77 99.68%
> 1000 601012 325 100.00%
T 60 6032643 100001
The last line is total summary, 60 is average latency(us)

Show latency monitors by server address and latency name

redis> INFO ServerLatency [latency-name]

Reset all stats and latency monitors, require admin permission.

redis> CONFIG ResetStat

## Benchmark

predixy is fast, how fast? more than twemproxy, codis, redis-cerberus

See wiki
[benchmark](https://github.com/joyieldInc/predixy/wiki/Benchmark)

## License

License under BSD 3-clause "New" or "Revised" License

WeChat:cppfan ![wechat](https://github.com/joyieldInc/predixy/blob/master/doc/wechat-cppfan.jpeg)