Class: PromMultiProc::Collector

Inherits:
Object
  • Object
show all
Defined in:
lib/prom_multi_proc/collector.rb

Direct Known Subclasses

Counter, Gauge, Histogram, Summary

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, label_keys, writer) ⇒ Collector

Returns a new instance of Collector.



5
6
7
8
9
10
11
12
13
14
 
# File 'lib/prom_multi_proc/collector.rb', line 5

def initialize(name, label_keys, writer)
  @name = name
  @label_keys = label_keys
  @writer = writer
  @metric_methods = (public_methods(false) - %i(
    validate!
    valid_method? valid_label_keys? valid_label_values? valid_value?
    to_msg
  )).map(&:to_s)
end

Instance Attribute Details

#metric_methods ⇒ Object (readonly)

Returns the value of attribute metric_methods.



3
4
5
 
# File 'lib/prom_multi_proc/collector.rb', line 3

def metric_methods
  @metric_methods
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



3
4
5
 
# File 'lib/prom_multi_proc/collector.rb', line 3

def name
  @name
end

Instance Method Details

#to_msg(method, value, labels) ⇒ Object 



47
48
49
50
51
52
 
# File 'lib/prom_multi_proc/collector.rb', line 47

def to_msg(method, value, labels)
  { "name" => name,
    "method" => method,
    "value" => value.to_f,
    "label_values" => labels.values }
end

#valid_label_keys?(labels) ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/prom_multi_proc/collector.rb', line 35

def valid_label_keys?(labels)
  labels.keys == @label_keys
end

#valid_label_values?(labels) ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/prom_multi_proc/collector.rb', line 39

def valid_label_values?(labels)
  labels.values.all? { |v| v.is_a?(String) || v.is_a?(Symbol) }
end

#valid_method?(method) ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/prom_multi_proc/collector.rb', line 31

def valid_method?(method)
  metric_methods.include?(method)
end

#valid_value?(value) ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/prom_multi_proc/collector.rb', line 43

def valid_value?(value)
  value.is_a?(Numeric)
end

#validate!(method, value, labels) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/prom_multi_proc/collector.rb', line 16

def validate!(method, value, labels)
  unless valid_method?(method)
    raise PromMultiProcError.new("Invalid metric method (#{method}): try: #{metric_methods.inspect}")
  end
  unless valid_label_keys?(labels)
    raise PromMultiProcError.new("Invalid label cardinality (#{name}): #{labels.keys.inspect}, need keys: #{@label_keys.inspect}")
  end
  unless valid_label_values?(labels)
    raise PromMultiProcError.new("Invalid label values (#{name}): #{labels.values.inspect}")
  end
  unless valid_value?(value)
    raise PromMultiProcError.new("Invalid value (#{name}): #{value.inspect} (must be numeric)")
  end
end