Module: TraceView

Extended by:
TraceViewBase
Includes:
Oboe_metal
Defined in:
lib/oboe_metal.rb,
lib/joboe_metal.rb,
lib/traceview/api.rb,
lib/traceview/base.rb,
lib/traceview/ruby.rb,
lib/traceview/test.rb,
lib/traceview/util.rb,
lib/traceview/config.rb,
lib/traceview/logger.rb,
lib/traceview/xtrace.rb,
lib/traceview/loading.rb,
lib/traceview/support.rb,
lib/traceview/version.rb,
lib/traceview/api/util.rb,
lib/traceview/inst/curb.rb,
lib/traceview/inst/rack.rb,
lib/traceview/inst/dalli.rb,
lib/traceview/inst/excon.rb,
lib/traceview/inst/mongo.rb,
lib/traceview/inst/moped.rb,
lib/traceview/inst/redis.rb,
lib/traceview/api/logging.rb,
lib/traceview/api/tracing.rb,
lib/traceview/inst/resque.rb,
lib/traceview/inst/sequel.rb,
lib/traceview/api/memcache.rb,
lib/traceview/inst/faraday.rb,
lib/traceview/thread_local.rb,
lib/traceview/api/layerinit.rb,
lib/traceview/api/profiling.rb,
lib/traceview/inst/memcache.rb,
lib/traceview/inst/typhoeus.rb,
lib/traceview/inst/memcached.rb,
lib/traceview/inst/httpclient.rb,
lib/traceview/instrumentation.rb,
lib/traceview/frameworks/grape.rb,
lib/traceview/frameworks/rails.rb,
lib/traceview/frameworks/rails.rb,
lib/traceview/inst/delayed_job.rb,
lib/traceview/inst/rest-client.rb,
lib/traceview/method_profiling.rb,
lib/traceview/inst/bunny-client.rb,
lib/traceview/frameworks/padrino.rb,
lib/traceview/frameworks/sinatra.rb,
lib/traceview/inst/bunny-consumer.rb,
lib/traceview/inst/sidekiq-client.rb,
lib/traceview/inst/sidekiq-worker.rb,
lib/traceview/inst/em-http-request.rb,
lib/traceview/inst/twitter-cassandra.rb,
lib/traceview/frameworks/padrino/templates.rb,
lib/traceview/frameworks/sinatra/templates.rb,
lib/rails/generators/traceview/install_generator.rb,
lib/traceview/frameworks/rails/inst/action_controller.rb,
lib/traceview/frameworks/rails/inst/action_controller2.rb,
lib/traceview/frameworks/rails/inst/action_controller3.rb,
lib/traceview/frameworks/rails/inst/action_controller4.rb,
lib/traceview/frameworks/rails/inst/action_controller5.rb,
lib/traceview/frameworks/rails/inst/action_controller_api.rb,
lib/traceview/frameworks/rails/inst/connection_adapters/mysql.rb,
lib/traceview/frameworks/rails/inst/connection_adapters/utils.rb,
lib/traceview/frameworks/rails/inst/connection_adapters/mysql2.rb,
lib/traceview/frameworks/rails/inst/connection_adapters/utils5x.rb,
lib/traceview/frameworks/rails/inst/connection_adapters/postgresql.rb

Overview

Copyright © 2016 SolarWinds, LLC. All rights reserved.

Defined Under Namespace

Modules: API, Config, Grape, Inst, Loading, MethodProfiling, PadrinoInst, Rails, Ruby, Sinatra, Test, ThreadLocal, Util, Version, XTrace Classes: Event, InstallGenerator, Logger, Rack, Railtie, Reporter, SidekiqClient, SidekiqWorker

Class Attribute Summary collapse

Attributes included from TraceViewBase

#loaded, #reporter

Class Method Summary collapse

Methods included from TraceViewBase

always?, entry_layer?, extended, forking_webserver?, framework?, heroku?, log, never?, passthrough?, pickup_context?, pry!, sample?, set_sample_rate, set_tracing_mode, through?, tracing?, tracing_layer?, tracing_layer_op?

Methods included from ThreadLocal

#thread_local

Methods included from Oboe_metal

#UdpReporter

Class Attribute Details

.logger ⇒ Object

Returns the value of attribute logger.



8
9
10
 
# File 'lib/traceview/logger.rb', line 8

def logger
  @logger
end

Class Method Details

.sample?(opts = {}) ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oboe_metal.rb', line 111

def sample?(opts = {})
  # Return false if no-op mode
  return false unless TraceView.loaded

  # Assure defaults since SWIG enforces Strings
  layer   = opts[:layer]      ? opts[:layer].to_s.strip.freeze : TV_STR_BLANK
  xtrace  = opts[:xtrace]     ? opts[:xtrace].to_s.strip       : TV_STR_BLANK
  tv_meta = opts['X-TV-Meta'] ? opts['X-TV-Meta'].to_s.strip   : TV_STR_BLANK

  rv = TraceView::Context.sampleRequest(layer, xtrace, tv_meta)

  if rv == 0
    if ENV.key?('TRACEVIEW_GEM_TEST')
      # When in test, always trace and don't clear
      # the stored sample rate/source
      TraceView.sample_rate ||= -1
      TraceView.sample_source ||= -1
      true
    else
      TraceView.sample_rate = -1
      TraceView.sample_source = -1
      false
    end
  else
    # liboboe version > 1.3.1 returning a bit masked integer with SampleRate and
    # source embedded
    TraceView.sample_rate = (rv & SAMPLE_RATE_MASK)
    TraceView.sample_source = (rv & SAMPLE_SOURCE_MASK) >> 24
    true
  end
rescue StandardError => e
  TraceView.logger.debug "[oboe/error] sample? error: #{e.inspect}"
  false
end

.set_sample_rate(_rate) ⇒ Object 



167
168
169
170
171
172
 
# File 'lib/oboe_metal.rb', line 167

def set_sample_rate(rate)
  return unless TraceView.loaded

  # Update liboboe with the new SampleRate value
  TraceView::Context.setDefaultSampleRate(rate.to_i)
end

.set_tracing_mode(_mode) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oboe_metal.rb', line 146

def set_tracing_mode(mode)
  return unless TraceView.loaded

  value = mode.to_sym

  case value
  when :never
    TraceView::Context.setTracingMode(OBOE_TRACE_NEVER)

  when :always
    TraceView::Context.setTracingMode(OBOE_TRACE_ALWAYS)

  when :through
    TraceView::Context.setTracingMode(OBOE_TRACE_THROUGH)

  else
    TraceView.logger.fatal "[oboe/error] Invalid tracing mode set: #{mode}"
    TraceView::Context.setTracingMode(OBOE_TRACE_THROUGH)
  end
end

.support_report ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize



22
23
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
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
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/traceview/support.rb', line 22

def self.support_report
  @logger_level = TraceView.logger.level
  TraceView.logger.level = ::Logger::DEBUG

  TraceView.logger.warn '********************************************************'
  TraceView.logger.warn '* BEGIN TraceView Support Report'
  TraceView.logger.warn '*   Please email the output of this report to [email protected]'
  TraceView.logger.warn '********************************************************'
  TraceView.logger.warn "Ruby: #{RUBY_DESCRIPTION}"
  TraceView.logger.warn "$0: #{$0}"
  TraceView.logger.warn "$1: #{$1}" unless $1.nil?
  TraceView.logger.warn "$2: #{$2}" unless $2.nil?
  TraceView.logger.warn "$3: #{$3}" unless $3.nil?
  TraceView.logger.warn "$4: #{$4}" unless $4.nil?
  TraceView.logger.warn "TraceView.loaded == #{TraceView.loaded}"

  using_jruby = defined?(JRUBY_VERSION)
  TraceView.logger.warn "Using JRuby?: #{yesno(using_jruby)}"
  if using_jruby
    TraceView.logger.warn "Joboe Agent Status: #{Java::ComTracelyticsAgent::Agent.getStatus}"
  end

  on_heroku = TraceView.heroku?
  TraceView.logger.warn "On Heroku?: #{yesno(on_heroku)}"
  if on_heroku
    TraceView.logger.warn "TRACEVIEW_URL: #{ENV['TRACEVIEW_URL']}"
  end

  TraceView.logger.warn "TraceView::Ruby defined?: #{yesno(defined?(TraceView::Ruby))}"
  TraceView.logger.warn "TraceView.reporter: #{TraceView.reporter}"

  TraceView.logger.warn '********************************************************'
  TraceView.logger.warn '* Frameworks'
  TraceView.logger.warn '********************************************************'

  using_rails = defined?(::Rails)
  TraceView.logger.warn "Using Rails?: #{yesno(using_rails)}"
  if using_rails
    TraceView.logger.warn "TraceView::Rails loaded?: #{yesno(defined?(::TraceView::Rails))}"
    TraceView.logger.warn "TraceView::Rack middleware loaded?: #{yesno(::Rails.configuration.middleware.include? TraceView::Rack)}"
  end

  using_sinatra = defined?(::Sinatra)
  TraceView.logger.warn "Using Sinatra?: #{yesno(using_sinatra)}"

  using_padrino = defined?(::Padrino)
  TraceView.logger.warn "Using Padrino?: #{yesno(using_padrino)}"

  using_grape = defined?(::Grape)
  TraceView.logger.warn "Using Grape?: #{yesno(using_grape)}"

  TraceView.logger.warn '********************************************************'
  TraceView.logger.warn '* ActiveRecord Adapter'
  TraceView.logger.warn '********************************************************'
  if defined?(::ActiveRecord)
    if defined?(::ActiveRecord::Base.connection.adapter_name)
      TraceView.logger.warn "ActiveRecord adapter: #{::ActiveRecord::Base.connection.adapter_name}"
    end
  else
    TraceView.logger.warn 'No ActiveRecord'
  end

  TraceView.logger.warn '********************************************************'
  TraceView.logger.warn '* TraceView Libraries'
  TraceView.logger.warn '********************************************************'
  files = []
  ['/usr/lib/liboboe*', '/usr/lib64/liboboe*'].each do |d|
    files = Dir.glob(d)
    break if !files.empty?
  end
  if files.empty?
    TraceView.logger.warn 'Error: No liboboe libs!'
  else
    files.each { |f|
      TraceView.logger.warn f
    }
  end

  TraceView.logger.warn '********************************************************'
  TraceView.logger.warn '* TraceView::Config Values'
  TraceView.logger.warn '********************************************************'
  TraceView::Config.show.each { |k,v|
    TraceView.logger.warn "#{k}: #{v}"
  }

  TraceView.logger.warn '********************************************************'
  TraceView.logger.warn '* OS, Platform + Env'
  TraceView.logger.warn '********************************************************'
  TraceView.logger.warn "host_os: " + RbConfig::CONFIG['host_os']
  TraceView.logger.warn "sitearch: " + RbConfig::CONFIG['sitearch']
  TraceView.logger.warn "arch: " + RbConfig::CONFIG['arch']
  TraceView.logger.warn RUBY_PLATFORM
  TraceView.logger.warn "RACK_ENV: #{ENV['RACK_ENV']}"
  TraceView.logger.warn "RAILS_ENV: #{ENV['RAILS_ENV']}" if using_rails

  TraceView.logger.warn '********************************************************'
  TraceView.logger.warn '* Raw __Init KVs'
  TraceView.logger.warn '********************************************************'
  platform_info = TraceView::Util.build_init_report
  platform_info.each { |k,v|
    TraceView.logger.warn "#{k}: #{v}"
  }

  TraceView.logger.warn '********************************************************'
  TraceView.logger.warn '* END TraceView Support Report'
  TraceView.logger.warn '*   Support Email: [email protected]'
  TraceView.logger.warn '*   Support Portal: https://tracelytics.freshdesk.com'
  TraceView.logger.warn '*   Github: https://github.com/tracelytics/ruby-traceview'
  TraceView.logger.warn '********************************************************'

  TraceView.logger.level = @logger_level
  nil
end

.yesno(x) ⇒ Object

yesno

Utility method to translate value/nil to “yes”/“no” strings



17
18
19
 
# File 'lib/traceview/support.rb', line 17

def self.yesno(x)
  x ? 'yes' : 'no'
end