PhxQueue

简体中文README

PhxQueue is a high-availability, high-throughput and highly reliable distributed queue based on the Paxos protocol. It guarantees At-Least-Once Delivery. It is widely used in WeChat for WeChat Pay, WeChat Media Platform, and many other important business.

Authors: Junjie Liang, Tao He, Haochuan Cui and Jiatao Xu

Contact us: phxteam@tencent.com

Features

• Absolutely No data lose and strictly reconciliation mechanism

• Server batch enqueue

• Dequeue in order strictly

• Multiple Subscribers

• Dequeue speed limit

• Dequeue replay

• Consumer loadbalance

• All module are scalable

• A group of Store or Lock deploy on multiple region is supported

Auto Build

git clone https://github.com/Tencent/phxqueue
cd phxqueue/
bash build.sh

Manually Compile

Download PhxQueue source

Download the phxqueue.tar.gz and un-tar it to $PHXQUEUE_DIR.

Install Dependence

• Prepare the $DEP_PREFIX diectory for dependence installation. For example:

  export $DEP_PREFIX='/usr/local'

• Protocol Buffers and glog

  Build Protocol Buffers and glog with ./configure CXXFLAGS=-fPIC --prefix=$DEP_PREFIX. Then make some links:

  rm -r $PHXQUEUE_DIR/third_party/protobuf/
  rm -r $PHXQUEUE_DIR/third_party/glog/
  ln -s $DEP_PREFIX $PHXQUEUE_DIR/third_party/protobuf
  ln -s $DEP_PREFIX $PHXQUEUE_DIR/third_party/glog

• LevelDB

  Build LevelDB in $PHXQUEUE_DIR/third_party/leveldb/ and ln -s out-static lib.

• PhxPaxos and PhxRPC

  Build PhxPaxos in $PHXQUEUE_DIR/third_party/phxpaxos/. Build PhxRPC in $PHXQUEUE_DIR/third_party/phxrpc/.

• libco

  Git clone libco to $PHXQUEUE_DIR/third_party/colib/.

Compile PhxQueue

cd $PHXQUEUE_DIR/
make

The PhxQueue Distribution

PhxQueue is structured like this:

phxqueue/ ................. The PhxQueue root directory
├── bin/ .................. Generated Binary files
├── etc/ .................. Example Configure files
├── lib/ .................. Generated Library files
├── phxqueue/ ............. PhxQueue source files
├── phxqueue_phxrpc/ ...... PhxQueue with PhxRPC implementation
└── ...

the output files are located in bin/ and lib/, while the sample configure files are located in etc/.

Start a simple PhxQueue

The built PhxQueue is ready to run simple demos.

Preparation

PhxQueue open multiple files on the same time. Make sure to set enough (> 4000) open files limit with ulimit -Sn or ulimit -n.

Start Store

Now Start 3 Store node (add -d if run as daemon):

bin/store_main -c etc/store_server.0.conf
bin/store_main -c etc/store_server.1.conf
bin/store_main -c etc/store_server.2.conf

You can find informations and errors in log files:

ps -ef | grep store_main
tail -f log/store.0/store_main.INFO
tail -f log/store.1/store_main.INFO
tail -f log/store.2/store_main.INFO

Start Consumer

Now Start 3 Consumer node:

bin/consumer_main -c etc/consumer_server.0.conf
bin/consumer_main -c etc/consumer_server.1.conf
bin/consumer_main -c etc/consumer_server.2.conf

You can find informations and errors in log files:

ps -ef | grep consumer_main
tail -f log/consumer.0/consumer_main.INFO
tail -f log/consumer.1/consumer_main.INFO
tail -f log/consumer.2/consumer_main.INFO

Send Single Test Requests

Now the deploy of simple PhxQueue is finished! Use the benchmark tool to send some test request:

bin/test_producer_echo_main

You will get the output from test Producer:

produce echo succeeded!

Now let's see the output of Consumer (only 1 of 3 consumers):

consume echo succeeed! ...

Run Benchmark

bin/producer_benchmark_main 10 5 5 10

Watch the Consumer log files again:

tail -f log/consumer.0/consumer_main.INFO
tail -f log/consumer.1/consumer_main.INFO
tail -f log/consumer.2/consumer_main.INFO

Now you can see the Consumer dequeue log like this:

INFO: Dequeue ret 0 topic 1000 sub_id 1 store_id 1 queue_id 44 size 1 prev_cursor_id 9106 next_cursor_id 9109

Clear Test Logs or Data

While running PhxQueue, losts of logs and data are generated. Run log/clear_log.sh to clear logs. Run data/clear_data.sh to delete data. Please make sure the data is useless before delete.

Deploy Distributed PhxQueue

Normally, each node should be deployed on one machine. Change the etc/*.conf for each node.

Files located in directory etc/:

globalconfig.conf .................Global config
topicconfig.conf ................. Topic config
storeconfig.conf ................. Store config
consumerconfig.conf ...............Consumer config
schedulerconfig.conf ..............Scheduler config
lockconfig.conf ...................Lock config

Deloy and modify these files on all target machine.

Deploy Store

Store is the storage module for queue, using the Paxos protocol for replica synchronization.

Deploy these config to 3 Store node and start:

bin/store_main -c etc/store_server.0.conf -d
bin/store_main -c etc/store_server.1.conf -d
bin/store_main -c etc/store_server.2.conf -d

Deploy Consumer

Consumer pull and consume data from Store.

Deploy these config to 3 Consumer node and start:

bin/consumer_main -c etc/consumer_server.0.conf -d
bin/consumer_main -c etc/consumer_server.1.conf -d
bin/consumer_main -c etc/consumer_server.2.conf -d

Deploy Lock (Optional)

Lock is a distributed lock module. You can deploy Lock independently, providing a common distributed lock service.

Set skip_lock = 1 in topicconfig.conf if not use Lock.

Deploy these config to 3 Lock node and start:

bin/lock_main -c etc/lock_server.0.conf -d
bin/lock_main -c etc/lock_server.1.conf -d
bin/lock_main -c etc/lock_server.2.conf -d

Deploy Scheduler (Optional)

Scheduler gathers global load information from Consumer for disaster tolerance and load balancing. If no Scheduler is deployed, Consumer will be assigned according to the configuration weight.

If you need to deploy Scheduler, deploy Lock first.

Set use_dynamic_scale = 0 in topicconfig.conf if not use Scheduler.

Deploy these config to 3 Scheduler node and start:

bin/scheduler_main -c etc/scheduler_server.0.conf -d
bin/scheduler_main -c etc/scheduler_server.1.conf -d
bin/scheduler_main -c etc/scheduler_server.2.conf -d

View Logs

You can find informations and errors in log files. For example, the number 0 Store node:

tail -f log/store.0/store_main.INFO

Contribution

Please follow Google C++ Style Guide in PRs.