Module: Oboe::Config

Defined in:
lib/oboe/config.rb

Overview

This module exposes a nested configuration hash that can be used to configure and/or modify the functionality of the oboe gem.

Use Oboe::Config.show to view the entire nested hash.

Constant Summary collapse

@@config = 
{}
@@instrumentation = 
[:action_controller, :action_view, :active_record,
:cassandra, :dalli, :em_http_request, :faraday, :grape, :nethttp,
:memcached, :memcache, :mongo, :moped, :rack, :redis, :resque,
:sequel, :typhoeus]

Class Method Summary collapse

Class Method Details

.[](key) ⇒ Object 



135
136
137
 
# File 'lib/oboe/config.rb', line 135

def self.[](key)
  @@config[key.to_sym]
end

.[]=(key, value) ⇒ Object 



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
 
# File 'lib/oboe/config.rb', line 139

def self.[]=(key, value)
  @@config[key.to_sym] = value

  if key == :sampling_rate
    Oboe.logger.warn 'sampling_rate is not a supported setting for Oboe::Config.  ' \
                     'Please use :sample_rate.'
  end

  if key == :sample_rate
    unless value.is_a?(Integer) || value.is_a?(Float)
      fail 'oboe :sample_rate must be a number between 1 and 1000000 (1m)'
    end

    # Validate :sample_rate value
    unless value.between?(1, 1e6)
      fail 'oboe :sample_rate must be between 1 and 1000000 (1m)'
    end

    # Assure value is an integer
    @@config[key.to_sym] = value.to_i

    Oboe.set_sample_rate(value) if Oboe.loaded
  end

  # Update liboboe if updating :tracing_mode
  if key == :tracing_mode
    Oboe.set_tracing_mode(value) if Oboe.loaded
  end
end

.initialize(_data = {}) ⇒ Object 



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
 
# File 'lib/oboe/config.rb', line 25

def self.initialize(_data = {})
  # Setup default instrumentation values
  @@instrumentation.each do |k|
    @@config[k] = {}
    @@config[k][:enabled] = true
    @@config[k][:collect_backtraces] = false
    @@config[k][:log_args] = true
  end

  # Beta instrumentation disabled by default
  Oboe::Config[:em_http_request][:enabled] = false

  # Set collect_backtraces defaults
  Oboe::Config[:action_controller][:collect_backtraces] = true
  Oboe::Config[:active_record][:collect_backtraces] = true
  Oboe::Config[:action_view][:collect_backtraces] = true
  Oboe::Config[:cassandra][:collect_backtraces] = true
  Oboe::Config[:dalli][:collect_backtraces] = false
  Oboe::Config[:faraday][:collect_backtraces] = false
  Oboe::Config[:grape][:collect_backtraces] = true
  Oboe::Config[:em_http_request][:collect_backtraces] = false
  Oboe::Config[:memcache][:collect_backtraces] = false
  Oboe::Config[:memcached][:collect_backtraces] = false
  Oboe::Config[:mongo][:collect_backtraces] = true
  Oboe::Config[:moped][:collect_backtraces] = true
  Oboe::Config[:nethttp][:collect_backtraces] = true
  Oboe::Config[:redis][:collect_backtraces] = false
  Oboe::Config[:resque][:collect_backtraces] = true
  Oboe::Config[:sequel][:collect_backtraces] = true
  Oboe::Config[:typhoeus][:collect_backtraces] = false

  # Special instrument specific flags
  #
  # :link_workers - associates enqueue operations with the jobs they queue by piggybacking
  #                 an additional argument that is stripped prior to job proecessing
  #                 !!Note: Make sure both the queue side and the Resque workers are instrumented
  #                 or jobs will fail
  #                 (Default: false)
  @@config[:resque][:link_workers] = false

  # Setup an empty host blacklist (see: Oboe::API::Util.blacklisted?)
  @@config[:blacklist] = []

  # Access Key is empty until loaded from config file or env var
  @@config[:access_key] = ''

  # The oboe Ruby client has the ability to sanitize query literals
  # from SQL statements.  By default this is disabled.  Enable to
  # avoid collecting and reporting query literals to TraceView.
  @@config[:sanitize_sql] = false

  # Do Not Trace
  # These two values allow you to configure specific URL patterns to
  # never be traced.  By default, this is set to common static file
  # extensions but you may want to customize this list for your needs.
  #
  # dnt_regexp and dnt_opts is passed to Regexp.new to create
  # a regular expression object.  That is then used to match against
  # the incoming request path.
  #
  # The path string originates from the rack layer and is retrieved
  # as follows:
  #
  #   req = ::Rack::Request.new(env)
  #   path = URI.unescape(req.path)
  #
  # Usage:
  #   Oboe::Config[:dnt_regexp] = "lobster$"
  #   Oboe::Config[:dnt_opts]   = Regexp::IGNORECASE
  #
  # This will ignore all requests that end with the string lobster
  # regardless of case
  #
  # Requests with positive matches (non nil) will not be traced.
  # See lib/oboe/util.rb: Oboe::Util.static_asset?
  #
  @@config[:dnt_regexp] = "\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$"
  @@config[:dnt_opts]   = Regexp::IGNORECASE

  # In Rails, raised exceptions with rescue handlers via
  # <tt>rescue_from</tt> are not reported to the TraceView
  # dashboard by default.  Setting this value to true will
  # report all raised exception regardless.
  @@config[:report_rescued_errors] = false

  if ENV.key?('OPENSHIFT_TRACEVIEW_TLYZER_IP')
    # We're running on OpenShift
    @@config[:tracing_mode] = 'always'
    @@config[:reporter_host] = ENV['OPENSHIFT_TRACEVIEW_TLYZER_IP']
    @@config[:reporter_port] = ENV['OPENSHIFT_TRACEVIEW_TLYZER_PORT']
  else
    # The default configuration
    @@config[:tracing_mode] = 'through'
    @@config[:reporter_host] = '127.0.0.1'
    @@config[:reporter_port] = '7831'
  end

  @@config[:verbose] = ENV.key?('OBOE_GEM_VERBOSE') ? true : false
end

.instrumentation_list ⇒ Object 



169
170
171
 
# File 'lib/oboe/config.rb', line 169

def self.instrumentation_list
  @@instrumentation
end

.merge!(data) ⇒ Object 



131
132
133
 
# File 'lib/oboe/config.rb', line 131

def self.merge!(data)
  self.update!(data)
end

.method_missing(sym, *args) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oboe/config.rb', line 173

def self.method_missing(sym, *args)
  if sym.to_s =~ /(.+)=$/
    self[$1] = args.first
  else
    unless @@config.key?(sym)
      Oboe.logger.warn "[oboe/warn] Unknown method call on Oboe::Config: #{sym}"
    end
    self[sym]
  end
end

.show ⇒ Object

Return the raw nested hash.



21
22
23
 
# File 'lib/oboe/config.rb', line 21

def self.show
  @@config
end

.update!(data) ⇒ Object 



125
126
127
128
129
 
# File 'lib/oboe/config.rb', line 125

def self.update!(data)
  data.each do |key, value|
    self[key] = value
  end
end