README
¶
Translate to: 简体中文
About KratosThe 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 KratosKratos 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.
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 VulnerabilitiesIf 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 ContributorsThank you for considering contributing to the Kratos framework! The contribution guide can be found in the Kratos documentation.
The Kratos framework is open-sourced software licensed under the MIT license.
AcknowledgmentsThe 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 NewContextFromApp(ctx context.Context, s AppInfo) context.Context
- type App
- type AppInfo
- type Context
- type LogField
- 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 Config(source config.Source) Option
- func Endpoint(endpoints ...*url.URL) Option
- func ID(id string) Option
- func LoggerWith(fields LogField) Option
- func Metadata(md map[string]string) Option
- func Name(name string) Option
- func Registrar(r registry.Registrar) Option
- func RegistrarServer(fn registrarServerFn) 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.7.0"
Release is the current kratos version.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type App ¶
type App struct {
// contains filtered or unexported fields
}
App is an application components lifecycle manager.
type AppInfo ¶
type AppInfo interface {
ID() string
Name() string
Version() string
Metadata() map[string]string
Endpoint() []string
Config() config.Config
}
AppInfo is application context value.
type Context ¶
type Context interface {
Logger() *log.Helper
DB(name ...string) *gorm.DB
Go(runner pool.Runner) error
Cert(name string) []byte
Email() (email.Sender, error)
ClientIP() string
Captcha() captcha.Captcha
JWT() jwt.Jwt
Authentication() authentication.Authentication
ID() string
Name() string
Version() string
Metadata() map[string]string
Config() config.Config
Endpoint() []string
Deadline() (deadline time.Time, ok bool)
Done() <-chan struct{}
Err() error
Value(key any) interface{}
}
func MustContext ¶
MustContext returns the Transport value stored in ctx, if any.
type Option ¶
type Option func(o *options)
Option is an application option.
func AfterStart ¶
AfterStart run funcs after app starts
func BeforeStart ¶
BeforeStart run funcs before app starts
func BeforeStop ¶
BeforeStop run funcs before app stops
func LoggerWith ¶
LoggerWith with service logger with field.
func RegistrarServer ¶
func RegistrarServer(fn registrarServerFn) Option
RegistrarServer with service register server.
func RegistrarTimeout ¶
RegistrarTimeout with registrar timeout.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
cmd
|
|
|
kratos
Module
|
|
|
protoc-gen-go-errors
Module
|
|
|
protoc-gen-go-http
Module
|
|
|
contrib
|
|
|
registry/kubernetes
Package kuberegistry registry simply implements the Kubernetes-based Registry
|
Package kuberegistry registry simply implements the Kubernetes-based Registry |
|
proto
Package proto defines the protobuf codec.
|
Package proto defines the protobuf codec. |
|
nolint:gomnd
|
nolint:gomnd |
|
extra
|
|
|
internal
|
|
|
group
Package group provides a sample lazy load container.
|
Package group provides a sample lazy load container. |