generated from cloudwego/.github
-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs:add README.md #3
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
82f0b39
docs:update README.md
ViolaPioggia b73cb9b
Merge branch 'kitex-contrib:main' into config-etcd
ViolaPioggia 7907835
docs:update README_CN.md
ViolaPioggia 109f7c6
docs:adjust README.md
ViolaPioggia 4f82dfd
docs:update configPath
ViolaPioggia b878d31
docs:update configPath
ViolaPioggia 730a0b7
chore:add etcd license
ViolaPioggia a43b472
chore:move licenses dir
ViolaPioggia File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,281 @@ | ||
| # .github | ||
| # config-etcd (*This is a community driven project*) | ||
|
|
||
| [中文](./README_CN.md) | ||
|
|
||
| etcd as config center for service governance. | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Basic | ||
|
|
||
| #### Server | ||
|
|
||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "log" | ||
|
|
||
| "github.com/cloudwego/kitex-examples/kitex_gen/api" | ||
| "github.com/cloudwego/kitex-examples/kitex_gen/api/echo" | ||
| "github.com/cloudwego/kitex/pkg/klog" | ||
| "github.com/cloudwego/kitex/pkg/rpcinfo" | ||
| "github.com/cloudwego/kitex/server" | ||
| "github.com/kitex-contrib/config-etcd/etcd" | ||
| etcdServer "github.com/kitex-contrib/config-etcd/server" | ||
| ) | ||
|
|
||
| var _ api.Echo = &EchoImpl{} | ||
|
|
||
| // EchoImpl implements the last service interface defined in the IDL. | ||
| type EchoImpl struct{} | ||
|
|
||
| // Echo implements the Echo interface. | ||
| func (s *EchoImpl) Echo(ctx context.Context, req *api.Request) (resp *api.Response, err error) { | ||
| klog.Info("echo called") | ||
| return &api.Response{Message: req.Message}, nil | ||
| } | ||
|
|
||
| func main() { | ||
| klog.SetLevel(klog.LevelDebug) | ||
| serviceName := "ServiceName" | ||
| etcdClient, err := etcd.NewClient(etcd.Options{}) | ||
| if err!=nil { | ||
| panic(err) | ||
| } | ||
| svr := echo.NewServer( | ||
| new(EchoImpl), | ||
| server.WithServerBasicInfo(&rpcinfo.EndpointBasicInfo{ServiceName: serviceName}), | ||
| server.WithSuite(etcdServer.NewSuite(serviceName, etcdClient)), | ||
| ) | ||
| if err := svr.Run(); err != nil { | ||
| log.Println("server stopped with error:", err) | ||
| } else { | ||
| log.Println("server stopped") | ||
| } | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| #### Client | ||
|
|
||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "log" | ||
| "time" | ||
|
|
||
| "github.com/cloudwego/kitex-examples/kitex_gen/api" | ||
| "github.com/cloudwego/kitex-examples/kitex_gen/api/echo" | ||
| "github.com/cloudwego/kitex/client" | ||
| "github.com/cloudwego/kitex/pkg/klog" | ||
| etcdclient "github.com/kitex-contrib/config-etcd/client" | ||
| "github.com/kitex-contrib/config-etcd/etcd" | ||
| "github.com/kitex-contrib/config-etcd/utils" | ||
| ) | ||
|
|
||
| type configLog struct{} | ||
|
|
||
| func (cl *configLog) Apply(opt *utils.Options) { | ||
| fn := func(k *etcd.Key) { | ||
| klog.Infof("etcd config %v", k) | ||
| } | ||
| opt.EtcdCustomFunctions = append(opt.EtcdCustomFunctions, fn) | ||
| } | ||
|
|
||
| func main() { | ||
| klog.SetLevel(klog.LevelDebug) | ||
|
|
||
| etcdClient, err := etcd.NewClient(etcd.Options{}) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| cl := &configLog{} | ||
|
|
||
| serviceName := "ServiceName" | ||
| clientName := "ClientName" | ||
| client, err := echo.NewClient( | ||
| serviceName, | ||
| client.WithHostPorts("0.0.0.0:8888"), | ||
| client.WithSuite(etcdclient.NewSuite(serviceName, clientName, etcdClient, cl)), | ||
| ) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| for { | ||
| req := &api.Request{Message: "my request"} | ||
| resp, err := client.Echo(context.Background(), req) | ||
| if err != nil { | ||
| klog.Errorf("take request error: %v", err) | ||
| } else { | ||
| klog.Infof("receive response %v", resp) | ||
| } | ||
| time.Sleep(time.Second * 10) | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Etcd Configuration | ||
|
|
||
| #### CustomFunction | ||
|
|
||
| Provide the mechanism to custom the etcd parameter `Key`. | ||
| ```go | ||
| type Key struct { | ||
| Prefix string | ||
| Path string | ||
| } | ||
| ``` | ||
|
|
||
| #### Options Variable | ||
|
|
||
| | Variable Name | Default Value | Introduction | | ||
| |------------------|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | Address | 127.0.0.1 | Etcd server address | | ||
| | Port | 2379 | Etcd server port | | ||
| | Prefix | /KitexConfig | The prefix of Etcd | | ||
| | ClientPathFormat | {{.ClientServiceName}}/{{.ServerServiceName}}/{{.Category}} | Use go [template](https://pkg.go.dev/text/template) syntax rendering to generate the appropriate ID, and use `ClientServiceName` `ServiceName` `Category` three metadata that can be customised | | ||
| | ServerPathFormat | {{.ServerServiceName}}/{{.Category}} | Use go [template](https://pkg.go.dev/text/template) syntax rendering to generate the appropriate ID, and use `ServiceName` `Category` two metadatas that can be customised | | ||
|
|
||
| #### Governance Policy | ||
| > The configPath and configPrefix in the following example use default values, the service name is `ServiceName` and the client name is `ClientName`. | ||
|
|
||
| ##### Rate Limit Category=limit | ||
| > Currently, current limiting only supports the server side, so ClientServiceName is empty. | ||
|
|
||
| [JSON Schema](https://github.com/cloudwego/kitex/blob/develop/pkg/limiter/item_limiter.go#L33) | ||
|
|
||
| | Variable | Introduction | | ||
| |------------------|------------------------------------| | ||
| | connection_limit | Maximum concurrent connections | | ||
| | qps_limit | Maximum request number every 100ms | | ||
|
|
||
| Example: | ||
|
|
||
| > configPath: /KitexConfig/ServiceName/limit | ||
|
|
||
| ```json | ||
| { | ||
| "connection_limit": 100, | ||
| "qps_limit": 2000 | ||
| } | ||
| ``` | ||
|
|
||
| Note: | ||
|
|
||
| - The granularity of the current limit configuration is server global, regardless of client or method. | ||
| - Not configured or value is 0 means not enabled. | ||
| - connection_limit and qps_limit can be configured independently, e.g. connection_limit = 100, qps_limit = 0 | ||
|
|
||
| ##### Retry Policy Category=retry | ||
| [JSON Schema](https://github.com/cloudwego/kitex/blob/develop/pkg/retry/policy.go#L63) | ||
|
|
||
| | Variable | Introduction | | ||
| |-------------------------------|------------------------------------------------| | ||
| | type | 0: failure_policy 1: backup_policy | | ||
| | failure_policy.backoff_policy | Can only be set one of `fixed` `none` `random` | | ||
|
|
||
| Example： | ||
|
|
||
| > configPath: /KitexConfig/ClientName/ServiceName/retry | ||
|
|
||
| ```json | ||
| { | ||
| "*": { | ||
| "enable": true, | ||
| "type": 0, | ||
| "failure_policy": { | ||
| "stop_policy": { | ||
| "max_retry_times": 3, | ||
| "max_duration_ms": 2000, | ||
| "cb_policy": { | ||
| "error_rate": 0.3 | ||
| } | ||
| }, | ||
| "backoff_policy": { | ||
| "backoff_type": "fixed", | ||
| "cfg_items": { | ||
| "fix_ms": 50 | ||
| } | ||
| }, | ||
| "retry_same_node": false | ||
| } | ||
| }, | ||
| "echo": { | ||
| "enable": true, | ||
| "type": 1, | ||
| "backup_policy": { | ||
| "retry_delay_ms": 100, | ||
| "retry_same_node": false, | ||
| "stop_policy": { | ||
| "max_retry_times": 2, | ||
| "max_duration_ms": 300, | ||
| "cb_policy": { | ||
| "error_rate": 0.2 | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| Note: retry.Container has built-in support for specifying the default configuration using the `*` wildcard (see the [getRetryer](https://github.com/cloudwego/kitex/blob/v0.5.1/pkg/retry/retryer.go#L240) method for details). | ||
|
|
||
| ##### RPC Timeout Category=rpc_timeout | ||
|
|
||
| [JSON Schema](https://github.com/cloudwego/kitex/blob/develop/pkg/rpctimeout/item_rpc_timeout.go#L42) | ||
|
|
||
| Example： | ||
|
|
||
| > configPath: /KitexConfig/ClientName/ServiceName/rpc_timeout | ||
|
|
||
| ```json | ||
| { | ||
| "*": { | ||
| "conn_timeout_ms": 100, | ||
| "rpc_timeout_ms": 3000 | ||
| }, | ||
| "echo": { | ||
| "conn_timeout_ms": 50, | ||
| "rpc_timeout_ms": 1000 | ||
| } | ||
| } | ||
| ``` | ||
| Note: The circuit breaker implementation of kitex does not currently support changing the global default configuration (see [initServiceCB](https://github.com/cloudwego/kitex/blob/v0.5.1/pkg/circuitbreak/cbsuite.go#L195) for details). | ||
|
|
||
| ##### Circuit Break: Category=circuit_break | ||
|
|
||
| [JSON Schema](https://github.com/cloudwego/kitex/blob/develop/pkg/circuitbreak/item_circuit_breaker.go#L30) | ||
|
|
||
| | Variable | Introduction | | ||
| |------------|-----------------------------------| | ||
| | min_sample | Minimum statistical sample number | | ||
|
|
||
| Example： | ||
|
|
||
| The echo method uses the following configuration (0.3, 100) and other methods use the global default configuration (0.5, 200) | ||
|
|
||
| > configPath: /KitexConfig/ClientName/ServiceName/circuit_break | ||
|
|
||
| ```json | ||
| { | ||
| "echo": { | ||
| "enable": true, | ||
| "err_rate": 0.3, | ||
| "min_sample": 100 | ||
| } | ||
| } | ||
| ``` | ||
| ### More Info | ||
|
|
||
| Refer to [example](https://github.com/kitex-contrib/config-etcd/tree/main/example) for more usage. | ||
|
|
||
| ## Compatibility | ||
|
|
||
| For grpc compatibility, the version of Go must >=1.19 | ||
|
|
||
| maintained by: [ViolaPioggia](https://github.com/violapioggia) | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
参考 https://github.com/hertz-contrib/registry/tree/main/licenses 补充一下直接依赖的 license
config-nacos 辛苦有时间也补充一下 @whalecold
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done