Class: Gitlab::Metrics::RequestsRackMiddleware

Inherits:
Object
  • Object
show all
Includes:
SliConfig
Defined in:
lib/gitlab/metrics/requests_rack_middleware.rb

Constant Summary collapse

HTTP_METHODS = 
{
  "delete" => %w[200 202 204 303 400 401 403 404 500 503],
  "get" => %w[200 204 301 302 303 304 307 400 401 403 404 410 422 429 500 503],
  "head" => %w[200 204 301 302 303 401 403 404 410 500],
  "options" => %w[200 404],
  "patch" => %w[200 202 204 400 403 404 409 416 500],
  "post" => %w[200 201 202 204 301 302 303 304 400 401 403 404 406 409 410 412 422 429 500 503],
  "put" => %w[200 202 204 400 401 403 404 405 406 409 410 422 500]
}.freeze
HEALTH_ENDPOINT = 
%r{^/-/(liveness|readiness|health|metrics)/?$}
FEATURE_CATEGORY_DEFAULT = 
::Gitlab::FeatureCategories::FEATURE_CATEGORY_DEFAULT
ENDPOINT_MISSING = 
'unknown'
FEATURE_CATEGORIES_TO_INITIALIZE =

These were the top 5 categories at a point in time, chosen as a reasonable default. If we initialize every category we’ll end up with an explosion in unused metric combinations, but we want the most common ones to be always present.

['system_access',
'code_review_workflow', 'continuous_integration',
'not_owned', 'source_code_management',
FEATURE_CATEGORY_DEFAULT].freeze
REQUEST_URGENCY_KEY = 
'gitlab.request_urgency'

Class Method Summary collapse

Instance Method Summary collapse

Methods included from SliConfig

enabled_slis, included, register, registered_classes

Constructor Details

#initialize(app) ⇒ RequestsRackMiddleware

Returns a new instance of RequestsRackMiddleware.



36
37
38
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 36

def initialize(app)
  @app = app
end

Class Method Details

.http_health_requests_total ⇒ Object 



53
54
55
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 53

def self.http_health_requests_total
  ::Gitlab::Metrics.counter(:http_health_requests_total, 'Health endpoint request count')
end

.http_request_duration_seconds ⇒ Object 



48
49
50
51
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 48

def self.http_request_duration_seconds
  ::Gitlab::Metrics.histogram(:http_request_duration_seconds, 'Request handling execution time',
    {}, [0.05, 0.1, 0.25, 0.5, 0.7, 1, 2.5, 5, 10, 25])
end

.http_requests_total ⇒ Object 



40
41
42
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 40

def self.http_requests_total
  ::Gitlab::Metrics.counter(:http_requests_total, 'Request count')
end

.initialize_slis! ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 57

def self.initialize_slis!
  # This initialization is done to avoid gaps in scraped metrics after
  # restarts. It makes sure all counters/histograms are available at
  # process start.
  #
  # For example `rate(http_requests_total{status="500"}[1m])` would return
  # no data until the first 500 error would occur.
  HTTP_METHODS.each do |method, statuses|
    http_request_duration_seconds.get({ method: method })

    statuses.product(FEATURE_CATEGORIES_TO_INITIALIZE) do |status, feature_category|
      http_requests_total.get({ method: method, status: status, feature_category: feature_category })
    end
  end

  Gitlab::Metrics::RailsSlis.initialize_request_slis!
end

.rack_uncaught_errors_count ⇒ Object 



44
45
46
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 44

def self.rack_uncaught_errors_count
  ::Gitlab::Metrics.counter(:rack_uncaught_errors_total, 'Request handling uncaught errors count')
end

Instance Method Details

#call(env) ⇒ Object 



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
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 75

def call(env)
  method = env['REQUEST_METHOD'].downcase
  method = 'INVALID' unless HTTP_METHODS.key?(method)
  started = ::Gitlab::Metrics::System.monotonic_time
  health_endpoint = health_endpoint?(env['PATH_INFO'])
  status = 'undefined'

  begin
    status, headers, body = @app.call(env)
    return [status, headers, body] if health_endpoint

    urgency = urgency_for_env(env)
    if ::Gitlab::Metrics.record_duration_for_status?(status)
      elapsed = ::Gitlab::Metrics::System.monotonic_time - started
      self.class.http_request_duration_seconds.observe({ method: method }, elapsed)
      record_apdex(urgency, elapsed)
    end

    record_error(urgency, status)

    [status, headers, body]
  rescue StandardError
    self.class.rack_uncaught_errors_count.increment
    raise
  ensure
    if health_endpoint
      self.class.http_health_requests_total.increment(status: status.to_s, method: method)
    else
      self.class.http_requests_total.increment(
        status: status.to_s,
        method: method,
        feature_category: feature_category.presence || FEATURE_CATEGORY_DEFAULT
      )
    end
  end
end

#endpoint_id ⇒ Object 



122
123
124
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 122

def endpoint_id
  ::Gitlab::ApplicationContext.current_context_attribute(:caller_id)
end

#feature_category ⇒ Object 



118
119
120
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 118

def feature_category
  ::Gitlab::ApplicationContext.current_context_attribute(:feature_category)
end

#health_endpoint?(path) ⇒ Boolean

Returns:

  • (Boolean) 


112
113
114
115
116
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 112

def health_endpoint?(path)
  return false if path.blank?

  HEALTH_ENDPOINT.match?(CGI.unescape(path))
end

#labels_from_context ⇒ Object 



140
141
142
143
144
145
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 140

def labels_from_context
  {
    feature_category: feature_category.presence || FEATURE_CATEGORY_DEFAULT,
    endpoint_id: endpoint_id.presence || ENDPOINT_MISSING
  }
end

#record_apdex(urgency, elapsed) ⇒ Object 



126
127
128
129
130
131
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 126

def record_apdex(urgency, elapsed)
  Gitlab::Metrics::RailsSlis.request_apdex.increment(
    labels: labels_from_context.merge(request_urgency: urgency.name),
    success: elapsed < urgency.duration
  )
end

#record_error(urgency, status) ⇒ Object 



133
134
135
136
137
138
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 133

def record_error(urgency, status)
  Gitlab::Metrics::RailsSlis.request_error_rate.increment(
    labels: labels_from_context.merge(request_urgency: urgency.name),
    error: ::Gitlab::Metrics.server_error?(status)
  )
end

#urgency_for_env(env) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/gitlab/metrics/requests_rack_middleware.rb', line 147

def urgency_for_env(env)
  endpoint_urgency =
    if env[REQUEST_URGENCY_KEY].present?
      env[REQUEST_URGENCY_KEY]
    elsif env['api.endpoint'].present?
      env['api.endpoint'].options[:for].try(:urgency_for_app, env['api.endpoint'])
    elsif env['action_controller.instance'].present? && env['action_controller.instance'].respond_to?(:urgency)
      env['action_controller.instance'].urgency
    end

  endpoint_urgency || Gitlab::EndpointAttributes::DEFAULT_URGENCY
end