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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
|
package praefect
import (
"context"
"database/sql"
"errors"
"fmt"
"math/rand"
"net/http"
"runtime/debug"
"time"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/sirupsen/logrus"
"github.com/urfave/cli/v2"
"gitlab.com/gitlab-org/gitaly/v16/internal/bootstrap"
"gitlab.com/gitlab-org/gitaly/v16/internal/bootstrap/starter"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/config/sentry"
"gitlab.com/gitlab-org/gitaly/v16/internal/grpc/backchannel"
"gitlab.com/gitlab-org/gitaly/v16/internal/grpc/sidechannel"
"gitlab.com/gitlab-org/gitaly/v16/internal/helper"
"gitlab.com/gitlab-org/gitaly/v16/internal/log"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/config"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/datastore"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/datastore/glsql"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/metrics"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/nodes"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/nodes/tracker"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/protoregistry"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/reconciler"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/repocleaner"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/service"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/service/transaction"
"gitlab.com/gitlab-org/gitaly/v16/internal/praefect/transactions"
"gitlab.com/gitlab-org/gitaly/v16/internal/version"
"gitlab.com/gitlab-org/labkit/monitoring"
"gitlab.com/gitlab-org/labkit/tracing"
)
func newServeCommand() *cli.Command {
return &cli.Command{
Name: "serve",
Usage: "launch the server daemon",
Action: serveAction,
HideHelpCommand: true,
Before: func(context *cli.Context) error {
if context.Args().Present() {
return unexpectedPositionalArgsError{Command: context.Command.Name}
}
return nil
},
}
}
func serveAction(ctx *cli.Context) error {
if ctx.Args().Present() {
return unexpectedPositionalArgsError{Command: ctx.Command.Name}
}
logger := log.Default()
// The ctx.Command.Name can't be used here because if `praefect -config FILE` is used
// it will be set to 'praefect' instead of 'serve'.
pathToConfigFile := mustProvideConfigFlag(ctx, "serve")
logger.Infof("Starting %s", version.GetVersionString("Praefect"))
if err := run(ctx.App.Name, logger, pathToConfigFile); err != nil {
logger.WithError(err).Error("Praefect shutdown")
return cli.Exit("", 1)
}
logger.Info("Praefect shutdown")
return nil
}
func run(appName string, logger *logrus.Entry, configPath string) error {
conf, err := getConfig(logger, configPath)
if err != nil {
return err
}
conf.ConfigureLogger()
configure(appName, conf)
starterConfigs, err := getStarterConfigs(conf)
if err != nil {
return cli.Exit(err, 1)
}
promreg := prometheus.DefaultRegisterer
b, err := bootstrap.New(promauto.With(promreg).NewCounterVec(
prometheus.CounterOpts{
Name: "gitaly_praefect_connections_total",
Help: "Total number of connections to Praefect",
},
[]string{"type"},
))
if err != nil {
return cli.Exit(fmt.Errorf("unable to create a bootstrap: %w", err), 1)
}
dbPromRegistry := prometheus.NewRegistry()
if err := server(starterConfigs, conf, logger, b, promreg, dbPromRegistry); err != nil {
return cli.Exit(err, 1)
}
return nil
}
func initConfig(logger *logrus.Entry, path string) (config.Config, error) {
conf, err := config.FromFile(path)
if err != nil {
return conf, fmt.Errorf("error reading config file: %w", err)
}
if err := conf.Validate(); err != nil {
return config.Config{}, err
}
if !conf.AllowLegacyElectors {
conf.Failover.ElectionStrategy = config.ElectionStrategyPerRepository
}
if !conf.Failover.Enabled && conf.Failover.ElectionStrategy != "" {
logger.WithField("election_strategy", conf.Failover.ElectionStrategy).Warn(
"ignoring configured election strategy as failover is disabled")
}
return conf, nil
}
func getConfig(logger *logrus.Entry, path string) (config.Config, error) {
conf, err := initConfig(logger, path)
if err != nil {
return conf, cli.Exit(fmt.Errorf("configuration error: %w", err), 1)
}
return conf, nil
}
func configure(appName string, conf config.Config) {
tracing.Initialize(tracing.WithServiceName(appName))
if conf.PrometheusListenAddr != "" {
conf.Prometheus.Configure()
}
sentry.ConfigureSentry(version.GetVersion(), conf.Sentry)
}
func server(
cfgs []starter.Config,
conf config.Config,
logger *logrus.Entry,
b bootstrap.Listener,
promreg prometheus.Registerer,
dbPromRegistry interface {
prometheus.Registerer
prometheus.Gatherer
},
) error {
nodeLatencyHistogram, err := metrics.RegisterNodeLatency(conf.Prometheus, promreg)
if err != nil {
return err
}
delayMetric, err := metrics.RegisterReplicationDelay(conf.Prometheus, promreg)
if err != nil {
return err
}
latencyMetric, err := metrics.RegisterReplicationLatency(conf.Prometheus, promreg)
if err != nil {
return err
}
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
var db *sql.DB
if conf.NeedsSQL() {
logger.Infof("establishing database connection to %s:%d ...", conf.DB.Host, conf.DB.Port)
dbConn, closedb, err := initDatabase(ctx, logger, conf)
if err != nil {
return err
}
defer closedb()
db = dbConn
logger.Info("database connection established")
}
var queue datastore.ReplicationEventQueue
var rs datastore.RepositoryStore
var csg datastore.ConsistentStoragesGetter
var metricsCollectors []prometheus.Collector
if conf.MemoryQueueEnabled {
queue = datastore.NewMemoryReplicationEventQueue(conf)
rs = datastore.MockRepositoryStore{}
csg = rs
logger.Info("reads distribution caching is disabled for in memory storage")
} else {
queue = datastore.NewPostgresReplicationEventQueue(db)
rs = datastore.NewPostgresRepositoryStore(db, conf.StorageNames())
dsn := glsql.DSN(conf.DB, true)
if dsn == "" {
csg = rs
logger.Info("reads distribution caching is disabled because direct connection to Postgres is not set")
} else {
storagesCached, err := datastore.NewCachingConsistentStoragesGetter(logger, rs, conf.VirtualStorageNames())
if err != nil {
return fmt.Errorf("caching storage provider: %w", err)
}
resilientListenerTicker := helper.NewTimerTicker(5 * time.Second)
notificationsListener := datastore.NewResilientListener(conf.DB, resilientListenerTicker, logger)
go func() {
err := notificationsListener.Listen(ctx, storagesCached, datastore.StorageRepositoriesUpdatesChannel, datastore.RepositoriesUpdatesChannel)
if err != nil && !errors.Is(err, context.Canceled) {
logger.WithError(err).Error("notifications listener terminated")
}
}()
metricsCollectors = append(metricsCollectors, storagesCached, notificationsListener)
csg = storagesCached
logger.Info("reads distribution caching is enabled by configuration")
}
}
var errTracker tracker.ErrorTracker
if conf.Failover.Enabled {
thresholdsConfigured, err := conf.Failover.ErrorThresholdsConfigured()
if err != nil {
return err
}
if thresholdsConfigured {
errorWindowFunction, err := tracker.NewErrorWindowFunction(conf.Failover)
if err != nil {
return err
}
errTracker, err = tracker.NewErrors(ctx, errorWindowFunction, conf.Failover.ReadErrorThresholdCount, conf.Failover.WriteErrorThresholdCount)
if err != nil {
return err
}
}
}
transactionManager := transactions.NewManager(conf)
sidechannelRegistry := sidechannel.NewRegistry()
backchannelCfg := backchannel.DefaultConfiguration()
backchannelCfg.AcceptBacklog = int(conf.Yamux.AcceptBacklog)
backchannelCfg.MaximumStreamWindowSizeBytes = conf.Yamux.MaximumStreamWindowSizeBytes
clientHandshaker := backchannel.NewClientHandshaker(
logger,
praefect.NewBackchannelServerFactory(logger, transaction.NewServer(transactionManager), sidechannelRegistry),
backchannelCfg,
)
assignmentStore := praefect.NewDisabledAssignmentStore(conf.StorageNames())
var (
nodeManager nodes.Manager
healthChecker praefect.HealthChecker
nodeSet praefect.NodeSet
router praefect.Router
primaryGetter praefect.PrimaryGetter
)
if conf.Failover.ElectionStrategy == config.ElectionStrategyPerRepository {
nodeSet, err = praefect.DialNodes(
ctx,
conf.VirtualStorages,
protoregistry.GitalyProtoPreregistered,
errTracker,
clientHandshaker,
sidechannelRegistry,
)
if err != nil {
return fmt.Errorf("dial nodes: %w", err)
}
defer nodeSet.Close()
healthManager := nodes.NewHealthManager(logger, db, nodes.GeneratePraefectName(conf, logger), nodeSet.HealthClients())
go func() {
if err := healthManager.Run(ctx, helper.NewTimerTicker(time.Second)); err != nil {
logger.WithError(err).Error("health manager exited")
}
}()
healthChecker = healthManager
// Wait for the first health check to complete so the Praefect doesn't start serving RPC
// before the router is ready with the health status of the nodes.
<-healthManager.Updated()
elector := nodes.NewPerRepositoryElector(db)
primaryGetter = elector
assignmentStore = datastore.NewAssignmentStore(db, conf.StorageNames())
router = praefect.NewPerRepositoryRouter(
nodeSet.Connections(),
elector,
healthManager,
praefect.NewLockedRandom(rand.New(rand.NewSource(time.Now().UnixNano()))),
csg,
assignmentStore,
rs,
conf.DefaultReplicationFactors(),
)
if conf.BackgroundVerification.VerificationInterval > 0 {
logger.WithField("config", conf.BackgroundVerification).Info("background verifier started")
verifier := praefect.NewMetadataVerifier(
logger,
db,
nodeSet.Connections(),
healthManager,
conf.BackgroundVerification.VerificationInterval.Duration(),
conf.BackgroundVerification.DeleteInvalidRecords,
)
promreg.MustRegister(verifier)
go func() {
if err := verifier.Run(ctx, helper.NewTimerTicker(2*time.Second)); err != nil {
logger.WithError(err).Error("metadata verifier finished")
}
}()
go func() {
if err := verifier.RunExpiredLeaseReleaser(ctx, helper.NewTimerTicker(10*time.Second)); err != nil {
logger.WithError(err).Error("expired verification lease releaser finished")
}
}()
} else {
logger.Info("background verifier is disabled")
}
} else {
if conf.Failover.Enabled {
logger.WithField("election_strategy", conf.Failover.ElectionStrategy).Warn(
"Deprecated election stategy in use, migrate to repository specific primary nodes following https://docs.gitlab.com/ee/administration/gitaly/praefect.html#migrate-to-repository-specific-primary-gitaly-nodes. The other election strategies are scheduled for removal in GitLab 14.0.")
}
nodeMgr, err := nodes.NewManager(logger, conf, db, csg, nodeLatencyHistogram, protoregistry.GitalyProtoPreregistered, errTracker, clientHandshaker, sidechannelRegistry)
if err != nil {
return err
}
healthChecker = praefect.HealthChecker(nodeMgr)
nodeSet = praefect.NodeSetFromNodeManager(nodeMgr)
router = praefect.NewNodeManagerRouter(nodeMgr, rs)
primaryGetter = nodeMgr
nodeManager = nodeMgr
nodeMgr.Start(conf.Failover.BootstrapInterval.Duration(), conf.Failover.MonitorInterval.Duration())
defer nodeMgr.Stop()
}
logger.Infof("election strategy: %q", conf.Failover.ElectionStrategy)
logger.Info("background started: gitaly nodes health monitoring")
var (
// top level server dependencies
coordinator = praefect.NewCoordinator(
queue,
rs,
router,
transactionManager,
conf,
protoregistry.GitalyProtoPreregistered,
)
repl = praefect.NewReplMgr(
logger,
conf.StorageNames(),
queue,
rs,
healthChecker,
nodeSet,
praefect.WithDelayMetric(delayMetric),
praefect.WithLatencyMetric(latencyMetric),
praefect.WithDequeueBatchSize(conf.Replication.BatchSize),
praefect.WithParallelStorageProcessingWorkers(conf.Replication.ParallelStorageProcessingWorkers),
)
srvFactory = praefect.NewServerFactory(
conf,
logger,
coordinator.StreamDirector,
nodeManager,
transactionManager,
queue,
rs,
assignmentStore,
protoregistry.GitalyProtoPreregistered,
nodeSet.Connections(),
primaryGetter,
service.ReadinessChecks(),
defaultServerOptions...,
)
)
metricsCollectors = append(metricsCollectors, transactionManager, coordinator, repl)
if db != nil {
dbMetricCollectors := []prometheus.Collector{
datastore.NewRepositoryStoreCollector(logger, conf.VirtualStorageNames(), db, conf.Prometheus.ScrapeTimeout.Duration()),
datastore.NewQueueDepthCollector(logger, db, conf.Prometheus.ScrapeTimeout.Duration()),
}
if conf.BackgroundVerification.VerificationInterval > 0 {
dbMetricCollectors = append(dbMetricCollectors, datastore.NewVerificationQueueDepthCollector(
logger,
db,
conf.Prometheus.ScrapeTimeout.Duration(),
conf.BackgroundVerification.VerificationInterval.Duration(),
conf.StorageNames(),
))
}
// Database-related metrics are exported via a separate endpoint such that it's possible
// to set a different scraping interval and thus to reduce database load.
dbPromRegistry.MustRegister(dbMetricCollectors...)
}
promreg.MustRegister(metricsCollectors...)
for _, cfg := range cfgs {
srv, err := srvFactory.Create(cfg.IsSecure())
if err != nil {
return fmt.Errorf("create gRPC server: %w", err)
}
defer srv.Stop()
b.RegisterStarter(starter.New(cfg, srv))
}
if conf.PrometheusListenAddr != "" {
logger.WithField("address", conf.PrometheusListenAddr).Info("Starting prometheus listener")
b.RegisterStarter(func(listen bootstrap.ListenFunc, _ chan<- error, _ *prometheus.CounterVec) error {
l, err := listen(starter.TCP, conf.PrometheusListenAddr)
if err != nil {
return err
}
serveMux := http.NewServeMux()
serveMux.Handle("/db_metrics", promhttp.HandlerFor(dbPromRegistry, promhttp.HandlerOpts{}))
go func() {
opts := []monitoring.Option{
monitoring.WithListener(l),
monitoring.WithServeMux(serveMux),
}
if buildInfo, ok := debug.ReadBuildInfo(); ok {
opts = append(opts, monitoring.WithGoBuildInformation(buildInfo))
}
if err := monitoring.Start(opts...); err != nil {
logger.WithError(err).Errorf("Unable to start prometheus listener: %v", conf.PrometheusListenAddr)
}
}()
return nil
})
}
if err := b.Start(); err != nil {
return fmt.Errorf("unable to start the bootstrap: %w", err)
}
for _, cfg := range cfgs {
logger.WithFields(logrus.Fields{"schema": cfg.Name, "address": cfg.Addr}).Info("listening")
}
go repl.ProcessBacklog(ctx, praefect.ExpBackoffFactory{Start: time.Second, Max: 5 * time.Second})
staleTicker := helper.NewTimerTicker(30 * time.Second)
defer staleTicker.Stop()
logger.Info("background started: processing of the replication events")
repl.ProcessStale(ctx, staleTicker, time.Minute)
logger.Info("background started: processing of the stale replication events")
if interval := conf.Reconciliation.SchedulingInterval.Duration(); interval > 0 {
if conf.MemoryQueueEnabled {
logger.Warn("Disabled automatic reconciliation as it is only implemented using SQL queue and in-memory queue is configured.")
} else {
r := reconciler.NewReconciler(
logger,
db,
healthChecker,
conf.StorageNames(),
conf.Reconciliation.HistogramBuckets,
)
promreg.MustRegister(r)
go func() {
if err := r.Run(ctx, helper.NewTimerTicker(interval)); err != nil {
logger.WithError(err).Error("reconciler finished execution")
}
}()
}
}
if interval := conf.RepositoriesCleanup.RunInterval.Duration(); interval > 0 {
if db != nil {
go func() {
storageSync := datastore.NewStorageCleanup(db)
cfg := repocleaner.Cfg{
RunInterval: conf.RepositoriesCleanup.RunInterval.Duration(),
LivenessInterval: 30 * time.Second,
RepositoriesInBatch: int(conf.RepositoriesCleanup.RepositoriesInBatch),
}
repoCleaner := repocleaner.NewRunner(cfg, logger, healthChecker, nodeSet.Connections(), storageSync, storageSync, repocleaner.NewLogWarnAction(logger))
if err := repoCleaner.Run(ctx, helper.NewTimerTicker(conf.RepositoriesCleanup.CheckInterval.Duration())); err != nil && !errors.Is(context.Canceled, err) {
logger.WithError(err).Error("repository cleaner finished execution")
} else {
logger.Info("repository cleaner finished execution")
}
}()
} else {
logger.Warn("Repository cleanup background task disabled as there is no database connection configured.")
}
} else {
logger.Warn(`Repository cleanup background task disabled as "repositories_cleanup.run_interval" is not set or 0.`)
}
gracefulStopTicker := helper.NewTimerTicker(conf.GracefulStopTimeout.Duration())
defer gracefulStopTicker.Stop()
return b.Wait(gracefulStopTicker, srvFactory.GracefulStop)
}
func getStarterConfigs(conf config.Config) ([]starter.Config, error) {
var cfgs []starter.Config
unique := map[string]struct{}{}
for schema, addr := range map[string]string{
starter.TCP: conf.ListenAddr,
starter.TLS: conf.TLSListenAddr,
starter.Unix: conf.SocketPath,
} {
if addr == "" {
continue
}
addrConf, err := starter.ParseEndpoint(addr)
if err != nil {
// address doesn't include schema
if !errors.Is(err, starter.ErrEmptySchema) {
return nil, err
}
addrConf = starter.Config{Name: schema, Addr: addr}
}
addrConf.HandoverOnUpgrade = true
if _, found := unique[addrConf.Addr]; found {
return nil, fmt.Errorf("same address can't be used for different schemas %q", addr)
}
unique[addrConf.Addr] = struct{}{}
cfgs = append(cfgs, addrConf)
}
if len(cfgs) == 0 {
return nil, errors.New("no listening addresses were provided, unable to start")
}
return cfgs, nil
}
func initDatabase(ctx context.Context, logger *logrus.Entry, conf config.Config) (*sql.DB, func(), error) {
openDBCtx, cancel := context.WithTimeout(ctx, 30*time.Second)
defer cancel()
db, err := glsql.OpenDB(openDBCtx, conf.DB)
if err != nil {
logger.WithError(err).Error("SQL connection open failed")
return nil, nil, err
}
closedb := func() {
if err := db.Close(); err != nil {
logger.WithError(err).Error("SQL connection close failed")
}
}
if err := datastore.CheckPostgresVersion(db); err != nil {
closedb()
return nil, nil, err
}
return db, closedb, nil
}
|