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, :nethttp, :memcached,
:memcache, :mongo, :moped, :rack, :redis, :resque]

Class Method Summary collapse

Class Method Details

.[](key) ⇒ Object 



97
98
99
 
# File 'lib/oboe/config.rb', line 97

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

.[]=(key, value) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oboe/config.rb', line 101

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 



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

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[: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

  # 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

  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] = false
end

.instrumentation_list ⇒ Object 



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

def self.instrumentation_list
  @@instrumentation
end

.merge!(data) ⇒ Object 



93
94
95
 
# File 'lib/oboe/config.rb', line 93

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

.method_missing(sym, *args) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oboe/config.rb', line 135

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.



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

def self.show
  @@config
end

.update!(data) ⇒ Object 



87
88
89
90
91
 
# File 'lib/oboe/config.rb', line 87

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