README
¶
Translate to: 简体中文
Install Kratosgo install github.com/SeeMusic/kratos/cmd/kratos/v2@latest
The name is inspired by the game God of War which is based on Greek myths, tells the Kratos from mortals to become a God of War and launches the adventure of killing god.
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 are 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 and logs are collected through the Fluentd.
- The selection of the content encoding is automatically supported by Accept and Content-Type.
- Multiple data sources are supported for configurations and dynamic configurations (use atomic operations).
- In the protocol of HTTP/gRPC, use uniform metadata transfer method.
- You can define errors in protos and generate enums with protoc-gen-go.
- You can define verification rules in Protobuf which is supported by HTTP/gRPC service.
- Swagger API 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 a modern project.
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, 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 which have the characters of the 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, 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/SeeMusic/kratos/cmd/kratos/v2@latest && kratos upgrade
kratos new helloworld
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- Wechat Group
- Discord Group
- go-kratos.dev
- QQ Group: 716486124
Thank 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.
- tal-tech/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
- type AppInfo
- type 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.2.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
}
AppInfo is application context value.
type Option ¶
type Option func(o *options)
Option is an application option.
func RegistrarTimeout ¶
RegistrarTimeout with registrar timeout.
Source Files
Directories