f9c456bd0c
Previously, we called the `peek_enabled?` method like so:
prepend_before_action :set_peek_request_id, if: :peek_enabled?
Now we don't have a `set_peek_request_id` method, so we don't need that
line. However, the `peek_enabled?` part had a side-effect: it would also
populate the request store cache for whether the performance bar was
enabled for the current request or not.
This commit makes that side-effect explicit, and replaces all uses of
`peek_enabled?` with the more explicit
`Gitlab::PerformanceBar.enabled_for_request?`. There is one spec that
still sets `SafeRequestStore[:peek_enabled]` directly, because it is
contrasting behaviour with and without a request store enabled.
The upshot is:
1. We still set the value in one place. We make it more explicit that
that's what we're doing.
2. Reading that value uses a consistent method so it's easier to find in
future.
69 lines
1.5 KiB
Ruby
69 lines
1.5 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'redis'
|
|
|
|
module Gitlab
|
|
module Peek
|
|
module RedisInstrumented
|
|
def call(*args, &block)
|
|
start = Time.now
|
|
super(*args, &block)
|
|
ensure
|
|
duration = (Time.now - start)
|
|
add_call_details(duration, args)
|
|
end
|
|
|
|
private
|
|
|
|
def add_call_details(duration, args)
|
|
return unless Gitlab::PerformanceBar.enabled_for_request?
|
|
# redis-rb passes an array (e.g. [:get, key])
|
|
return unless args.length == 1
|
|
|
|
detail_store << {
|
|
cmd: args.first,
|
|
duration: duration,
|
|
backtrace: ::Gitlab::Profiler.clean_backtrace(caller)
|
|
}
|
|
end
|
|
|
|
def detail_store
|
|
::Gitlab::SafeRequestStore['redis_call_details'] ||= []
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
module Peek
|
|
module Views
|
|
class RedisDetailed < DetailedView
|
|
REDACTED_MARKER = "<redacted>"
|
|
|
|
def key
|
|
'redis'
|
|
end
|
|
|
|
private
|
|
|
|
def format_call_details(call)
|
|
super.merge(cmd: format_command(call[:cmd]))
|
|
end
|
|
|
|
def format_command(cmd)
|
|
if cmd.length >= 2 && cmd.first =~ /^auth$/i
|
|
cmd[-1] = REDACTED_MARKER
|
|
# Scrub out the value of the SET calls to avoid binary
|
|
# data or large data from spilling into the view
|
|
elsif cmd.length >= 3 && cmd.first =~ /set/i
|
|
cmd[2..-1] = REDACTED_MARKER
|
|
end
|
|
|
|
cmd.join(' ')
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
class Redis::Client
|
|
prepend Gitlab::Peek::RedisInstrumented
|
|
end
|