Class: Puppet::Util::Metric

Inherits:
Object show all
Includes:
Network::FormatSupport
Defined in:
lib/puppet/util/metric.rb

Overview

A class for handling metrics. This is currently ridiculously hackish.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Network::FormatSupport

included, #mime, #render, #support_format?, #to_json, #to_msgpack

Constructor Details

#initialize(name, label = nil) ⇒ Metric

Returns a new instance of Metric.



39
40
41
42
43
44
45
 
# File 'lib/puppet/util/metric.rb', line 39

def initialize(name,label = nil)
  @name = name.to_s

  @label = label || self.class.labelize(name)

  @values = []
end

Instance Attribute Details

#label ⇒ Object 



9
10
11
 
# File 'lib/puppet/util/metric.rb', line 9

def label
  @label
end

#name ⇒ Object 



9
10
11
 
# File 'lib/puppet/util/metric.rb', line 9

def name
  @name
end

#type ⇒ Object 



9
10
11
 
# File 'lib/puppet/util/metric.rb', line 9

def type
  @type
end

#value ⇒ Object 



9
10
11
 
# File 'lib/puppet/util/metric.rb', line 9

def value
  @value
end

#values ⇒ Object 



53
54
55
 
# File 'lib/puppet/util/metric.rb', line 53

def values
  @values.sort { |a, b| a[1] <=> b[1] }
end

Class Method Details

.from_data_hash(data) ⇒ Object 



12
13
14
15
16
 
# File 'lib/puppet/util/metric.rb', line 12

def self.from_data_hash(data)
  metric = new(data['name'], data['label'])
  metric.values = data['values']
  metric
end

.labelize(name) ⇒ Object

Convert a name into a label.



58
59
60
 
# File 'lib/puppet/util/metric.rb', line 58

def self.labelize(name)
  name.to_s.capitalize.gsub("_", " ")
end

Instance Method Details

#[](name) ⇒ Object

Return a specific value



31
32
33
34
35
36
37
 
# File 'lib/puppet/util/metric.rb', line 31

def [](name)
  if value = @values.find { |v| v[0] == name }
    return value[2]
  else
    return 0
  end
end

#newvalue(name, value, label = nil) ⇒ Object

Raises:

  • (ArgumentError) 


47
48
49
50
51
 
# File 'lib/puppet/util/metric.rb', line 47

def newvalue(name,value,label = nil)
  raise ArgumentError.new("metric name #{name.inspect} is not a string") unless name.is_a? String
  label ||= self.class.labelize(name)
  @values.push [name,label,value]
end

#to_data_hash ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/puppet/util/metric.rb', line 18

def to_data_hash
  {
    'name' => @name,
    'label' => @label,
    'values' => @values
  }
end

#to_pson(*args) ⇒ Object 



26
27
28
 
# File 'lib/puppet/util/metric.rb', line 26

def to_pson(*args)
  to_data_hash.to_pson(*args)
end