Class: Sentry::RequestInterface

Inherits:
Interface show all
Defined in:
lib/sentry/interfaces/request.rb

Constant Summary collapse

REQUEST_ID_HEADERS = 
%w[action_dispatch.request_id HTTP_X_REQUEST_ID].freeze
CONTENT_HEADERS = 
%w[CONTENT_TYPE CONTENT_LENGTH].freeze
IP_HEADERS = 
[
  "REMOTE_ADDR",
  "HTTP_CLIENT_IP",
  "HTTP_X_REAL_IP",
  "HTTP_X_FORWARDED_FOR"
].freeze
LOWERCASE_PATTERN =

Regex to detect lowercase chars — match? is allocation-free (no MatchData/String)

/[a-z]/.freeze
MAX_BODY_LIMIT =

See Sentry server default limits at github.com/getsentry/sentry/blob/master/src/sentry/conf/server.py

4096 * 4

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Interface

#to_h

Constructor Details

#initialize(env:, send_default_pii:, rack_env_whitelist:) ⇒ RequestInterface

Returns a new instance of RequestInterface.

Parameters:

  • env (Hash)
  • send_default_pii (Boolean)
  • rack_env_whitelist (Array)

See Also:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/sentry/interfaces/request.rb', line 47

def initialize(env:, send_default_pii:, rack_env_whitelist:)
  env = env.dup

  unless send_default_pii
    # need to completely wipe out ip addresses
    RequestInterface::IP_HEADERS.each do |header|
      env.delete(header)
    end
  end

  request = ::Rack::Request.new(env)

  if send_default_pii
    self.data = read_data_from(request)
    self.cookies = request.cookies
    self.query_string = request.query_string
  end

  self.url = request.scheme && request.url.split("?").first
  self.method = request.request_method

  self.headers = filter_and_format_headers(env, send_default_pii)
  self.env     = filter_and_format_env(env, rack_env_whitelist)
end

Instance Attribute Details

#cookies ⇒ String

Returns:

  • (String) 


34
35
36
 
# File 'lib/sentry/interfaces/request.rb', line 34

def cookies
  @cookies
end

#data ⇒ Hash

Returns:

  • (Hash) 


28
29
30
 
# File 'lib/sentry/interfaces/request.rb', line 28

def data
  @data
end

#env ⇒ Hash

Returns:

  • (Hash) 


40
41
42
 
# File 'lib/sentry/interfaces/request.rb', line 40

def env
  @env
end

#headers ⇒ Hash

Returns:

  • (Hash) 


37
38
39
 
# File 'lib/sentry/interfaces/request.rb', line 37

def headers
  @headers
end

#method ⇒ String

Returns:

  • (String) 


25
26
27
 
# File 'lib/sentry/interfaces/request.rb', line 25

def method
  @method
end

#query_string ⇒ String

Returns:

  • (String) 


31
32
33
 
# File 'lib/sentry/interfaces/request.rb', line 31

def query_string
  @query_string
end

#url ⇒ String

Returns:

  • (String) 


22
23
24
 
# File 'lib/sentry/interfaces/request.rb', line 22

def url
  @url
end

Class Method Details

.rack_3_or_above? ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
133
134
135
 
# File 'lib/sentry/interfaces/request.rb', line 130

def self.rack_3_or_above?
  return @rack_3_or_above if defined?(@rack_3_or_above)

  @rack_3_or_above = defined?(::Rack) &&
    Gem::Version.new(::Rack.release) >= Gem::Version.new("3.0")
end