Class: PrometheusExporter::Metric::Gauge

Inherits:
Base
  • Object
show all
Defined in:
lib/prometheus_exporter/metric/gauge.rb

Instance Attribute Summary collapse

Attributes inherited from Base

#help, #name

Instance Method Summary collapse

Methods inherited from Base

default_aggregation, default_aggregation=, default_labels, default_labels=, default_prefix, default_prefix=, #from_json, #labels_text, #prefix, #to_prometheus_text

Constructor Details

#initialize(name, help) ⇒ Gauge

Returns a new instance of Gauge.



7
8
9
10
11
12
13
14
 
# File 'lib/prometheus_exporter/metric/gauge.rb', line 7

def initialize(name, help)
  if name.end_with?("_total")
    raise ArgumentError, "The metric name of gauge must not have _total suffix. Given: #{name}"
  end

  super
  reset!
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



5
6
7
 
# File 'lib/prometheus_exporter/metric/gauge.rb', line 5

def data
  @data
end

Instance Method Details

#decrement(labels = {}, value = 1) ⇒ Object 



52
53
54
55
 
# File 'lib/prometheus_exporter/metric/gauge.rb', line 52

def decrement(labels = {}, value = 1)
  @data[labels] ||= 0
  @data[labels] -= value
end

#increment(labels = {}, value = 1) ⇒ Object 



47
48
49
50
 
# File 'lib/prometheus_exporter/metric/gauge.rb', line 47

def increment(labels = {}, value = 1)
  @data[labels] ||= 0
  @data[labels] += value
end

#metric_text ⇒ Object 



20
21
22
 
# File 'lib/prometheus_exporter/metric/gauge.rb', line 20

def metric_text
  @data.map { |labels, value| "#{prefix(@name)}#{labels_text(labels)} #{value}" }.join("\n")
end

#observe(value, labels = {}) ⇒ Object Also known as: set 



36
37
38
39
40
41
42
43
 
# File 'lib/prometheus_exporter/metric/gauge.rb', line 36

def observe(value, labels = {})
  if value.nil?
    data.delete(labels)
  else
    raise ArgumentError, "value must be a number" if !(Numeric === value)
    @data[labels] = value
  end
end

#remove(labels) ⇒ Object 



32
33
34
 
# File 'lib/prometheus_exporter/metric/gauge.rb', line 32

def remove(labels)
  @data.delete(labels)
end

#reset! ⇒ Object 



24
25
26
 
# File 'lib/prometheus_exporter/metric/gauge.rb', line 24

def reset!
  @data = {}
end

#to_h ⇒ Object 



28
29
30
 
# File 'lib/prometheus_exporter/metric/gauge.rb', line 28

def to_h
  @data.dup
end

#type ⇒ Object 



16
17
18
 
# File 'lib/prometheus_exporter/metric/gauge.rb', line 16

def type
  "gauge"
end