Module: TraceView::Util

Defined in:
lib/traceview/util.rb,
lib/traceview/loading.rb

Overview

Provides utility methods for use while in the business of instrumenting code

Defined Under Namespace

Modules: Base64URL

Class Method Summary collapse

Class Method Details

.build_init_report ⇒ Object

build_init_report

Internal: Build a hash of KVs that reports on the status of the running environment. This is used on stack boot in __Init reporting and for TraceView.support_report.

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/traceview/util.rb', line 254

def build_init_report
  platform_info = { '__Init' => 1 }

  begin
    platform_info['Force']                        = true
    platform_info['Ruby.Platform.Version']        = RUBY_PLATFORM
    platform_info['Ruby.Version']                 = RUBY_VERSION
    platform_info['Ruby.TraceView.Version']       = ::TraceView::Version::STRING
    platform_info['RubyHeroku.TraceView.Version'] = ::TraceViewHeroku::Version::STRING if defined?(::TraceViewHeroku)
    platform_info['Ruby.TraceMode.Version']       = ::TraceView::Config[:tracing_mode]

    # Collect up the loaded gems
    if defined?(Gem) && Gem.respond_to?(:loaded_specs)
      Gem.loaded_specs.each_pair { |k, v|
        platform_info["Ruby.#{k}.Version"] = v.version.to_s
      }
    else
      platform_info.merge!(legacy_build_init_report)
    end

    # Report the server in use (if possible)
    if defined?(::Unicorn::Const::UNICORN_VERSION)
      platform_info['Ruby.AppContainer.Version'] = "Unicorn-#{::Unicorn::Const::UNICORN_VERSION}"
    elsif defined?(::Puma::Const::PUMA_VERSION)
      platform_info['Ruby.AppContainer.Version'] = "Puma-#{::Puma::Const::PUMA_VERSION} (#{::Puma::Const::CODE_NAME})"
    elsif defined?(::PhusionPassenger::PACKAGE_NAME)
      platform_info['Ruby.AppContainer.Version'] = "#{::PhusionPassenger::PACKAGE_NAME}-#{::PhusionPassenger::VERSION_STRING}"
    elsif defined?(::Thin::VERSION::STRING)
      platform_info['Ruby.AppContainer.Version'] = "Thin-#{::Thin::VERSION::STRING} (#{::Thin::VERSION::CODENAME})"
    elsif defined?(::Mongrel::Const::MONGREL_VERSION)
      platform_info['Ruby.AppContainer.Version'] = "Mongrel-#{::Mongrel::Const::MONGREL_VERSION}"
    elsif defined?(::Mongrel2::VERSION)
      platform_info['Ruby.AppContainer.Version'] = "Mongrel2-#{::Mongrel2::VERSION}"
    elsif defined?(::Trinidad::VERSION)
      platform_info['Ruby.AppContainer.Version'] = "Trinidad-#{::Trinidad::VERSION}"
    elsif defined?(::WEBrick::VERSION)
      platform_info['Ruby.AppContainer.Version'] = "WEBrick-#{::WEBrick::VERSION}"
    else
      platform_info['Ruby.AppContainer.Version'] = File.basename($PROGRAM_NAME)
    end

  rescue StandardError, ScriptError => e
    # Also rescue ScriptError (aka SyntaxError) in case one of the expected
    # version defines don't exist

    platform_info['Error'] = "Error in build_report: #{e.message}"

    TraceView.logger.warn "[traceview/warn] Error in build_init_report: #{e.message}"
    TraceView.logger.debug e.backtrace
  end
  platform_info
end

.class_method_alias(cls, method, name = nil) ⇒ Object

class_method_alias

Centralized utility method to alias a class method on an arbitrary class or module



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/traceview/util.rb', line 60

def class_method_alias(cls, method, name = nil)
  name ||= contextual_name(cls)

  if cls.singleton_methods.include? method.to_sym

    # Strip '!' or '?' from method if present
    safe_method_name = method.to_s.chop if method.to_s =~ /\?$|\!$/
    safe_method_name ||= method

    without_traceview = "#{safe_method_name}_without_traceview"
    with_traceview    = "#{safe_method_name}_with_traceview"

    # Only alias if we haven't done so already
    unless cls.singleton_methods.include? without_traceview.to_sym
      cls.singleton_class.send(:alias_method, without_traceview, method.to_s)
      cls.singleton_class.send(:alias_method, method.to_s, with_traceview)
    end
  else TraceView.logger.warn "[traceview/loading] Couldn't properly instrument #{name}.  Partial traces may occur."
  end
end

.contextual_name(cls) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/traceview/util.rb', line 10

def contextual_name(cls)
  # Attempt to infer a contextual name if not indicated
  #
  # For example:
  # ::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.to_s.split(/::/).last
  # => "AbstractMysqlAdapter"
  #
  cls.to_s.split(/::/).last
rescue
  cls
end

.legacy_build_init_report ⇒ Object

legacy_build_init_report

Internal: Build a hash of KVs that reports on the status of the running environment. This is used on stack boot in __Init reporting and for TraceView.support_report.

This legacy version of build_init_report is used for apps without Bundler.

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/traceview/util.rb', line 182

def legacy_build_init_report
  platform_info = {}

  begin
    # Report the framework in use
    if defined?(::RailsLts::VERSION)
      platform_info['Ruby.RailsLts.Version']  = "RailsLts-#{::RailsLts::VERSION}"
    elsif defined?(::Rails.version)
      platform_info['Ruby.Rails.Version']     = "Rails-#{::Rails.version}"
    end
    platform_info['Ruby.Grape.Version']       = "Grape-#{::Grape::VERSION}" if defined?(::Grape::VERSION)
    platform_info['Ruby.Cramp.Version']       = "Cramp-#{::Cramp::VERSION}" if defined?(::Cramp::VERSION)

    if defined?(::Padrino::VERSION)
      platform_info['Ruby.Padrino.Version']   = "Padrino-#{::Padrino::VERSION}"
    elsif defined?(::Sinatra::VERSION)
      platform_info['Ruby.Sinatra.Version']   = "Sinatra-#{::Sinatra::VERSION}"
    end

    # Report the instrumented libraries
    platform_info['Ruby.Cassandra.Version']  = "Cassandra-#{::Cassandra.VERSION}"    if defined?(::Cassandra.VERSION)
    platform_info['Ruby.Curb.Version']       = "Curb-#{::Curl::VERSION}"             if defined?(::Curl::VERSION)
    platform_info['Ruby.Dalli.Version']      = "Dalli-#{::Dalli::VERSION}"           if defined?(::Dalli::VERSION)
    platform_info['Ruby.Excon.Version']      = "Excon-#{::Excon::VERSION}"           if defined?(::Excon::VERSION)
    platform_info['Ruby.Faraday.Version']    = "Faraday-#{::Faraday::VERSION}"       if defined?(::Faraday::VERSION)
    platform_info['Ruby.HTTPClient.Version'] = "HTTPClient-#{::HTTPClient::VERSION}" if defined?(::HTTPClient::VERSION)
    platform_info['Ruby.MemCache.Version']   = "MemCache-#{::MemCache::VERSION}"     if defined?(::MemCache::VERSION)
    platform_info['Ruby.Moped.Version']      = "Moped-#{::Moped::VERSION}"           if defined?(::Moped::VERSION)
    platform_info['Ruby.Redis.Version']      = "Redis-#{::Redis::VERSION}"           if defined?(::Redis::VERSION)
    platform_info['Ruby.Resque.Version']     = "Resque-#{::Resque::VERSION}"         if defined?(::Resque::VERSION)
    platform_info['Ruby.RestClient.Version'] = "RestClient-#{::RestClient::VERSION}" if defined?(::RestClient::VERSION)
    platform_info['Ruby.Sidekiq.Version']    = "Sidekiq-#{::Sidekiq::VERSION}"       if defined?(::Sidekiq::VERSION)
    platform_info['Ruby.Typhoeus.Version']   = "Typhoeus-#{::Typhoeus::VERSION}"     if defined?(::Typhoeus::VERSION)

    if Gem.loaded_specs.key?('delayed_job')
      # Oddly, DelayedJob doesn't have an embedded version number so we get it from the loaded
      # gem specs.
      version = Gem.loaded_specs['delayed_job'].version.to_s
      platform_info['Ruby.DelayedJob.Version']       = "DelayedJob-#{version}"
    end

    # Special case since the Mongo 1.x driver doesn't embed the version number in the gem directly
    if ::Gem.loaded_specs.key?('mongo')
      platform_info['Ruby.Mongo.Version']     = "Mongo-#{::Gem.loaded_specs['mongo'].version}"
    end

    # Report the DB adapter in use
    platform_info['Ruby.Mysql.Version']   = Mysql::GemVersion::VERSION   if defined?(Mysql::GemVersion::VERSION)
    platform_info['Ruby.PG.Version']      = PG::VERSION                  if defined?(PG::VERSION)
    platform_info['Ruby.Mysql2.Version']  = Mysql2::VERSION              if defined?(Mysql2::VERSION)
    platform_info['Ruby.Sequel.Version']  = ::Sequel::VERSION            if defined?(::Sequel::VERSION)
  rescue StandardError, ScriptError => e
    # Also rescue ScriptError (aka SyntaxError) in case one of the expected
    # version defines don't exist

    platform_info['Error'] = "Error in legacy_build_init_report: #{e.message}"

    TraceView.logger.warn "[traceview/warn] Error in legacy_build_init_report: #{e.message}"
    TraceView.logger.debug e.backtrace
  end
  platform_info
end

.method_alias(cls, method, name = nil) ⇒ Object

method_alias

Centralized utility method to alias a method on an arbitrary class or module.



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
 
# File 'lib/traceview/util.rb', line 28

def method_alias(cls, method, name = nil)
  name ||= contextual_name(cls)

  if cls.method_defined?(method.to_sym) || cls.private_method_defined?(method.to_sym)

    # Strip '!' or '?' from method if present
    safe_method_name = method.to_s.chop if method.to_s =~ /\?$|\!$/
    safe_method_name ||= method

    without_traceview = "#{safe_method_name}_without_traceview"
    with_traceview    = "#{safe_method_name}_with_traceview"

    # Only alias if we haven't done so already
    unless cls.method_defined?(without_traceview.to_sym) ||
      cls.private_method_defined?(without_traceview.to_sym)

      cls.class_eval do
        alias_method without_traceview, method.to_s
        alias_method method.to_s, with_traceview
      end
    end
  else
    TraceView.logger.warn "[traceview/loading] Couldn't properly instrument #{name}.#{method}.  Partial traces may occur."
  end
end

.prettify(x) ⇒ Object

prettify

Even to my surprise, ‘prettify’ is a real word: transitive v. To make pretty or prettier, especially in a superficial or insubstantial way.

from The American Heritage Dictionary of the English Language, 4th Edition

This method makes things ‘purty’ for reporting.



117
118
119
120
121
122
123
 
# File 'lib/traceview/util.rb', line 117

def prettify(x)
  if (x.to_s =~ /^#</) == 0
    x.class.to_s
  else
    x.to_s
  end
end

.sanitize_sql(sql) ⇒ Object

sanitize_sql

Used to remove query literals from SQL. Used by all DB adapter instrumentation.

The regular expression passed to String.gsub is configurable via TraceView::Config and TraceView::Config.



165
166
167
168
169
170
 
# File 'lib/traceview/util.rb', line 165

def sanitize_sql(sql)
  return sql unless TraceView::Config[:sanitize_sql]

  regexp = Regexp.new(TraceView::Config[:sanitize_sql_regexp], TraceView::Config[:sanitize_sql_opts])
  sql.gsub(regexp, '?')
end

.send_extend(target_cls, cls) ⇒ Object

send_extend

Centralized utility method to send an extend call for an arbitrary class



86
87
88
 
# File 'lib/traceview/util.rb', line 86

def send_extend(target_cls, cls)
  target_cls.send(:extend, cls) if defined?(target_cls)
end

.send_include(target_cls, cls) ⇒ Object

send_include

Centralized utility method to send a include call for an arbitrary class



95
96
97
 
# File 'lib/traceview/util.rb', line 95

def send_include(target_cls, cls)
  target_cls.send(:include, cls) if defined?(target_cls)
end

.static_asset?(path) ⇒ Boolean

static_asset?

Given a path, this method determines whether it is a static asset or not (based solely on filename)

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/traceview/util.rb', line 105

def static_asset?(path)
  (path =~ Regexp.new(TraceView::Config[:dnt_regexp], TraceView::Config[:dnt_opts]))
end

.to_query(h) ⇒ Object

to_query

Used to convert a hash into a URL # query.



146
147
148
149
150
151
152
153
 
# File 'lib/traceview/util.rb', line 146

def to_query(h)
  return '' unless h.is_a?(Hash)

  result = []

  h.each { |k, v| result.push(k.to_s + '=' + v.to_s) }
  result.sort.join('&')
end

.upcase(o) ⇒ Object

upcase

Occasionally, we want to send some values in all caps. This is true for things like HTTP scheme or method. This takes anything and does it’s best to safely convert it to a string (if needed) and convert it to all uppercase.



132
133
134
135
136
137
138
139
 
# File 'lib/traceview/util.rb', line 132

def upcase(o)
  if o.is_a?(String) || o.respond_to?(:to_s)
    o.to_s.upcase
  else
    TraceView.logger.debug "[traceview/debug] TraceView::Util.upcase: could not convert #{o.class}"
    'UNKNOWN'
  end
end