Class: StatsD::Instrument::Expectation

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

Defined Under Namespace

Modules: RubyBackports

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client: StatsD.singleton_client, type:, name:, value: nil, sample_rate: nil, tags: nil, no_prefix: false, times: 1) ⇒ Expectation

Returns a new instance of Expectation.



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/statsd/instrument/expectation.rb', line 33

def initialize(client: StatsD.singleton_client, type:, name:, value: nil,
  sample_rate: nil, tags: nil, no_prefix: false, times: 1)

  @type = type
  @name = client.prefix ? "#{client.prefix}.#{name}" : name unless no_prefix
  @value = normalized_value_for_type(type, value) if value
  @sample_rate = sample_rate
  @tags = normalize_tags(tags)
  @times = times
end

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#sample_rate ⇒ Object

Returns the value of attribute sample_rate.



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

def sample_rate
  @sample_rate
end

#tags ⇒ Object

Returns the value of attribute tags.



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

def tags
  @tags
end

#times ⇒ Object

Returns the value of attribute times.



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

def times
  @times
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#value ⇒ Object

Returns the value of attribute value.



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

def value
  @value
end

Class Method Details

.distribution(name, value = nil, **options) ⇒ Object 



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

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

.gauge(name, value = nil, **options) ⇒ Object 



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

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

.histogram(name, value = nil, **options) ⇒ Object 



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

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

.increment(name, value = nil, **options) ⇒ Object 



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

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

.measure(name, value = nil, **options) ⇒ Object 



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

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

.set(name, value = nil, **options) ⇒ Object 



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

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

Instance Method Details

#inspect ⇒ Object 



73
74
75
 
# File 'lib/statsd/instrument/expectation.rb', line 73

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

#matches(actual_metric) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/statsd/instrument/expectation.rb', line 53

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)
    return expected_tags.subset?(actual_tags)
  end
  true
end

#normalized_value_for_type(type, value) ⇒ Object 



44
45
46
47
48
49
50
51
 
# File 'lib/statsd/instrument/expectation.rb', line 44

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 



65
66
67
68
69
70
71
 
# File 'lib/statsd/instrument/expectation.rb', line 65

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