ego

README

EGO

English | 简体中文

1 Docs

The offical docs for developers.

View https://ego.gocn.vip

2 Introduction

EGO is a microservice-oriented governance framework implemented by golang, which integrates various engineering practices. Through the component-based design pattern, it is guaranteed that the business development can use various components in a unified way.

Advantages of EGO:

• Configure drive components
• Shield the startup details of the underlying components
• Observation and governance of microservice components
• Pluggable Ego-Component
• Fail Fast principle and friendly error prompts

2.1 Improve component proficiency

For us engineers to improve component proficiency, we must first read a lot of open source component documentation and code, and then insist on using it for a long time in order to form muscle memory and improve our speed of doing business. And the time and energy invested in all of this is enormous.

To reduce this input cost and allow more developers to better use excellent open source components, EGO's approach is to standardize all open source components, encapsulate them, and unify various behaviors.

• Unified component file name
• Unified component configuration parameters
• Unified component call API
• Unify component error behavior
• Unified component monitoring behavior

Once you have mastered one component, you can use other components by inference.

2.2 Improve the efficiency of troubleshooting

• Unified error code
• Component errors, slow responses, links, regular request interceptor points (both server and client will intercept)
• Convergence error field
• Inject key information into components: code line number, configuration name, target address, time-consuming, request data, response data
• Debugging stage, error highlighting, formatting friendly prompts
• In the debugging phase, the component has a built-in debug interceptor

2.3 Automatically generate duplicate code(EGO CLI)

• Generate code, configuration, data parsing, template separation
• Build project code independently of language
• Use the Go1.16 feature embed, start the webUI, and generate code
• Project: https://github.com/gotomicro/egoctl

3 Definition

3.1 Framework Layer

EGO framework has three layers:

• The core layer provides configuration, logging, monitoring and links, and is the cornerstone of other components.
• The component layer provides various components in the client, server and task.
• The glue layer controls the life cycle of various components, error handling.

3.2 Architecture

3.3 Life cycle

3.4 Component Layer

We consider everything to be a component and divide the component into four parts:

• Container handles component type, configuration and component startup
• Config configure parameters
• Component The calling method of the component
• Options the options of configuration and component

4 功能

Component Name	Code	Example	Doc
HTTP Server	Code	Example	Doc
gRPC Server	Code	Example	Doc
Governance Service	Code	Example	Doc
Job	Code	Example	Doc
Corn job	Code	Example	Doc
Distributed scheduled Job			Doc
HTTP Client	Code	Example	Doc
gRPC Client	Code	Example	Doc
gRPC Client using ETCD		Example	Doc
gRPC Client using k8s		Example	Doc
Sentinel	Code	Example	Doc
MySQL	Code	Example	Doc
Redis	Code	Example	Doc
Redis Distributed lock	Code
Mongo	Code		Doc
Kafka	Code		Doc
ETCD	Code
K8S	Code		Doc
Oauth2	Code
Wechat	Code
Dingtalk	Code
Jira	Code

• For more components please visit the website: https://github.com/gotomicro/ego-component

5 Version Requirements

• Below v0.8.2, Go version needs to be greater than Go1.13.
• After v0.8.3, Go version needs to be greater than Go1.16.

6 Download Tool

bash <(curl -L https://raw.githubusercontent.com/gotomicro/egoctl/main/getlatest.sh)

Through the above script, you can download the protoc tools, EGO protoc plugin and egoctl.

• /usr/local/bin/egoctl EGO Cli
• /usr/local/bin/protoc Generate Pb tool
• /usr/local/bin/protoc-gen-go Generate Pb tool
• /usr/local/bin/protoc-gen-go-grpc Generate gRPC tool
• /usr/local/bin/protoc-gen-go-errors Generate error code tool
• /usr/local/bin/protoc-gen-openapiv2 Generate HTTP tool
• /usr/local/bin/protoc-gen-go-http Generate HTTP tool

7 Features

• Configuration driver The startup method of all components is component name.Load("configuration name").Build(), which can create a component instance. For example, http server below, egin is the component name, server.http is the configuration name

  egin.Load("server.http").Build()
  

• friendly debug By enabling the debug configuration and export EGO_DEBUG=true on the command line,

  We can see the line number, configuration name, request address, time-consuming, request data, and response data in the request of all components in the test environment

And using Goland, you can directly click to the corresponding code path through the line number (gRPC, HTTP client support line number)

• Tracing Use the opentrace protocol to automatically add Tracing to the log

  • gRPC Tracing

    • test code gRPC view Tracing id
    • Server Tracing information

    

    • Client Tracing information

    

  • HTTP Tracing

    

• Unified error message

• Unified monitoring information

  

8 Quick Start

8.1 HelloWorld

Configuration

[server.http]
    port = 9001
    host = "0.0.0.0"

Code

package main
import (
   "github.com/gin-gonic/gin"
   "github.com/gotomicro/ego"
   "github.com/gotomicro/ego/core/elog"
   "github.com/gotomicro/ego/server"
   "github.com/gotomicro/ego/server/egin"
)
//  export EGO_DEBUG=true && go run main.go --config=config.toml
func main() {
   if err := ego.New().Serve(func() *egin.Component {
      server := egin.Load("server.http").Build()
      server.GET("/hello", func(ctx *gin.Context) {
         ctx.JSON(200, "Hello EGO")
         return
      })
      return server
   }()).Run(); err != nil {
      elog.Panic("startup", elog.FieldErr(err))
   }
}

8.2 Using the command line to run

export EGO_DEBUG=true # The default log is output to the logs directory, and after dev mode is enabled, the log is output to the terminal
go run main.go --config=config.toml

8.3 Result

At this time, we can send a command and get the following result

➜  helloworld git:(master) ✗ curl http://127.0.0.1:9001/hello
"Hello Ego"%  

8.4 More friendly package compilation

Use build in the scripts folder, you can see the elegant version prompt.

9 Changelog

Releases

10 Join us

To join our Wechat comminication group, add the ego keyword in the verification information.

Contributors

Thanks for these wonderful people:

askuy	Wei Zheng	shaoyuan	Panda	刘文哲	zhangjunjun	devincd
Ming Deng	Angelia	Wbofeng	clannadxr	Link Duan	Costa	MEX7
LincolnZhou	optimistic9527

Documentation

Index

• type Ego
  • func New(options ...Option) *Ego
  • func (e *Ego) Cron(w ...ecron.Ecron) *Ego
  • func (e *Ego) Invoker(fns ...func() error) *Ego
  • func (e *Ego) Job(runners ...ejob.Ejob) *Ego
  • func (e *Ego) Registry(reg eregistry.Registry) *Ego
  • func (e *Ego) Run() error
  • func (e *Ego) Serve(s ...server.Server) *Ego
  • func (e *Ego) Stop(ctx context.Context, isGraceful bool) (err error)
• type Option
  • func WithAfterStopClean(fns ...func() error) Option
  • func WithBeforeStopClean(fns ...func() error) Option
  • func WithConfigPrefix(configPrefix string) Option
  • func WithDisableBanner(disableBanner bool) Option
  • func WithDisableFlagConfig(disableFlagConfig bool) Option
  • func WithHang(flag bool) Option
  • func WithShutdownSignal(signals ...os.Signal) Option
  • func WithStopTimeout(timeout time.Duration) Option

Types

type Ego

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

Ego 分为三大部分 第一部分 系统数据：生命周期，配置前缀，锁，日志，错误 第二部分 运行程序：系统初始化函数，用户初始化函数，服务，定时任务，短时任务 第三部分 可选方法：是否悬挂，注册中心，运行停止前清理，运行停止后清理

func New

func New(options ...Option) *Ego

New new Ego

func (*Ego) Cron

func (e *Ego) Cron(w ...ecron.Ecron) *Ego

Cron 设置定时任务

func (*Ego) Invoker

func (e *Ego) Invoker(fns ...func() error) *Ego

Invoker 传入所需要的函数

func (*Ego) Job

func (e *Ego) Job(runners ...ejob.Ejob) *Ego

Job 设置短时任务

func (*Ego) Registry

func (e *Ego) Registry(reg eregistry.Registry) *Ego

Registry 设置注册中心

func (*Ego) Run

func (e *Ego) Run() error

Run 运行程序

func (*Ego) Serve

func (e *Ego) Serve(s ...server.Server) *Ego

Serve 设置服务

func (*Ego) Stop

func (e *Ego) Stop(ctx context.Context, isGraceful bool) (err error)

Stop 停止程序

type Option

type Option func(a *Ego)

Option 可选项

func WithAfterStopClean

func WithAfterStopClean(fns ...func() error) Option

WithAfterStopClean 设置运行后清理

func WithBeforeStopClean

func WithBeforeStopClean(fns ...func() error) Option

WithBeforeStopClean 设置运行前清理

func WithConfigPrefix

func WithConfigPrefix(configPrefix string) Option

WithConfigPrefix 设置配置前缀

func WithDisableBanner

func WithDisableBanner(disableBanner bool) Option

WithDisableBanner 禁止banner

func WithDisableFlagConfig

func WithDisableFlagConfig(disableFlagConfig bool) Option

WithDisableFlagConfig 禁止config

func WithHang

func WithHang(flag bool) Option

WithHang 是否允许系统悬挂起来，0 表示不悬挂， 1 表示悬挂。目的是一些脚本操作的时候，不想主线程停止

func WithShutdownSignal

func WithShutdownSignal(signals ...os.Signal) Option

WithShutdownSignal 设置停止信号量

func WithStopTimeout

func WithStopTimeout(timeout time.Duration) Option

WithStopTimeout 设置停止的超时时间