bn4t / gosensus

Simple consensus library based on etcd

Gosensus

This package implements a simple consensus algorithm to elect a leader among a number of nodes.

Includes a test to ensure the election algorithm works correctly.

Installation

go get github.com/bn4t/gosensus

How to use

package main

import (
    "github.com/bn4t/gosensus"
    "go.etcd.io/etcd/v3/clientv3"
    "go.uber.org/zap"
    "log"
    "time"
)

func main() { 
        // init etcd client 
	etcdCli, err := clientv3.New(clientv3.Config{
		Endpoints:   []string{"http://localhost:2379"},
		DialTimeout: 5 * time.Second,
	})
	
        // init zap logger
	Zap, err := zap.NewProduction()
	if err != nil {
		log.Fatal(err)
	}

        // init gosensus client
	GosClient := &gosensus.Client{
		EtcdClient: etcdCli,
		Logger:     Zap,
		DataDir:    "/var/lib/gosensus/", // the directory in which the node's key is stored
	}
	if err := GosClient.Start(); err != nil {
		log.Fatal("failed to start consensus", zap.Error(err))
	}
	
        log.Print(GosClient.IsLeader())
	
        GosClient.Stop()
}

License

MIT