Class: StatsD::Instrument::Expectation

Inherits:
Object
  • Object
show all
Defined in:
lib/statsd/instrument/expectation.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, name:, value: nil, sample_rate: nil, tags: nil, ignore_tags: nil, no_prefix: false, times: 1) ⇒ Expectation

Returns a new instance of Expectation.



38
39
40
41
42
43
44
45
46
 
# File 'lib/statsd/instrument/expectation.rb', line 38

def initialize(type:, name:, value: nil, sample_rate: nil, tags: nil, ignore_tags: nil, no_prefix: false, times: 1)
  @type = type
  @name = StatsD.prefix ? "#{StatsD.prefix}.#{name}" : name unless no_prefix
  @value = normalized_value_for_type(type, value) if value
  @sample_rate = sample_rate
  @tags = StatsD::Instrument::Metric.normalize_tags(tags)
  @ignore_tags = StatsD::Instrument::Metric.normalize_tags(ignore_tags)
  @times = times
end

Instance Attribute Details

#ignore_tags ⇒ Object (readonly)

Returns the value of attribute ignore_tags.



36
37
38
 
# File 'lib/statsd/instrument/expectation.rb', line 36

def ignore_tags
  @ignore_tags
end

#name ⇒ Object

Returns the value of attribute name.



35
36
37
 
# File 'lib/statsd/instrument/expectation.rb', line 35

def name
  @name
end

#sample_rate ⇒ Object

Returns the value of attribute sample_rate.



35
36
37
 
# File 'lib/statsd/instrument/expectation.rb', line 35

def sample_rate
  @sample_rate
end

#tags ⇒ Object

Returns the value of attribute tags.



35
36
37
 
# File 'lib/statsd/instrument/expectation.rb', line 35

def tags
  @tags
end

#times ⇒ Object

Returns the value of attribute times.



35
36
37
 
# File 'lib/statsd/instrument/expectation.rb', line 35

def times
  @times
end

#type ⇒ Object

Returns the value of attribute type.



35
36
37
 
# File 'lib/statsd/instrument/expectation.rb', line 35

def type
  @type
end

#value ⇒ Object

Returns the value of attribute value.



35
36
37
 
# File 'lib/statsd/instrument/expectation.rb', line 35

def value
  @value
end

Class Method Details

.distribution(name, **options) ⇒ Object 



26
27
28
 
# File 'lib/statsd/instrument/expectation.rb', line 26

def distribution(name, **options)
  new(type: :d, name: name, **options)
end

.gauge(name, **options) ⇒ Object 



14
15
16
 
# File 'lib/statsd/instrument/expectation.rb', line 14

def gauge(name, **options)
  new(type: :g, name: name, **options)
end

.histogram(name, **options) ⇒ Object 



30
31
32
 
# File 'lib/statsd/instrument/expectation.rb', line 30

def histogram(name, **options)
  new(type: :h, name: name, **options)
end

.increment(name, **options) ⇒ Object 



6
7
8
 
# File 'lib/statsd/instrument/expectation.rb', line 6

def increment(name, **options)
  new(type: :c, name: name, **options)
end

.key_value(name, **options) ⇒ Object 



22
23
24
 
# File 'lib/statsd/instrument/expectation.rb', line 22

def key_value(name, **options)
  new(type: :kv, name: name, **options)
end

.measure(name, **options) ⇒ Object 



10
11
12
 
# File 'lib/statsd/instrument/expectation.rb', line 10

def measure(name, **options)
  new(type: :ms, name: name, **options)
end

.set(name, **options) ⇒ Object 



18
19
20
 
# File 'lib/statsd/instrument/expectation.rb', line 18

def set(name, **options)
  new(type: :s, name: name, **options)
end

Instance Method Details

#inspect ⇒ Object 



87
88
89
 
# File 'lib/statsd/instrument/expectation.rb', line 87

def inspect
  "#<StatsD::Instrument::Expectation:\"#{self}\">"
end

#matches(actual_metric) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/statsd/instrument/expectation.rb', line 57

def matches(actual_metric)
  return false if sample_rate && sample_rate != actual_metric.sample_rate
  return false if value && value != normalized_value_for_type(actual_metric.type, actual_metric.value)

  if tags
    expected_tags = Set.new(tags)
    actual_tags = Set.new(actual_metric.tags)

    if ignore_tags
      ignored_tags = Set.new(ignore_tags) - expected_tags
      actual_tags -= ignored_tags

      if ignore_tags.is_a?(Array)
        actual_tags.delete_if { |key| ignore_tags.include?(key.split(":").first) }
      end
    end

    return expected_tags.subset?(actual_tags)
  end
  true
end

#normalized_value_for_type(type, value) ⇒ Object 



48
49
50
51
52
53
54
55
 
# File 'lib/statsd/instrument/expectation.rb', line 48

def normalized_value_for_type(type, value)
  case type
  when :c then Integer(value)
  when :g, :h, :d, :kv, :ms then Float(value)
  when :s then String(value)
  else value
  end
end

#to_s ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/statsd/instrument/expectation.rb', line 79

def to_s
  str = +"#{name}:#{value || '<anything>'}|#{type}"
  str << "|@#{sample_rate}" if sample_rate
  str << "|#" << tags.join(',') if tags
  str << " (expected #{times} times)" if times > 1
  str
end