braid

README

Braid

---

中文

Intro

Description of Service Node Module RPC Pub-sub

---

• RPC Client/Server - Used for request / response from service to service
• Pub-sub - Used to publish & subscribe messages from module to module
• Discover - Automatic service discovery, and broadcast the node's entry, exit, update and other messages
• Balancer - Client side load balancing which built on service discovery. Provide smooth weighted round-robin balancing by default
• Elector - Select a unique master node for the same name service
• Tracer - Distributed tracing system, used to monitor the internal state of the program running in microservices
• Linkcache - Link cache used to maintain connection information in distributed systems

Modules

Discovery	Balancing	Elector	RPC	Pub-sub	Tracer	LinkCache
discoverconsul	balancerrandom	electorconsul	grpc-client	mailbox	jaegertracer	linkerredis
	balancerswrr	electork8s	grpc-server

Quick start

s := braid.NewService("gate")   // create a new node in the service gate

// register module in node
s.Register(
    braid.Module(braid.LoggerZap),
    braid.Module(braid.PubsubNsq,
        pubsubnsq.WithLookupAddr([]string{mock.NSQLookupdAddr}),
        pubsubnsq.WithNsqdAddr([]string{mock.NsqdAddr}, []string{mock.NsqdHttpAddr}),
    ),
    braid.Module(
        braid.DiscoverConsul,    // discover module
        discoverconsul.WithConsulAddr(consulAddr)
    ),
)

s.Init()
s.Run()

defer s.Close()

Pub-sub Benchmark

• ScopeProc

$ go test -benchmem -run=^$ -bench ^BenchmarkTestProc -cpu 2,4,8
cpu: 2.2 GHz 4 Cores Intel Core i7
goos: darwin
goarch: amd64
pkg: github.com/pojol/braid-go/modules/mailboxnsq
BenchmarkTestProc-2   4340389   302 ns/op   109 B/op   3 allocs/op
BenchmarkTestProc-4   8527536   151 ns/op   122 B/op   3 allocs/op
BenchmarkTestProc-8   7564869   161 ns/op   118 B/op   3 allocs/op
PASS

• ScopeCluster

$ go test -benchmem -run=^$ -bench ^BenchmarkClusterBroadcast -cpu 2,4,8
tencent cloud 4 Cores
goos: linux
goarch: amd64
BenchmarkClusterBroadcast-2   70556   17234 ns/op   540 B/op   16 allocs/op
BenchmarkClusterBroadcast-4   71202   18975 ns/op   676 B/op   20 allocs/op
BenchmarkClusterBroadcast-8   62098   19037 ns/op   662 B/op   20 allocs/op

Documentation

Index

• Constants
• Variables
• func Client() client.IClient
• func Module(name string, opts ...interface{}) module.IBuilder
• func Pubsub() pubsub.IPubsub
• func Server() server.IServer
• func Tracer() tracer.ITracer
• type Braid
  • func NewService(name string) (*Braid, error)
  • func (b *Braid) Close()
  • func (b *Braid) Init()
  • func (b *Braid) Register(builders ...module.IBuilder) error
  • func (b *Braid) Run()

Constants

const (
	// Version of braid-go
	Version = "v1.2.26"
)

Variables

var (
	ErrTypeConvFailed = errors.New("type conversion failed")

	// 默认提供的模块
	LoggerZap      = zaplogger.Name
	PubsubNsq      = pubsubnsq.Name
	DiscoverConsul = discoverconsul.Name
	ElectorConsul  = electorconsul.Name
	ElectorK8s     = electork8s.Name
	ClientGRPC     = grpcclient.Name
	ServerGRPC     = grpcserver.Name
	TracerJaeger   = jaegertracing.Name
	BalancerSWRR   = balancernormal.Name
	LinkcacheRedis = linkerredis.Name
)

Functions

func Client

func Client() client.IClient

GetClient get client interface

func Module

func Module(name string, opts ...interface{}) module.IBuilder

func Pubsub

func Pubsub() pubsub.IPubsub

Mailbox pub-sub

func Server

func Server() server.IServer

func Tracer

func Tracer() tracer.ITracer

Tracer tracing

Types

type Braid

type Braid struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Braid framework instance

func NewService

func NewService(name string) (*Braid, error)

func (*Braid) Close

func (b *Braid) Close()

Close 关闭braid

func (*Braid) Init

func (b *Braid) Init()

Init braid init

func (*Braid) Register

func (b *Braid) Register(builders ...module.IBuilder) error

func (*Braid) Run

func (b *Braid) Run()

Run 运行braid