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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
package server
import (
"crypto/tls"
"fmt"
"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"
"gitlab.com/gitlab-org/gitaly/v15/internal/backchannel"
"gitlab.com/gitlab-org/gitaly/v15/internal/gitaly/client"
"gitlab.com/gitlab-org/gitaly/v15/internal/gitaly/server/auth"
"gitlab.com/gitlab-org/gitaly/v15/internal/grpcstats"
"gitlab.com/gitlab-org/gitaly/v15/internal/helper/fieldextractors"
"gitlab.com/gitlab-org/gitaly/v15/internal/listenmux"
gitalylog "gitlab.com/gitlab-org/gitaly/v15/internal/log"
"gitlab.com/gitlab-org/gitaly/v15/internal/logsanitizer"
"gitlab.com/gitlab-org/gitaly/v15/internal/middleware/cache"
"gitlab.com/gitlab-org/gitaly/v15/internal/middleware/commandstatshandler"
"gitlab.com/gitlab-org/gitaly/v15/internal/middleware/featureflag"
"gitlab.com/gitlab-org/gitaly/v15/internal/middleware/limithandler"
"gitlab.com/gitlab-org/gitaly/v15/internal/middleware/metadatahandler"
"gitlab.com/gitlab-org/gitaly/v15/internal/middleware/panichandler"
"gitlab.com/gitlab-org/gitaly/v15/internal/middleware/sentryhandler"
"gitlab.com/gitlab-org/gitaly/v15/internal/middleware/statushandler"
"gitlab.com/gitlab-org/gitaly/v15/internal/praefect/protoregistry"
grpccorrelation "gitlab.com/gitlab-org/labkit/correlation/grpc"
grpctracing "gitlab.com/gitlab-org/labkit/tracing/grpc"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/keepalive"
)
func init() {
for _, l := range gitalylog.Loggers {
urlSanitizer := logsanitizer.NewURLSanitizerHook()
urlSanitizer.AddPossibleGrpcMethod(
"CreateRepositoryFromURL",
"FetchRemote",
"UpdateRemoteMirror",
)
l.Hooks.Add(urlSanitizer)
}
// grpc-go gets a custom logger; it is too chatty
grpcmwlogrus.ReplaceGrpcLogger(gitalylog.GrpcGo())
}
type serverConfig struct {
unaryInterceptors []grpc.UnaryServerInterceptor
streamInterceptors []grpc.StreamServerInterceptor
}
// Option is an option that can be passed to `New()`.
type Option func(*serverConfig)
// WithUnaryInterceptor adds another interceptor that shall be executed for unary RPC calls.
func WithUnaryInterceptor(interceptor grpc.UnaryServerInterceptor) Option {
return func(cfg *serverConfig) {
cfg.unaryInterceptors = append(cfg.unaryInterceptors, interceptor)
}
}
// WithStreamInterceptor adds another interceptor that shall be executed for streaming RPC calls.
func WithStreamInterceptor(interceptor grpc.StreamServerInterceptor) Option {
return func(cfg *serverConfig) {
cfg.streamInterceptors = append(cfg.streamInterceptors, interceptor)
}
}
// New returns a GRPC server instance with a set of interceptors configured.
func (s *GitalyServerFactory) New(secure bool, opts ...Option) (*grpc.Server, error) {
var cfg serverConfig
for _, opt := range opts {
opt(&cfg)
}
ctxTagOpts := []grpcmwtags.Option{
grpcmwtags.WithFieldExtractorForInitialReq(fieldextractors.FieldExtractor),
}
transportCredentials := insecure.NewCredentials()
// If tls config is specified attempt to extract tls options and use it
// as a grpc.ServerOption
if secure {
cert, err := tls.LoadX509KeyPair(s.cfg.TLS.CertPath, s.cfg.TLS.KeyPath)
if err != nil {
return nil, fmt.Errorf("error reading certificate and key paths: %v", err)
}
transportCredentials = credentials.NewTLS(&tls.Config{
Certificates: []tls.Certificate{cert},
MinVersion: tls.VersionTLS12,
})
}
lm := listenmux.New(transportCredentials)
lm.Register(backchannel.NewServerHandshaker(
s.logger,
s.registry,
[]grpc.DialOption{client.UnaryInterceptor()},
))
logMsgProducer := grpcmwlogrus.WithMessageProducer(
gitalylog.MessageProducer(
gitalylog.PropagationMessageProducer(grpcmwlogrus.DefaultMessageProducer),
commandstatshandler.FieldsProducer,
grpcstats.FieldsProducer,
featureflag.FieldsProducer,
structerr.FieldsProducer,
limithandler.FieldsProducer,
),
)
streamServerInterceptors := []grpc.StreamServerInterceptor{
grpcmwtags.StreamServerInterceptor(ctxTagOpts...),
grpccorrelation.StreamServerCorrelationInterceptor(), // Must be above the metadata handler
metadatahandler.StreamInterceptor,
grpcprometheus.StreamServerInterceptor,
commandstatshandler.StreamInterceptor,
limithandler.StatsStreamInterceptor,
grpcmwlogrus.StreamServerInterceptor(s.logger,
grpcmwlogrus.WithTimestampFormat(gitalylog.LogTimestampFormat),
logMsgProducer,
gitalylog.DeciderOption(),
),
gitalylog.StreamLogDataCatcherServerInterceptor(),
sentryhandler.StreamLogHandler,
statushandler.Stream, // Should be below LogHandler
auth.StreamServerInterceptor(s.cfg.Auth),
}
unaryServerInterceptors := []grpc.UnaryServerInterceptor{
grpcmwtags.UnaryServerInterceptor(ctxTagOpts...),
grpccorrelation.UnaryServerCorrelationInterceptor(), // Must be above the metadata handler
metadatahandler.UnaryInterceptor,
grpcprometheus.UnaryServerInterceptor,
commandstatshandler.UnaryInterceptor,
limithandler.StatsUnaryInterceptor,
grpcmwlogrus.UnaryServerInterceptor(s.logger,
grpcmwlogrus.WithTimestampFormat(gitalylog.LogTimestampFormat),
logMsgProducer,
gitalylog.DeciderOption(),
),
gitalylog.UnaryLogDataCatcherServerInterceptor(),
sentryhandler.UnaryLogHandler,
statushandler.Unary, // Should be below LogHandler
auth.UnaryServerInterceptor(s.cfg.Auth),
}
// Should be below auth handler to prevent v2 hmac tokens from timing out while queued
for _, limitHandler := range s.limitHandlers {
streamServerInterceptors = append(streamServerInterceptors, limitHandler.StreamInterceptor())
unaryServerInterceptors = append(unaryServerInterceptors, limitHandler.UnaryInterceptor())
}
streamServerInterceptors = append(streamServerInterceptors,
grpctracing.StreamServerTracingInterceptor(),
cache.StreamInvalidator(s.cacheInvalidator, protoregistry.GitalyProtoPreregistered),
// Panic handler should remain last so that application panics will be
// converted to errors and logged
panichandler.StreamPanicHandler,
)
unaryServerInterceptors = append(unaryServerInterceptors,
cache.UnaryInvalidator(s.cacheInvalidator, protoregistry.GitalyProtoPreregistered),
// Panic handler should remain last so that application panics will be
// converted to errors and logged
panichandler.UnaryPanicHandler,
)
streamServerInterceptors = append(streamServerInterceptors, cfg.streamInterceptors...)
unaryServerInterceptors = append(unaryServerInterceptors, cfg.unaryInterceptors...)
serverOptions := []grpc.ServerOption{
grpc.StatsHandler(gitalylog.PerRPCLogHandler{
Underlying: &grpcstats.PayloadBytes{},
FieldProducers: []gitalylog.FieldsProducer{grpcstats.FieldsProducer},
}),
grpc.Creds(lm),
grpc.StreamInterceptor(grpcmw.ChainStreamServer(streamServerInterceptors...)),
grpc.UnaryInterceptor(grpcmw.ChainUnaryServer(unaryServerInterceptors...)),
// We deliberately set the server MinTime to significantly less than the client interval of 20
// seconds to allow for network jitter. We can afford to be forgiving as the maximum number of
// concurrent clients for a Gitaly server is typically in the hundreds and this volume of
// keepalives won't add significant load.
grpc.KeepaliveEnforcementPolicy(keepalive.EnforcementPolicy{
MinTime: 10 * time.Second,
PermitWithoutStream: true,
}),
grpc.KeepaliveParams(keepalive.ServerParameters{
Time: 5 * time.Minute,
}),
}
return grpc.NewServer(serverOptions...), nil
}
|
