add notes for grpc

Signed-off-by: Liang Zheng <[email protected]>

Author: microyahoo

client/v3/internal/resolver/resolver.go

@@ -27,6 +27,7 @@ const (
 
 // EtcdManualResolver is a Resolver (and resolver.Builder) that can be updated
 // using SetEndpoints.
+// TODO(zhengliang): 不明白
 type EtcdManualResolver struct {
 	*manual.Resolver
 	endpoints     []string

client/v3/maintenance.go

@@ -208,6 +208,7 @@ func (m *maintenance) Defragment(ctx context.Context, endpoint string) (*Defragm
 }
 
 func (m *maintenance) Status(ctx context.Context, endpoint string) (*StatusResponse, error) {
+	m.lg.Info("*** maintenance endpoint", zap.String("endpoint", endpoint))
 	remote, cancel, err := m.dial(endpoint)
 	if err != nil {
 		return nil, toErr(ctx, err)

etcdctl/ctlv3/command/global.go

@@ -26,7 +26,7 @@ import (
 	"github.com/bgentry/speakeasy"
 	"go.etcd.io/etcd/client/pkg/v3/srv"
 	"go.etcd.io/etcd/client/pkg/v3/transport"
-	"go.etcd.io/etcd/client/v3"
+	clientv3 "go.etcd.io/etcd/client/v3"
 	"go.etcd.io/etcd/pkg/v3/cobrautl"
 	"go.etcd.io/etcd/pkg/v3/flags"
 
@@ -112,6 +112,7 @@ func (*discardValue) String() string   { return "" }
 func (*discardValue) Set(string) error { return nil }
 func (*discardValue) Type() string     { return "" }
 
+// 根据 cobra.Command 初始化 client config
 func clientConfigFromCmd(cmd *cobra.Command) *clientConfig {
 	lg, err := zap.NewProduction()
 	if err != nil {

server/embed/etcd.go

@@ -126,15 +126,15 @@ func StartEtcd(inCfg *Config) (e *Etcd, err error) {
 		"configuring peer listeners",
 		zap.Strings("listen-peer-urls", e.cfg.getLPURLs()),
 	)
-	if e.Peers, err = configurePeerListeners(cfg); err != nil {
+	if e.Peers, err = configurePeerListeners(cfg); err != nil { // peers
 		return e, err
 	}
 
 	e.cfg.logger.Info(
 		"configuring client listeners",
 		zap.Strings("listen-client-urls", e.cfg.getLCURLs()),
 	)
-	if e.sctxs, err = configureClientListeners(cfg); err != nil {
+	if e.sctxs, err = configureClientListeners(cfg); err != nil { //clients
 		return e, err
 	}
 
@@ -470,6 +470,7 @@ func (e *Etcd) Err() <-chan error {
 	return e.errc
 }
 
+// 配置 peer listeners
 func configurePeerListeners(cfg *Config) (peers []*peerListener, err error) {
 	if err = updateCipherSuites(&cfg.PeerTLSInfo, cfg.CipherSuites); err != nil {
 		return nil, err
@@ -531,6 +532,7 @@ func configurePeerListeners(cfg *Config) (peers []*peerListener, err error) {
 }
 
 // configure peer handlers after rafthttp.Transport started
+// 服务 peers
 func (e *Etcd) servePeers() (err error) {
 	ph := etcdhttp.NewPeerHandler(e.GetLogger(), e.Server)
 	var peerTLScfg *tls.Config
@@ -590,6 +592,7 @@ func (e *Etcd) servePeers() (err error) {
 	return nil
 }
 
+// 配置 client listeners
 func configureClientListeners(cfg *Config) (sctxs map[string]*serveCtx, err error) {
 	if err = updateCipherSuites(&cfg.ClientTLSInfo, cfg.CipherSuites); err != nil {
 		return nil, err
@@ -632,6 +635,7 @@ func configureClientListeners(cfg *Config) (sctxs map[string]*serveCtx, err erro
 			continue
 		}
 
+		// 启动 listener
 		if sctx.l, err = transport.NewListenerWithOpts(addr, u.Scheme,
 			transport.WithSocketOpts(&cfg.SocketOpts),
 			transport.WithSkipTLSInfoCheck(true),
@@ -675,13 +679,17 @@ func configureClientListeners(cfg *Config) (sctxs map[string]*serveCtx, err erro
 		}
 		sctx.serviceRegister = cfg.ServiceRegister
 		if cfg.EnablePprof || cfg.LogLevel == "debug" {
+			// enable pprof or debug mode
 			sctx.registerPprof()
 		}
 		if cfg.LogLevel == "debug" {
 			sctx.registerTrace()
 		}
 		sctxs[addr] = sctx
 	}
+	for _, sctx := range sctxs {
+		cfg.logger.Info("****LCUrls", zap.String("lcurls sctxs", fmt.Sprintf("%#v", sctx)))
+	}
 	return sctxs, nil
 }
 
@@ -709,6 +717,7 @@ func (e *Etcd) serveClients() (err error) {
 			h = v2http.NewClientHandler(e.GetLogger(), e.Server, e.Server.Cfg.ReqTimeout())
 		}
 	} else {
+		// v3 请求
 		mux := http.NewServeMux()
 		etcdhttp.HandleBasic(e.cfg.logger, mux, e.Server)
 		etcdhttp.HandleMetricsHealthForV3(e.cfg.logger, mux, e.Server)

server/embed/serve.go

@@ -100,9 +100,9 @@ func (sctx *serveCtx) serve(
 	sctx.lg.Info("ready to serve client requests")
 
 	m := cmux.New(sctx.l)
-	v3c := v3client.New(s)
-	servElection := v3election.NewElectionServer(v3c)
-	servLock := v3lock.NewLockServer(v3c)
+	v3c := v3client.New(s)                            // 创建 client
+	servElection := v3election.NewElectionServer(v3c) // election
+	servLock := v3lock.NewLockServer(v3c)             // lock
 
 	var gs *grpc.Server
 	defer func() {
@@ -112,7 +112,7 @@ func (sctx *serveCtx) serve(
 	}()
 
 	if sctx.insecure {
-		gs = v3rpc.Server(s, nil, nil, gopts...)
+		gs = v3rpc.Server(s, nil, nil, gopts...) // 创建 grpc server
 		v3electionpb.RegisterElectionServer(gs, servElection)
 		v3lockpb.RegisterLockServer(gs, servLock)
 		if sctx.serviceRegister != nil {
@@ -138,6 +138,7 @@ func (sctx *serveCtx) serve(
 		httpl := m.Match(cmux.HTTP1())
 		go func() { errHandler(srvhttp.Serve(httpl)) }()
 
+		// 同时支持 grpc server and http server
 		sctx.serversC <- &servers{grpc: gs, http: srvhttp}
 		sctx.lg.Info(
 			"serving client traffic insecurely; this is strongly discouraged!",
@@ -216,6 +217,7 @@ func grpcHandlerFunc(grpcServer *grpc.Server, otherHandler http.Handler) http.Ha
 
 type registerHandlerFunc func(context.Context, *gw.ServeMux, *grpc.ClientConn) error
 
+// 注册 grpc gateway
 func (sctx *serveCtx) registerGateway(opts []grpc.DialOption) (*gw.ServeMux, error) {
 	ctx := sctx.ctx
 

server/etcdserver/api/v3rpc/grpc.go

@@ -36,6 +36,7 @@ const (
 	maxSendBytes      = math.MaxInt32
 )
 
+// grpc server
 func Server(s *etcdserver.EtcdServer, tls *tls.Config, interceptor grpc.UnaryServerInterceptor, gopts ...grpc.ServerOption) *grpc.Server {
 	var opts []grpc.ServerOption
 	opts = append(opts, grpc.CustomCodec(&codec{}))