kratos

README

Translate to: 简体中文

About Kratos

The name is inspired by the Greek-mythology-based game "God of War". It tells the adventures of Kratos becoming a god of war from a mortal and launching a god-killing slaughter.

Kratos is a microservice-oriented governance framework implemented by golang, which offers convenient capabilities to help you quickly build a bulletproof application from scratch, such as:

• The communication protocol is based on the HTTP/gRPC through the definition of Protobuf.
• Abstract transport layer support: HTTP / gRPC.
• Powerful middleware design, support: Tracing (OpenTelemetry), Metrics (Prometheus is default), Recovery and more.
• Registry interface able to be connected with various other centralized registries through plug-ins.
• The standard log interfaces ease the integration of the third-party log libs with logs collected through the Fluentd.
• Automatically support the selection of the content encoding with Accept and Content-Type.
• Multiple data sources are supported for configurations and dynamic configurations (use atomic operations).
• In the protocol of HTTP/gRPC, use the uniform metadata transfer method.
• You can define errors in protos and generate enums with protoc-gen-go.
• You can define verification rules in Protobuf supported by the HTTP/gRPC service.
• Swagger API is generated Automatically and embed Swagger UI endpoint can be started by adding Swagger plugin.

Kratos is accessible, powerful, and provides tools required for large, robust applications.

Learning Kratos

Kratos has the most extensive and thorough documentation and example library of all modern web application frameworks, making it a breeze to get started with the framework.

We also provide a modern template. This template should help reduce the work required to setup up modern projects.

Goals

Kratos boosts your productivity. With the integration of excellent resources and further support, programmers can get rid of most issues might encounter in the field of distributed systems and software engineering such that they are allowed to focus on the release of businesses only. Additionally, for each programmer, Kratos is also an ideal one learning warehouse for many aspects of microservices to enrich their experiences and skills.

Principles

• Simple: Appropriate design with plain and easy code.
• General: Cover the various utilities for business development.
• Highly efficient: Speeding up the efficiency of businesses upgrading.
• Stable: The base libs validated in the production environment have the characteristics of high testability, high coverage as well as high security and reliability.
• Robust: Eliminating misusing through high quality of the base libs.
• High-performance: Optimal performance excluding the optimization of hacking in case of unsafe. 
• Expandability: Properly designed interfaces where you can expand utilities such as base libs to meet your further requirements.
• Fault-tolerance: Designed against failure, enhance the understanding and exercising of SRE within Kratos to achieve more robustness.
• Toolchain: Includes an extensive toolchain, such as the code generation of cache, the lint tool, and so forth.

Getting Started

Create a kratos playground through docker:

docker run -it --rm -p 8000:8000 --workdir /workspace golang

apt-get update && apt-get -y install protobuf-compiler
export GOPROXY=https://goproxy.io,direct
go install github.com/go-kratos/kratos/cmd/kratos/v2@latest && kratos upgrade

kratos new helloworld
cd helloworld/ && go mod tidy
kratos run

Use a browser to open and visit: http://localhost:8000/helloworld/kratos, The kratos program is running!

If you need more, please visit the kratos documentation.

Security Vulnerabilities

If you discover a security vulnerability within Kratos, please send an e-mail to tonybase via go-kratos@googlegroups.com. All security vulnerabilities will be promptly addressed.

Community

• Wechat Group
• Discord Group
• go-kratos.dev

Contributors

Thank you for considering contributing to the Kratos framework! The contribution guide can be found in the Kratos documentation.

License

The Kratos framework is open-sourced software licensed under the MIT license.

Acknowledgments

The following project had particular influence on kratos's design.

• go-kit/kit is a programming toolkit for building microservices in go.
• asim/go-micro a distributed systems development framework.
• google/go-cloud is go cloud development kit.
• zeromicro/go-zero is a web and rpc framework with lots of builtin engineering practices.
• beego/beego is a web framework including RESTful APIs, web apps and backend services.

Documentation

Index

• Constants
• func NewContext(ctx context.Context, s AppInfo) context.Context
• type App
  • func New(opts ...Option) *App
  • func (a *App) Endpoint() []string
  • func (a *App) ID() string
  • func (a *App) Metadata() map[string]string
  • func (a *App) Name() string
  • func (a *App) Run() error
  • func (a *App) Stop() (err error)
  • func (a *App) Version() string
• type AppInfo
  • func FromContext(ctx context.Context) (s AppInfo, ok bool)
• type Option
  • func AfterStart(fn func(context.Context) error) Option
  • func AfterStop(fn func(context.Context) error) Option
  • func BeforeStart(fn func(context.Context) error) Option
  • func BeforeStop(fn func(context.Context) error) Option
  • func Context(ctx context.Context) Option
  • func Endpoint(endpoints ...*url.URL) Option
  • func ID(id string) Option
  • func Logger(logger log.Logger) Option
  • func Metadata(md map[string]string) Option
  • func Name(name string) Option
  • func Registrar(r registry.Registrar) Option
  • func RegistrarTimeout(t time.Duration) Option
  • func Server(srv ...transport.Server) Option
  • func Signal(sigs ...os.Signal) Option
  • func StopTimeout(t time.Duration) Option
  • func Version(version string) Option

Constants

const Release = "v2.8.0"

Release is the current kratos version.

Functions

func NewContext

func NewContext(ctx context.Context, s AppInfo) context.Context

NewContext returns a new Context that carries value.

Types

type App

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

App is an application components lifecycle manager.

func New

func New(opts ...Option) *App

New create an application lifecycle manager.

func (*App) Endpoint

func (a *App) Endpoint() []string

Endpoint returns endpoints.

func (*App) ID

func (a *App) ID() string

ID returns app instance id.

func (*App) Metadata

func (a *App) Metadata() map[string]string

Metadata returns service metadata.

func (*App) Name

func (a *App) Name() string

Name returns service name.

func (*App) Run

func (a *App) Run() error

Run executes all OnStart hooks registered with the application's Lifecycle.

func (*App) Stop

func (a *App) Stop() (err error)

Stop gracefully stops the application.

func (*App) Version

func (a *App) Version() string

Version returns app version.

type AppInfo

type AppInfo interface {
	ID() string
	Name() string
	Version() string
	Metadata() map[string]string
	Endpoint() []string
}

AppInfo is application context value.

func FromContext

func FromContext(ctx context.Context) (s AppInfo, ok bool)

FromContext returns the Transport value stored in ctx, if any.

type Option

type Option func(o *options)

Option is an application option.

func AfterStart

func AfterStart(fn func(context.Context) error) Option

AfterStart run funcs after app starts

func AfterStop

func AfterStop(fn func(context.Context) error) Option

AfterStop run funcs after app stops

func BeforeStart

func BeforeStart(fn func(context.Context) error) Option

BeforeStart run funcs before app starts

func BeforeStop

func BeforeStop(fn func(context.Context) error) Option

BeforeStop run funcs before app stops

func Context

func Context(ctx context.Context) Option

Context with service context.

func Endpoint

func Endpoint(endpoints ...*url.URL) Option

Endpoint with service endpoint.

func ID

func ID(id string) Option

ID with service id.

func Logger

func Logger(logger log.Logger) Option

Logger with service logger.

func Metadata

func Metadata(md map[string]string) Option

Metadata with service metadata.

func Name

func Name(name string) Option

Name with service name.

func Registrar

func Registrar(r registry.Registrar) Option

Registrar with service registry.

func RegistrarTimeout

func RegistrarTimeout(t time.Duration) Option

RegistrarTimeout with registrar timeout.

func Server

func Server(srv ...transport.Server) Option

Server with transport servers.

func Signal

func Signal(sigs ...os.Signal) Option

Signal with exit signals.

func StopTimeout

func StopTimeout(t time.Duration) Option

StopTimeout with app stop timeout.

func Version

func Version(version string) Option

Version with service version.