1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/*Package praefect is a Gitaly reverse proxy for transparently routing gRPC
calls to a set of Gitaly services.*/
package praefect
import (
"time"
grpcmw "github.com/grpc-ecosystem/go-grpc-middleware"
grpcmwlogrus "github.com/grpc-ecosystem/go-grpc-middleware/logging/logrus"
grpcmwtags "github.com/grpc-ecosystem/go-grpc-middleware/tags"
grpcprometheus "github.com/grpc-ecosystem/go-grpc-prometheus"
"github.com/sirupsen/logrus"
"gitlab.com/gitlab-org/gitaly/v14/internal/backchannel"
"gitlab.com/gitlab-org/gitaly/v14/internal/gitaly/server/auth"
"gitlab.com/gitlab-org/gitaly/v14/internal/helper/fieldextractors"
"gitlab.com/gitlab-org/gitaly/v14/internal/log"
"gitlab.com/gitlab-org/gitaly/v14/internal/middleware/cancelhandler"
"gitlab.com/gitlab-org/gitaly/v14/internal/middleware/metadatahandler"
"gitlab.com/gitlab-org/gitaly/v14/internal/middleware/panichandler"
"gitlab.com/gitlab-org/gitaly/v14/internal/middleware/sentryhandler"
"gitlab.com/gitlab-org/gitaly/v14/internal/praefect/config"
"gitlab.com/gitlab-org/gitaly/v14/internal/praefect/datastore"
"gitlab.com/gitlab-org/gitaly/v14/internal/praefect/grpc-proxy/proxy"
"gitlab.com/gitlab-org/gitaly/v14/internal/praefect/middleware"
"gitlab.com/gitlab-org/gitaly/v14/internal/praefect/nodes"
"gitlab.com/gitlab-org/gitaly/v14/internal/praefect/protoregistry"
"gitlab.com/gitlab-org/gitaly/v14/internal/praefect/service"
"gitlab.com/gitlab-org/gitaly/v14/internal/praefect/service/info"
"gitlab.com/gitlab-org/gitaly/v14/internal/praefect/service/server"
"gitlab.com/gitlab-org/gitaly/v14/internal/praefect/service/transaction"
"gitlab.com/gitlab-org/gitaly/v14/internal/praefect/transactions"
"gitlab.com/gitlab-org/gitaly/v14/proto/go/gitalypb"
grpccorrelation "gitlab.com/gitlab-org/labkit/correlation/grpc"
grpctracing "gitlab.com/gitlab-org/labkit/tracing/grpc"
"google.golang.org/grpc"
"google.golang.org/grpc/health"
healthpb "google.golang.org/grpc/health/grpc_health_v1"
"google.golang.org/grpc/keepalive"
)
// NewBackchannelServerFactory returns a ServerFactory that serves the RefTransactionServer on the backchannel
// connection.
func NewBackchannelServerFactory(logger *logrus.Entry, svc gitalypb.RefTransactionServer) backchannel.ServerFactory {
return func() backchannel.Server {
srv := grpc.NewServer(
grpc.UnaryInterceptor(grpcmw.ChainUnaryServer(
commonUnaryServerInterceptors(logger)...,
)),
)
gitalypb.RegisterRefTransactionServer(srv, svc)
grpcprometheus.Register(srv)
return srv
}
}
func commonUnaryServerInterceptors(logger *logrus.Entry) []grpc.UnaryServerInterceptor {
return []grpc.UnaryServerInterceptor{
grpcmwtags.UnaryServerInterceptor(ctxtagsInterceptorOption()),
grpccorrelation.UnaryServerCorrelationInterceptor(), // Must be above the metadata handler
metadatahandler.UnaryInterceptor,
grpcprometheus.UnaryServerInterceptor,
grpcmwlogrus.UnaryServerInterceptor(logger, grpcmwlogrus.WithTimestampFormat(log.LogTimestampFormat)),
sentryhandler.UnaryLogHandler,
cancelhandler.Unary, // Should be below LogHandler
grpctracing.UnaryServerTracingInterceptor(),
// Panic handler should remain last so that application panics will be
// converted to errors and logged
panichandler.UnaryPanicHandler,
}
}
func ctxtagsInterceptorOption() grpcmwtags.Option {
return grpcmwtags.WithFieldExtractorForInitialReq(fieldextractors.FieldExtractor)
}
// NewGRPCServer returns gRPC server with registered proxy-handler and actual services praefect serves on its own.
// It includes a set of unary and stream interceptors required to add logging, authentication, etc.
func NewGRPCServer(
conf config.Config,
logger *logrus.Entry,
registry *protoregistry.Registry,
director proxy.StreamDirector,
nodeMgr nodes.Manager,
txMgr *transactions.Manager,
queue datastore.ReplicationEventQueue,
rs datastore.RepositoryStore,
assignmentStore AssignmentStore,
conns Connections,
primaryGetter PrimaryGetter,
grpcOpts ...grpc.ServerOption,
) *grpc.Server {
streamInterceptors := []grpc.StreamServerInterceptor{
grpcmwtags.StreamServerInterceptor(ctxtagsInterceptorOption()),
grpccorrelation.StreamServerCorrelationInterceptor(), // Must be above the metadata handler
middleware.MethodTypeStreamInterceptor(registry),
metadatahandler.StreamInterceptor,
grpcprometheus.StreamServerInterceptor,
grpcmwlogrus.StreamServerInterceptor(logger,
grpcmwlogrus.WithTimestampFormat(log.LogTimestampFormat)),
sentryhandler.StreamLogHandler,
cancelhandler.Stream, // Should be below LogHandler
grpctracing.StreamServerTracingInterceptor(),
auth.StreamServerInterceptor(conf.Auth),
// Panic handler should remain last so that application panics will be
// converted to errors and logged
panichandler.StreamPanicHandler,
}
if conf.Failover.ElectionStrategy == config.ElectionStrategyPerRepository {
streamInterceptors = append(streamInterceptors, RepositoryExistsStreamInterceptor(rs))
}
grpcOpts = append(grpcOpts, proxyRequiredOpts(director)...)
grpcOpts = append(grpcOpts, []grpc.ServerOption{
grpc.StreamInterceptor(grpcmw.ChainStreamServer(streamInterceptors...)),
grpc.UnaryInterceptor(grpcmw.ChainUnaryServer(
append(
commonUnaryServerInterceptors(logger),
middleware.MethodTypeUnaryInterceptor(registry),
auth.UnaryServerInterceptor(conf.Auth),
)...,
)),
grpc.KeepaliveEnforcementPolicy(keepalive.EnforcementPolicy{
MinTime: 20 * time.Second,
PermitWithoutStream: true,
}),
}...)
warnDupeAddrs(logger, conf)
srv := grpc.NewServer(grpcOpts...)
registerServices(srv, nodeMgr, txMgr, conf, queue, rs, assignmentStore, service.Connections(conns), primaryGetter)
return srv
}
func proxyRequiredOpts(director proxy.StreamDirector) []grpc.ServerOption {
return []grpc.ServerOption{
grpc.ForceServerCodec(proxy.NewCodec()),
grpc.UnknownServiceHandler(proxy.TransparentHandler(director)),
}
}
// registerServices registers services praefect needs to handle RPCs on its own.
func registerServices(
srv *grpc.Server,
nm nodes.Manager,
tm *transactions.Manager,
conf config.Config,
queue datastore.ReplicationEventQueue,
rs datastore.RepositoryStore,
assignmentStore AssignmentStore,
conns service.Connections,
primaryGetter info.PrimaryGetter,
) {
// ServerServiceServer is necessary for the ServerInfo RPC
gitalypb.RegisterServerServiceServer(srv, server.NewServer(conf, conns))
gitalypb.RegisterPraefectInfoServiceServer(srv, info.NewServer(conf, rs, assignmentStore, conns, primaryGetter))
gitalypb.RegisterRefTransactionServer(srv, transaction.NewServer(tm))
healthpb.RegisterHealthServer(srv, health.NewServer())
grpcprometheus.Register(srv)
}
func warnDupeAddrs(logger logrus.FieldLogger, conf config.Config) {
var fishy bool
for _, virtualStorage := range conf.VirtualStorages {
addrSet := map[string]struct{}{}
for _, n := range virtualStorage.Nodes {
_, ok := addrSet[n.Address]
if ok {
logger.Warnf("more than one backend node is hosted at %s", n.Address)
fishy = true
continue
}
addrSet[n.Address] = struct{}{}
}
if fishy {
logger.Warnf("your Praefect configuration may not offer actual redundancy")
}
}
}
|
