Class: Puppet::Util::Metric

Inherits:
Object show all
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

Constructor Details

#initialize(name, label = nil) ⇒ Metric

Returns a new instance of Metric.



128
129
130
131
132
133
134
 
# File 'lib/puppet/util/metric.rb', line 128

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

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

  @values = []
end

Instance Attribute Details

#basedir ⇒ Object 



27
28
29
30
31
32
33
 
# File 'lib/puppet/util/metric.rb', line 27

def basedir
  if defined?(@basedir)
    @basedir
  else
    Puppet[:rrddir]
  end
end

#label ⇒ Object

Returns the value of attribute label.



7
8
9
 
# File 'lib/puppet/util/metric.rb', line 7

def label
  @label
end

#name ⇒ Object

Returns the value of attribute name.



7
8
9
 
# File 'lib/puppet/util/metric.rb', line 7

def name
  @name
end

#type ⇒ Object

Returns the value of attribute type.



7
8
9
 
# File 'lib/puppet/util/metric.rb', line 7

def type
  @type
end

#value ⇒ Object

Returns the value of attribute value.



7
8
9
 
# File 'lib/puppet/util/metric.rb', line 7

def value
  @value
end

#values ⇒ Object 



179
180
181
 
# File 'lib/puppet/util/metric.rb', line 179

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

Class Method Details

.from_pson(data) ⇒ Object 



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

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

.labelize(name) ⇒ Object

Convert a name into a label.



184
185
186
 
# File 'lib/puppet/util/metric.rb', line 184

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

Instance Method Details

#[](name) ⇒ Object

Return a specific value



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

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

#create(start = nil) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/puppet/util/metric.rb', line 35

def create(start = nil)
  Puppet.settings.use(:main, :metrics)

  start ||= Time.now.to_i - 5

  args = []

  if Puppet.features.rrd_legacy? && ! Puppet.features.rrd?
    @rrd = RRDtool.new(self.path)
  end

  values.each { |value|
    # the 7200 is the heartbeat -- this means that any data that isn't
    # more frequently than every two hours gets thrown away
    args.push "DS:#{value[0]}:GAUGE:7200:U:U"
  }
  args.push "RRA:AVERAGE:0.5:1:300"

  begin
    if Puppet.features.rrd_legacy? && ! Puppet.features.rrd?
      @rrd.create( Puppet[:rrdinterval].to_i, start, args)
    else
      RRD.create( self.path, '-s', Puppet[:rrdinterval].to_i.to_s, '-b', start.to_i.to_s, *args)
    end
  rescue => detail
    raise "Could not create RRD file #{path}: #{detail}"
  end
end

#dump ⇒ Object 



64
65
66
67
68
69
70
 
# File 'lib/puppet/util/metric.rb', line 64

def dump
  if Puppet.features.rrd_legacy? && ! Puppet.features.rrd?
    puts @rrd.info
  else
    puts RRD.info(self.path)
  end
end

#graph(range = nil) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/puppet/util/metric.rb', line 72

def graph(range = nil)
  unless Puppet.features.rrd? || Puppet.features.rrd_legacy?
    Puppet.warning "RRD library is missing; cannot graph metrics"
    return
  end

  unit = 60 * 60 * 24
  colorstack = %w{#00ff00 #ff0000 #0000ff #ffff00 #ff99ff #ff9966 #66ffff #990000 #099000 #000990 #f00990 #0f0f0f #555555 #333333 #ffffff}

  {:daily => unit, :weekly => unit * 7, :monthly => unit * 30, :yearly => unit * 365}.each do |name, time|
    file = self.path.sub(/\.rrd$/, "-#{name}.png")
    args = [file]

    args.push("--title",self.label)
    args.push("--imgformat","PNG")
    args.push("--interlace")
    i = 0
    defs = []
    lines = []
    #p @values.collect { |s,l| s }
    values.zip(colorstack).each { |value,color|
      next if value.nil?
      # this actually uses the data label
      defs.push("DEF:#{value[0]}=#{self.path}:#{value[0]}:AVERAGE")
      lines.push("LINE2:#{value[0]}#{color}:#{value[1]}")
    }
    args << defs
    args << lines
    args.flatten!
    if range
      if Puppet.features.rrd_legacy? && ! Puppet.features.rrd?
        args.push("--start",range[0],"--end",range[1])
      else
        args.push("--start",range[0].to_i.to_s,"--end",range[1].to_i.to_s)
      end
    else
      if Puppet.features.rrd_legacy? && ! Puppet.features.rrd?
        args.push("--start", Time.now.to_i - time, "--end", Time.now.to_i)
      else
        args.push("--start", (Time.now.to_i - time).to_s, "--end", Time.now.to_i.to_s)
      end
    end

    begin
      #Puppet.warning "args = #{args}"
      if Puppet.features.rrd_legacy? && ! Puppet.features.rrd?
        RRDtool.graph( args )
      else
        RRD.graph( *args )
      end
    rescue => detail
      Puppet.err "Failed to graph #{self.name}: #{detail}"
    end
  end
end

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

Raises:

  • (ArgumentError) 


140
141
142
143
144
 
# File 'lib/puppet/util/metric.rb', line 140

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

#path ⇒ Object 



136
137
138
 
# File 'lib/puppet/util/metric.rb', line 136

def path
  File.join(self.basedir, @name + ".rrd")
end

#store(time) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/puppet/util/metric.rb', line 146

def store(time)
  unless Puppet.features.rrd? || Puppet.features.rrd_legacy?
    Puppet.warning "RRD library is missing; cannot store metrics"
    return
  end
  self.create(time - 5) unless FileTest.exists?(self.path)

  if Puppet.features.rrd_legacy? && ! Puppet.features.rrd?
    @rrd ||= RRDtool.new(self.path)
  end

  # XXX this is not terribly error-resistant
  args = [time]
  temps = []
  values.each { |value|
    #Puppet.warning "value[0]: #{value[0]}; value[1]: #{value[1]}; value[2]: #{value[2]}; "
    args.push value[2]
    temps.push value[0]
  }
  arg = args.join(":")
  template = temps.join(":")
  begin
    if Puppet.features.rrd_legacy? && ! Puppet.features.rrd?
      @rrd.update( template, [ arg ] )
    else
      RRD.update( self.path, '-t', template, arg )
    end
    #system("rrdtool updatev #{self.path} '#{arg}'")
  rescue => detail
    raise Puppet::Error, "Failed to update #{self.name}: #{detail}"
  end
end