debian-mirror-gitlab/lib/gitlab/sidekiq_middleware.rb

67 lines
3.3 KiB
Ruby
Raw Normal View History

2020-01-01 13:55:28 +05:30
# frozen_string_literal: true
module Gitlab
# The SidekiqMiddleware class is responsible for configuring the
# middleware stacks used in the client and server middlewares
module SidekiqMiddleware
# The result of this method should be passed to
# Sidekiq's `config.server_middleware` method
# eg: `config.server_middleware(&Gitlab::SidekiqMiddleware.server_configurator)`
2020-05-24 23:13:21 +05:30
def self.server_configurator(metrics: true, arguments_logger: true, memory_killer: true)
2020-01-01 13:55:28 +05:30
lambda do |chain|
2021-09-04 01:27:46 +05:30
# Size limiter should be placed at the top
chain.add ::Gitlab::SidekiqMiddleware::SizeLimiter::Server
2020-04-08 14:13:33 +05:30
chain.add ::Gitlab::SidekiqMiddleware::Monitor
2021-09-30 23:02:18 +05:30
2021-11-18 22:05:49 +05:30
# Labkit wraps the job in the `Labkit::Context` resurrected from
# the job-hash. We need properties from the context for
# recording metrics, so this needs to be before
# `::Gitlab::SidekiqMiddleware::ServerMetrics` (if we're using
# that).
chain.add ::Labkit::Middleware::Sidekiq::Server
2021-09-30 23:02:18 +05:30
if metrics
chain.add ::Gitlab::SidekiqMiddleware::ServerMetrics
::Gitlab::SidekiqMiddleware::ServerMetrics.initialize_process_metrics
end
2020-04-08 14:13:33 +05:30
chain.add ::Gitlab::SidekiqMiddleware::ArgumentsLogger if arguments_logger
chain.add ::Gitlab::SidekiqMiddleware::MemoryKiller if memory_killer
2020-05-24 23:13:21 +05:30
chain.add ::Gitlab::SidekiqMiddleware::RequestStoreMiddleware
chain.add ::Gitlab::SidekiqMiddleware::ExtraDoneLogMetadata
2020-04-08 14:13:33 +05:30
chain.add ::Gitlab::SidekiqMiddleware::BatchLoader
chain.add ::Gitlab::SidekiqMiddleware::InstrumentationLogger
chain.add ::Gitlab::SidekiqMiddleware::AdminMode::Server
2022-05-07 20:08:51 +05:30
chain.add ::Gitlab::SidekiqMiddleware::QueryAnalyzer
2020-10-24 23:57:45 +05:30
chain.add ::Gitlab::SidekiqVersioning::Middleware
2020-04-08 14:13:33 +05:30
chain.add ::Gitlab::SidekiqStatus::ServerMiddleware
chain.add ::Gitlab::SidekiqMiddleware::WorkerContext::Server
2021-11-11 11:23:49 +05:30
# DuplicateJobs::Server should be placed at the bottom, but before the SidekiqServerMiddleware,
# so we can compare the latest WAL location against replica
2020-04-08 14:13:33 +05:30
chain.add ::Gitlab::SidekiqMiddleware::DuplicateJobs::Server
2021-11-18 22:05:49 +05:30
chain.add ::Gitlab::Database::LoadBalancing::SidekiqServerMiddleware
2020-01-01 13:55:28 +05:30
end
end
# The result of this method should be passed to
# Sidekiq's `config.client_middleware` method
# eg: `config.client_middleware(&Gitlab::SidekiqMiddleware.client_configurator)`
def self.client_configurator
lambda do |chain|
2020-04-08 14:13:33 +05:30
chain.add ::Gitlab::SidekiqMiddleware::WorkerContext::Client # needs to be before the Labkit middleware
chain.add ::Labkit::Middleware::Sidekiq::Client
2021-11-11 11:23:49 +05:30
# Sidekiq Client Middleware should be placed before DuplicateJobs::Client middleware,
# so we can store WAL location before we deduplicate the job.
2021-11-18 22:05:49 +05:30
chain.add ::Gitlab::Database::LoadBalancing::SidekiqClientMiddleware
2020-04-08 14:13:33 +05:30
chain.add ::Gitlab::SidekiqMiddleware::DuplicateJobs::Client
2020-04-22 19:07:51 +05:30
chain.add ::Gitlab::SidekiqStatus::ClientMiddleware
chain.add ::Gitlab::SidekiqMiddleware::AdminMode::Client
2021-11-11 11:23:49 +05:30
# Size limiter should be placed at the bottom, but before the metrics middleware
2021-04-17 20:07:23 +05:30
chain.add ::Gitlab::SidekiqMiddleware::SizeLimiter::Client
2020-04-22 19:07:51 +05:30
chain.add ::Gitlab::SidekiqMiddleware::ClientMetrics
2020-01-01 13:55:28 +05:30
end
end
end
end