hashring

README

grpc-hashring

A Go implementation of a gRPC client-side load balancer that uses consistent hashing to load balance gRPC subconnections.

Setup

conn, err := grpc.Dial(
	...,
    grpc.WithDefaultServiceConfig(`"loadBalancingConfig": {
        "hashring": {
          "keyReplicationCount": 2
        }
    }`),
    ...
)
if err != nil {
    ...
}
defer conn.Close()

Common Usages

Documentation

Index

• Constants
• func ContextWithHashringKey(ctx context.Context, key string) context.Context
• func HashringKeyFromContext(ctx context.Context) (string, bool)
• func NewHashringBalancerBuilder() balancer.Builder
• type HashringBalancerConfig

Constants

const Name = "hashring"

Name is the name of hashring balancer.

Functions

func ContextWithHashringKey

func ContextWithHashringKey(ctx context.Context, key string) context.Context

func HashringKeyFromContext

func HashringKeyFromContext(ctx context.Context) (string, bool)

func NewHashringBalancerBuilder

func NewHashringBalancerBuilder() balancer.Builder

Types

type HashringBalancerConfig

type HashringBalancerConfig struct {
	serviceconfig.LoadBalancingConfig
	KeyReplicationCount int `json:"keyReplicationCount"`
}