# zbus-go

**Repository Path**: rushmore/zbus-go

## Basic Information

- **Project Name**: zbus-go
- **Description**: zbus Golang server and client
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://zbus.io
- **GVP Project**: No

## Statistics

- **Stars**: 18
- **Forks**: 4
- **Created**: 2017-08-16
- **Last Updated**: 2021-10-13

## Categories & Tags

**Categories**: web-dev-toolkits

**Tags**: None

## README

                /\\\       
                \/\\\        
                 \/\\\    
     /\\\\\\\\\\\ \/\\\         /\\\    /\\\  /\\\\\\\\\\     
     \///////\\\/  \/\\\\\\\\\  \/\\\   \/\\\ \/\\\//////     
           /\\\/    \/\\\////\\\ \/\\\   \/\\\ \/\\\\\\\\\\    
          /\\\/      \/\\\  \/\\\ \/\\\   \/\\\ \////////\\\  
         /\\\\\\\\\\\ \/\\\\\\\\\  \//\\\\\\\\\   /\\\\\\\\\\  
         \///////////  \/////////    \/////////   \//////////       QQ Group: 467741880

# ZBUS = MQ + RPC  
zbus strives to make Message Queue and Remote Procedure Call fast, light-weighted and easy to build your own service-oriented architecture for many different platforms. Simply put, zbus = mq + rpc.

zbus carefully designed on its protocol and components to embrace KISS(Keep It Simple and Stupid) principle, but in all it delivers power and elasticity. 

Golang Server and Client

## Features
- Fast MQ on disk, capable of unicast, multicast and broadcast messaging models
- Easy RPC support out of box, language agnostic
- Officially support Java/.NET/Javascript/C_C++/Python/Go/PHP clients
- Extremely light-weighted, (~1M zipped executable, no dependency)
- High Availability inside, able to join or leave any distributed components
- TCP/HTTP/WebSocket, Monitor, all in one port, support DMZ deployment
- Based on simple protocol: HTTP-header extension, and browser access friendly


## Performance

	Single Mac i7 box with SSD, with apache ab -k -c 32 -n 4000000 URL

	Produce:  ~70,000/s
	Consume:  ~60,000/s
	RPC: ~20,000/s (java service)

## Getting started
### Installation
- Build from source

Download the source, in server directory

	go build  

No dependency just Go!

- Download executable

Directly download from the prebuilt binary.



Incase you may interest in the client projects, go to zbus source root directory

	git submodule update --init --recursive  

On your favorite OS, run the built zbus binary, access the monitor address

[http://localhost:15555](http://localhost:15555) 

You can change the default configuration, in console, type 

	zbus -h             (change the binary name to 'zbus' if by default is 'server')

all self-explained, with configurable items listed such as port to listen, directory to store MQ and log etc.

![Monitor](https://git.oschina.net/uploads/images/2017/0630/162232_543dc692_7458.png "Monitor")


### MQ and RPC at a glance

In the monitor page, as you can see, there are two sections
1. Tracked Servers

	List all the MqServer joined.
	
	zbus instance by default plays the role of both Tracker and MqServer, and if tracker mode enabled, the zbus instance is able to accept other zbus instances to join as tracked server. And the tracked items such topics are aggregated for viewing.

	To join zbus tracker(s), just start zbus with --tracker={address_list}

2. TopicTable

	List all Topic avaiable for the tracked MqServers
	
	Including important fields as Topic name, message depth in disk, consume-groups, consumer online, message consume filter.

	For more detailed explanation of these glossaries please refer to components section.

In zbus, RPC is implemented via MQ, a MQ can be a message container for the RPC service, and internally it contains a mask to indicate the MQ's purpose of RPC.

The monitor page keeps evolving, more and more items will be added in.

## Components

![Archit](https://git.oschina.net/uploads/images/2017/0517/183402_0efce626_7458.png "Archit")

The above figure shows the 3 major distributed components--**broker**, **producer** and **consumer** 

**Broker** 

*Single mode*, Broker is the zbus instance(MqServer), stores messages produced, delivers messages to consumers.

*HA mode*, Broker is an abstracted server(Trackers + MqServers), capable of failover and smart algorithms on selection of MqServer, 
but still just work like a single MqServer.


**Producer**

Producer publish message to Broker, capable of customerize the selection algorithm based on the application's will.

**Consumer**

Consumer takes message from Broker, capable of relocating consuming position based on message offset.

**Topic**

Topic is a message queue identity, message with same topic fall into the same message store queue. 

**ConsumeGroup**

ConsumeGroup controls the consumer behavior, it stores latest consumed position of the topic, and filter out message if ConsumeGroup's filter is set.
ConsumeGroup is super light-weighted in zbus, it is just like a pointer to the message queue, with carefully craft on ConsumeGroup,
applications can form unicast, multicast, and broadcast messaging models.

## Protocol


## Internal Design

Broker Design

DiskQueue Design

RPC Design