chassis

README

Go-Chassis

Go-Chassis is a Software Development Kit(SDK) for rapid development of microservices in Go

Go-chassis is based on Go-Micro A pluggable RPC framework

Features

• Pluggable registrator and discovery service: Support Service center,istio pilot 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 highway(RPC)
• Circuit breaker: Protect your service in runtime or on-demand
• Route management: Able to route to different service based on weight and match rule to achieve Canary Release easily
• Load balancing: Able to custom strategy and filter
• 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: Integrate with Zipkin to sink tracing data
• Logger: You can custom your own writer to sink log, by default support file and stdout
• Hot-reconfiguraion: A lot of configuration can be reload in runtime, like loadbalancing, circuit breaker, rate limiting
• Dynamic Configuration framework: 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

You can check plugins to see more features

Quick Start

You can see more documentations in here

1. Install go 1.8+

2. Clone the project

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

1. Use glide to download dependencies

cd go-chassis 
glide install

1. Install service-center

2. Write your first http micro service

Examples

You can check examples here

Communication Protocols

Go-Chassis supports two types of communication protocol.

1. Rest - REST is an approach that leverages the HTTP protocol for communication.
2. Highway - This is a high performance communication protocol originally developed by Huawei.

Documentation

Index

• func Init() error
• func RegisterSchema(serverName string, structPtr interface{}, opts ...server.RegisterOption)
• func Run()
• 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()

Run bring up the service,it will not return error,instead just waiting for os signal,and shutdown gracefully

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