Config4live-go

Centralized live configuration library for Go. for microservice or distributed system. Inspired from https://github.com/cfg4j/cfg4j

Features

• gRPC connection
  • Wrapped by grpc protocol (fast and high performance RPC framework) for requesting configuration to config server.
• Hystrix
  • Bundled with hystrix for circuit breaker. avoid cascading failures
• In-Memory cache
  • Avoid too many requests to config server
  • go-cache cache
• HTTP connection
  • Using net/http to provides HTTP client and server implementations.

gRPC proto file format

syntax = "proto3";

option java_multiple_files = true;
option java_package = "com.sayurbox.config4live";
option java_outer_classname = "LiveConfigurationProto";
option objc_class_prefix = "HLW";

package config4live;

service LiveConfiguration {
  // Find config by name
  rpc FindConfig (ConfigRequest) returns (ConfigResponse) {}
}

message ConfigRequest {
  string name = 1;
}

message ConfigResponse {
  string id = 1;
  string name = 2;
  string value = 3;
  string description = 4;
  enum Format {
      text = 0;
      number = 1;
      bool = 2;
      json = 3;
    }
  Format format = 5;
  string owner = 6;
}

Installation

go get github.com/sayurbox/config4live-go

Example

Params :

• url : mandatory
• hystrx : optional

Creating source can be done using 3 ways:

• Grpc only

import (
	"github.com/sayurbox/config4live-go"
	grpc "github.com/sayurbox/config4live-go/grpc"
)

func main() {
  source := grpc.NewGrpcSource(
		grpc.WithURL("localhost:50051"),
		grpc.WithHystrixTimeout(1000),
		grpc.WithHystrixErrorPercentThreshold(25),
		grpc.WithHystrixSleepWindow(500),
		grpc.WithHystrixRequestVolumeThreshold(10),
		grpc.WithHystrixMaxConcurrentRequests(10),
		grpc.WithHystrixCommandName("find-config-key"))
}

• Http only

import (
	"github.com/sayurbox/config4live-go"
	http "github.com/sayurbox/config4live-go/http"
)

func main() {
  source := http.NewHttpSource(
		http.WithURL("http://localhost:8080"),
		http.WithHystrixTimeout(1000),
		http.WithHystrixErrorPercentThreshold(25),
		http.WithHystrixSleepWindow(500),
		http.WithHystrixRequestVolumeThreshold(10),
		http.WithHystrixMaxConcurrentRequests(10),
		http.WithHystrixCommandName("find-config-key"))
}

• Auto

import (
	"github.com/sayurbox/config4live-go"
)

func main() {
  source := config4live.NewSource(
		config4live.WithURL("http://localhost:8080"),
		config4live.WithHystrixTimeout(1000),
		config4live.WithHystrixErrorPercentThreshold(25),
		config4live.WithHystrixSleepWindow(500),
		config4live.WithHystrixRequestVolumeThreshold(10),
		config4live.WithHystrixMaxConcurrentRequests(10),
		config4live.WithHystrixCommandName("find-config-key"))
}

Here complete usage :

import (
	"github.com/sayurbox/config4live-go"
	grpc "github.com/sayurbox/config4live-go/grpc"
)

type Person struct {
  Name    string
	Id      int
	Address Address
}

type Address struct {
	Postal      int
	Coordinates []float64
}

type List []string

func main() {
  source := grpc.NewGrpcSource(
		grpc.WithURL("localhost:50051"),
		grpc.WithHystrixTimeout(1000),
		grpc.WithHystrixErrorPercentThreshold(25),
		grpc.WithHystrixSleepWindow(500),
		grpc.WithHystrixRequestVolumeThreshold(10),
		grpc.WithHystrixMaxConcurrentRequests(10),
		grpc.WithHystrixCommandName("find-config-key"))
  provider := config4live.NewProvider(
      config4live.WithSource(source),
      config4live.WithCache(true),
      config4live.WithExpiration(5*time.Second))

  // find configuration with default value
  value := provider.BindString("test-name", "default_name")
  value := provider.BindBool("test-bool", true)
  value := provider.BindInt64("test-int", 123)
  value := provider.BindFloat64("test-float", 1.23)

  // struct type
  person := Person{
		Id:   2,
		Name: "Smith",
		Address: Address{
			Postal:      67890,
			Coordinates: []float64{0.88930, 0.32188},
		},
	}
  value := provider.BindAny("test-struct", person).(Person)

  // slice type
  list := List{}
  value := provider.BindAny("test-list", list).(List)
}