chassis

README

中文版README

Go-Chassis is a microservice framework for rapid development of microservices in Go

Why use Go chassis

• go chassis is designed as a protocol-independent framework, any protocol is able to integrate with go chassis and leverage same function like load balancing, circuit breaker,rate limiting, routing management, those function resilient your service

• go chassis makes service observable by bringing open tracing and prometheus to it.

• go chassis is flexible, many different modules can be replaced by other implementation, like registry, metrics, handler chain, config server etc

• With many build-in function like route management, circuit breaker, load balancing, monitoring etc, your don't need to investigate, implement and integrate many solutions yourself.

• go chassis supports Istio control panel, go chassis can bring better performance to go program, you can use Istio configurations to control go chassis.

• https://github.com/huaweicloud/spring-cloud-huawei integrate with servicecomb, go chassis can work together with spring cloud.

Features

• Pluggable registrator and discovery service: Support Service center, istio pilot, kubernetes and file based registry, fit both client side discovery and server side discovery pattern
• Pluggable Protocol: You can custom your own protocol, by default support http and grpc
• Multiple server management: you can separate API by protocols and ports
• Circuit breaker: Protect your micro service system in runtime
• Route management: Able to route to different service based on weight and match rule to achieve Canary Release easily
• Client side Load balancing: Able to custom strategy
• Rate limiting: Both client side and server side rate limiting
• Pluggable Cipher: Able to custom your own cipher for AKSK and TLS certs
• Handler Chain: Able to add your own code during service calling for client and server side
• Metrics: Able to expose Prometheus metric API automatically and custom metrics reporter
• Tracing:Use opentracing-go as standard library, easy to integrate tracing impl
• Logger: You can custom your own writer to sink log, by default support file and stdout
• Hot-reconfiguraion: Powered by go-archaius, configurations can be reload in runtime, like load balancing, circuit breaker, rate limiting
• Dynamic Configuration framework: Powered by go-archaius, developer is able to develop a service which has hot-reconfiguration feature easily
• Fault Injection: In consumer side, you can inject faults to bring chaos testing into your system
• API gateway and service mesh solution: powered by servicecomb-mesher.
• Open API 2.0 support go chassis will automatically generate Open API 2.0 doc and register it to service center. you can manage all the API docs in one place

You can check plugins to see more features

Get started

1.Generate go mod

go mod init

2.Add go chassis

GO111MODULE=on go get github.com/go-chassis/go-chassis

if you are facing network issue

export GOPROXY=https://goproxy.io

3.Write your first http micro service

Documentations

You can see more documentations in here, this online doc is for latest version of go chassis, if you want to see your version's doc, follow here to generate it in local

Examples

You can check examples here

NOTICE: Now examples is migrating to here

Communication Protocols

Go-Chassis supports 3 types of communication protocol.

1. Rest - REST is an approach that leverages the HTTP protocol for communication.
2. Highway - This is a RPC communication protocol, it was deprecated.
3. grpc - native grpc protocol, go chassis bring circuit breaker, route management etc to grpc.

Debug suggestion for dlv:

Add -tags debug into go build arguments before debugging, if your go version is go1.10 onward.

example:

go build -tags debug -o server -gcflags "all=-N -l" server.go

Chassis customized debug tag to resolve dlv debug issue:

https://github.com/golang/go/issues/23733

https://github.com/derekparker/delve/issues/865

Eco system

this part introduce some eco systems that go chassis can run with

Apache ServiceComb

With ServiceComb service center as registry, go chassis supply more features like contract management and multiple service registry, highly recommended. that will not prevent you from using kubernetes or Istio, Because service center can aggregate heterogeneous registry and give you a unified service registry entry point.

Kubernetes and Istio

go chassis has k8s registry and Istio registry plugins, and support Istio traffic management you can use spring cloud or Envoy with go chassis under same service discovery service.

Other project using go-chassis

• apache/servicecomb-kie: A distributed configuration management service, go chassis and mesher integrate with it, so that user can manage service configurations by this service.
• apache/servicecomb-mesher: A service mesh able to co-work with go chassis, it is able to run as a API gateway also.
• KubeEdge: Kubernetes Native Edge Computing Framework (project under CNCF) https://kubeedge.io

To start developing go chassis

1. Install go 1.12+

2. Clone the project

git clone git@github.com:go-chassis/go-chassis.git

1. Download vendors

cd go-chassis
export GO111MODULE=on 
go mod download
#optional
export GO111MODULE=on 
go mod vendor

NOTICE：if you do not use mod, We can not ensure you the compatibility. however you can still maintain your own vendor, which means you have to solve compiling issue your own.

1. Install service-center

Documentation

Index

• func Init() error
• func RegisterSchema(serverName string, structPtr interface{}, opts ...server.RegisterOption)
• func Run() error
• func SetDefaultConsumerChains(c map[string]string)
• func SetDefaultProviderChains(c map[string]string)
• type Schema

Functions

func Init

func Init() error

Init prepare the chassis framework runtime

func RegisterSchema

func RegisterSchema(serverName string, structPtr interface{}, opts ...server.RegisterOption)

RegisterSchema Register a API service to specific server by name You must register API first before Call Init

func Run

func Run() error

Run bring up the service,it waits for os signal,and shutdown gracefully before all protocol server start successfully, it may return error.

func SetDefaultConsumerChains

func SetDefaultConsumerChains(c map[string]string)

SetDefaultConsumerChains your custom chain map for Consumer,if there is no config, this default chain will take affect

func SetDefaultProviderChains

func SetDefaultProviderChains(c map[string]string)

SetDefaultProviderChains set your custom chain map for Provider,if there is no config, this default chain will take affect

Types

type Schema

type Schema struct {
	// contains filtered or unexported fields
}

Schema struct for to represent schema info