Module: OneApm::Coerce

Included in:
Agent::JavascriptInstrumentor, Agent::Threading::BacktraceNode, Agent::Threading::ThreadProfile, OneApm::Collector::CustomEventAggregator, OneApm::Collector::SqlTrace, OneApm::Collector::TransactionEventAggregator, EventAnalyticData, EventAnalyticSample, MetricData, NoticedError, TransactionSample, TransactionSample::Segment
Defined in:
lib/one_apm/support/coerce.rb

Overview

We really don’t want to send bad values to the collector, and it doesn’t accept types like Rational that have occasionally slipped into our data.

These methods are intended to safely coerce things into the form we want, to provide documentation of expected types on to_collector_array methods, and to log failures if totally invalid data gets into outgoing data

Instance Method Summary collapse

Instance Method Details

#event_params(value, context = nil) ⇒ Object

Convert a hash into a format acceptable to be included with Transaction event data.

We accept a hash and will return a new hash where all of the keys have been converted to strings. As values we only allow Strings, Floats, Integers. Symbols are also allowed but are converted to strings. Any values of other type (e.g. Hash, Array, any other class) are discarded. Their keys are also removed from the results hash.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/one_apm/support/coerce.rb', line 51

def event_params(value, context=nil)
  unless value.is_a? Hash
    raise ArgumentError, "Expected Hash but got #{value.class}"
  end
  value.inject({}) do |memo, (key, val)|
    case val
    when String, Integer, TrueClass, FalseClass
      memo[key.to_s] = val
    when Float
      if val.finite?
        memo[key.to_s] = val
      else
        memo[key.to_s] = nil
      end
    when Symbol
      memo[key.to_s] = val.to_s
    end
    memo
  end
rescue => error
  log_failure(value.class, 'valid event params', context, error)
  {}
end

#float(value, context = nil) ⇒ Object 



26
27
28
29
30
31
32
33
 
# File 'lib/one_apm/support/coerce.rb', line 26

def float(value, context=nil)
  result = Float(value)
  raise "Value #{result.inspect} is not finite." unless result.finite?
  result
rescue => error
  log_failure(value, Float, context, error)
  0.0
end

#int(value, context = nil) ⇒ Object 



11
12
13
14
15
16
 
# File 'lib/one_apm/support/coerce.rb', line 11

def int(value, context=nil)
  Integer(value)
rescue => error
  log_failure(value, Integer, context, error)
  0
end

#int_or_nil(value, context = nil) ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/one_apm/support/coerce.rb', line 18

def int_or_nil(value, context=nil)
  return nil if value.nil?
  Integer(value)
rescue => error
  log_failure(value, Integer, context, error)
  nil
end

#log_failure(value, type, context, error) ⇒ Object 



75
76
77
78
79
 
# File 'lib/one_apm/support/coerce.rb', line 75

def log_failure(value, type, context, error)
  msg = "Unable to convert '#{value}' to #{type}"
  msg += " in context '#{context}'" if context
  OneApm::Manager.logger.warn(msg, error)
end

#string(value, context = nil) ⇒ Object 



35
36
37
38
39
40
41
 
# File 'lib/one_apm/support/coerce.rb', line 35

def string(value, context=nil)
  return value if value.nil?
  String(value)
rescue => error
  log_failure(value.class, String, context, error)
  ""
end