Class: Puppet::Util::Log

Inherits:
Object show all
Extended by:
Puppet::Util, ClassGen
Includes:
Network::FormatSupport, Puppet::Util, PsychSupport, Tagging
Defined in:
lib/puppet/util/log.rb

Overview

Pass feedback to the user. Log levels are modeled after syslog's, and it is expected that that will be the most common log destination. Supports multiple destinations, one of which is a remote server.

Defined Under Namespace

Classes: Destination

Constant Summary

Constants included from Puppet::Util

ALNUM, ALPHA, AbsolutePathPosix, AbsolutePathWindows, DEFAULT_POSIX_MODE, DEFAULT_WINDOWS_MODE, ESCAPED, HEX, HttpProxy, PUPPET_STACK_INSERTION_FRAME, RESERVED, RFC_3986_URI_REGEX, UNRESERVED, UNSAFE

Constants included from POSIX

POSIX::LOCALE_ENV_VARS, POSIX::USER_ENV_VARS

Constants included from SymbolicFileMode

SymbolicFileMode::SetGIDBit, SymbolicFileMode::SetUIDBit, SymbolicFileMode::StickyBit, SymbolicFileMode::SymbolicMode, SymbolicFileMode::SymbolicSpecialToBit

Constants included from Tagging

Tagging::ValidTagRegex

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Puppet::Util

absolute_path?, benchmark, chuser, clear_environment, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, format_backtrace_array, format_puppetstack_frame, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, resolve_stackframe, rfc2396_escape, safe_posix_fork, set_env, skip_external_facts, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, uri_unescape, which, withenv, withumask

Methods included from POSIX

#get_posix_field, #gid, groups_of, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from SymbolicFileMode

#display_mode, #normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from ClassGen

genclass, genmodule, rmclass

Methods included from Network::FormatSupport

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

Methods included from Tagging

#merge_into, #merge_tags_from, #raw_tagged?, #set_tags, #tag, #tag_if_valid, #tagged?, #tags, #tags=, #valid_tag?

Methods included from PsychSupport

#encode_with, #init_with

Constructor Details

#initialize(args) ⇒ Log

Returns a new instance of Log.


295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/puppet/util/log.rb', line 295

def initialize(args)
  self.level = args[:level]
  self.message = args[:message]
  self.source = args[:source] || "Puppet"

  @time = Time.now

  tags = args[:tags]
  if tags
    tags.each { |t| self.tag(t) }
  end

  # Don't add these unless defined (preserve 3.x API as much as possible)
  [:file, :line, :pos, :issue_code, :environment, :node, :backtrace].each do |attr|
    value = args[attr]
    next unless value
    send(attr.to_s + '=', value)
  end

  Log.newmessage(self)
end

Class Attribute Details

.desttypes ⇒ Object (readonly)

Returns the value of attribute desttypes.


48
49
50
 
# File 'lib/puppet/util/log.rb', line 48

def desttypes
  @desttypes
end

Instance Attribute Details

#backtrace ⇒ Object

Returns the value of attribute backtrace.


292
293
294
 
# File 'lib/puppet/util/log.rb', line 292

def backtrace
  @backtrace
end

#environment ⇒ Object

Returns the value of attribute environment.


292
293
294
 
# File 'lib/puppet/util/log.rb', line 292

def environment
  @environment
end

#file ⇒ Object

Returns the value of attribute file.


292
293
294
 
# File 'lib/puppet/util/log.rb', line 292

def file
  @file
end

#issue_code ⇒ Object

Returns the value of attribute issue_code.


292
293
294
 
# File 'lib/puppet/util/log.rb', line 292

def issue_code
  @issue_code
end

#level ⇒ Object

Returns the value of attribute level.


293
294
295
 
# File 'lib/puppet/util/log.rb', line 293

def level
  @level
end

#line ⇒ Object

Returns the value of attribute line.


292
293
294
 
# File 'lib/puppet/util/log.rb', line 292

def line
  @line
end

#message ⇒ Object

Returns the value of attribute message.


293
294
295
 
# File 'lib/puppet/util/log.rb', line 293

def message
  @message
end

#node ⇒ Object

Returns the value of attribute node.


292
293
294
 
# File 'lib/puppet/util/log.rb', line 292

def node
  @node
end

#pos ⇒ Object

Returns the value of attribute pos.


292
293
294
 
# File 'lib/puppet/util/log.rb', line 292

def pos
  @pos
end

#remote ⇒ Object

Returns the value of attribute remote.


292
293
294
 
# File 'lib/puppet/util/log.rb', line 292

def remote
  @remote
end

#source ⇒ Object

Returns the value of attribute source.


292
293
294
 
# File 'lib/puppet/util/log.rb', line 292

def source
  @source
end

#time ⇒ Object

Returns the value of attribute time.


292
293
294
 
# File 'lib/puppet/util/log.rb', line 292

def time
  @time
end

Class Method Details

.autoflush=(v) ⇒ Object 


76
77
78
79
80
 
# File 'lib/puppet/util/log.rb', line 76

def Log.autoflush=(v)
  @destinations.each do |type, dest|
    dest.autoflush = v if dest.respond_to?(:autoflush=)
  end
end

.close(destination) ⇒ Object

Reset log to basics. Basically just flushes and closes files and undefs other objects.


53
54
55
56
57
58
59
 
# File 'lib/puppet/util/log.rb', line 53

def Log.close(destination)
  if @destinations.include?(destination)
    @destinations[destination].flush if @destinations[destination].respond_to?(:flush)
    @destinations[destination].close if @destinations[destination].respond_to?(:close)
    @destinations.delete(destination)
  end
end

.close_all ⇒ Object

Raises:


61
62
63
64
65
66
67
 
# File 'lib/puppet/util/log.rb', line 61

def self.close_all
  @destinations.keys.each { |dest|
    close(dest)
  }
  #TRANSLATORS "Log.close_all" is a method name and should not be translated
  raise Puppet::DevError.new(_("Log.close_all failed to close %{destinations}") % { destinations: @destinations.keys.inspect }) if !@destinations.empty?
end

.create(hash) ⇒ Object

Create a new log message. The primary role of this method is to avoid creating log messages below the loglevel.

Raises:


84
85
86
87
88
 
# File 'lib/puppet/util/log.rb', line 84

def Log.create(hash)
  raise Puppet::DevError, _("Logs require a level") unless hash.include?(:level)
  raise Puppet::DevError, _("Invalid log level %{level}") % { level: hash[:level] } unless @levels.index(hash[:level])
  @levels.index(hash[:level]) >= @loglevel ? Puppet::Util::Log.new(hash) : nil
end

.destinations ⇒ Object 


90
91
92
 
# File 'lib/puppet/util/log.rb', line 90

def Log.destinations
  @destinations
end

.eachlevel ⇒ Object

Yield each valid level in turn


95
96
97
 
# File 'lib/puppet/util/log.rb', line 95

def Log.eachlevel
  @levels.each { |level| yield level }
end

.flush ⇒ Object

Flush any log destinations that support such operations.


70
71
72
73
74
 
# File 'lib/puppet/util/log.rb', line 70

def Log.flush
  @destinations.each { |type, dest|
    dest.flush if dest.respond_to?(:flush)
  }
end

.flushqueue ⇒ Object 


203
204
205
206
207
208
209
 
# File 'lib/puppet/util/log.rb', line 203

def Log.flushqueue
  return unless @destinations.size >= 1
  @queued.each do |msg|
    Log.newmessage(msg)
  end
  @queued.clear
end

.force_flushqueue ⇒ Object

Flush the logging queue. If there are no destinations available,

adds in a console logger before flushing the queue.

This is mainly intended to be used as a last-resort attempt

to ensure that logging messages are not thrown away before
the program is about to exit--most likely in a horrific
error scenario.

Returns:

  • nil


218
219
220
221
222
223
 
# File 'lib/puppet/util/log.rb', line 218

def Log.force_flushqueue()
  if (@destinations.empty? and !(@queued.empty?))
    newdestination(:console)
  end
  flushqueue
end

.from_data_hash(data) ⇒ Object 


261
262
263
264
265
 
# File 'lib/puppet/util/log.rb', line 261

def self.from_data_hash(data)
  obj = allocate
  obj.initialize_from_hash(data)
  obj
end

.level ⇒ Object

Return the current log level.


100
101
102
 
# File 'lib/puppet/util/log.rb', line 100

def Log.level
  @levels[@loglevel]
end

.level=(level) ⇒ Object

Set the current log level.

Raises:


105
106
107
108
109
110
111
112
113
114
 
# File 'lib/puppet/util/log.rb', line 105

def Log.level=(level)
  level = level.intern unless level.is_a?(Symbol)

  raise Puppet::DevError, _("Invalid loglevel %{level}") % { level: level } unless @levels.include?(level)

  @loglevel = @levels.index(level)

  # Enable or disable Facter debugging
  Puppet.runtime[:facter].debugging(level == :debug)
end

.levels ⇒ Object 


116
117
118
 
# File 'lib/puppet/util/log.rb', line 116

def Log.levels
  @levels.dup
end

.log_func(scope, level, vals) ⇒ Object

Log output using scope and level

Parameters:

  • scope (Puppet::Parser::Scope)
  • level (Symbol) —

    log level

  • vals (Array<Object>) —

    the values to log (will be converted to string and joined with space)


273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/puppet/util/log.rb', line 273

def self.log_func(scope, level, vals)
  # NOTE: 3x, does this: vals.join(" ")
  # New implementation uses the evaluator to get proper formatting per type
  vals = vals.map { |v| Puppet::Pops::Evaluator::EvaluatorImpl.new.string(v, scope) }

  # Bypass Puppet.<level> call since it picks up source from "self" which is not applicable in the 4x
  # Function API.
  # TODO: When a function can obtain the file, line, pos of the call merge those in (3x supports
  #       options :file, :line. (These were never output when calling the 3x logging functions since
  #       3x scope does not know about the calling location at that detailed level, nor do they
  #       appear in a report to stdout/error when included). Now, the output simply uses scope (like 3x)
  #       as this is good enough, but does not reflect the true call-stack, but is a rough estimate
  #       of where the logging call originates from).
  #
  Puppet::Util::Log.create({:level => level, :source => scope, :message => vals.join(" ")})
  nil
end

.newdestination(dest) ⇒ Object

Create a new log destination.

Raises:


121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/puppet/util/log.rb', line 121

def Log.newdestination(dest)
  # Each destination can only occur once.
  if @destinations.find { |name, obj| obj.name == dest }
    return
  end

  _, type = @desttypes.find do |name, klass|
    klass.match?(dest)
  end

  if type.respond_to?(:suitable?) and not type.suitable?(dest)
    return
  end

  raise Puppet::DevError, _("Unknown destination type %{dest}") % { dest: dest} unless type

  begin
    if type.instance_method(:initialize).arity == 1
      @destinations[dest] = type.new(dest)
    else
      @destinations[dest] = type.new
    end
    flushqueue
    @destinations[dest]
  rescue => detail
    Puppet.log_exception(detail)

    # If this was our only destination, then add the console back in.
    if destinations.empty? && dest.intern != :console
      newdestination(:console)
    end

    # Re-raise (end exit Puppet) because we could not set up logging correctly.
    raise detail
  end
end

.newdesttype(name, options = {}, &block) ⇒ Object

Create a new destination type.


22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/puppet/util/log.rb', line 22

def self.newdesttype(name, options = {}, &block)

  dest = genclass(
    name,
    :parent     => Puppet::Util::Log::Destination,
    :prefix     => "Dest",
    :block      => block,
    :hash       => @desttypes,
    :attributes => options
  )
  dest.match(dest.name)

  dest
end

.newmessage(msg) ⇒ Object

Route the actual message. FIXME There are lots of things this method should do, like caching and a bit more. It's worth noting that there's a potential for a loop here, if the machine somehow gets the destination set as itself.


186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/puppet/util/log.rb', line 186

def Log.newmessage(msg)
  return if @levels.index(msg.level) < @loglevel

  msg.message = coerce_string(msg.message)
  msg.source = coerce_string(msg.source)

  queuemessage(msg) if @destinations.length == 0

  @destinations.each do |name, dest|
    dest.handle(msg)
  end
end

.queuemessage(msg) ⇒ Object 


199
200
201
 
# File 'lib/puppet/util/log.rb', line 199

def Log.queuemessage(msg)
  @queued.push(msg)
end

.reopen ⇒ Object

Reopen all of our logs.


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/puppet/util/log.rb', line 230

def Log.reopen
  Puppet.notice _("Reopening log files")
  types = @destinations.keys
  @destinations.each { |type, dest|
    dest.close if dest.respond_to?(:close)
  }
  @destinations.clear
  # We need to make sure we always end up with some kind of destination
  begin
    types.each { |type|
      Log.newdestination(type)
    }
  rescue => detail
    if @destinations.empty?
      Log.setup_default
      Puppet.err detail.to_s
    end
  end
end

.sendlevel?(level) ⇒ Boolean

Returns:

  • (Boolean) 

225
226
227
 
# File 'lib/puppet/util/log.rb', line 225

def Log.sendlevel?(level)
  @levels.index(level) >= @loglevel
end

.setup_default ⇒ Object 


250
251
252
253
254
 
# File 'lib/puppet/util/log.rb', line 250

def self.setup_default
  Log.newdestination(
    (Puppet.features.syslog?   ? :syslog   :
    (Puppet.features.eventlog? ? :eventlog : Puppet[:puppetdlog])))
end

.validlevel?(level) ⇒ Boolean

Is the passed level a valid log level?

Returns:

  • (Boolean) 

257
258
259
 
# File 'lib/puppet/util/log.rb', line 257

def self.validlevel?(level)
  @levels.include?(level)
end

.with_destination(destination, &block) ⇒ Object 


158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/puppet/util/log.rb', line 158

def Log.with_destination(destination, &block)
  if @destinations.include?(destination)
    yield
  else
    newdestination(destination)
    begin
      yield
    ensure
      close(destination)
    end
  end
end

Instance Method Details

#initialize_from_hash(data) ⇒ Object 


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/puppet/util/log.rb', line 317

def initialize_from_hash(data)
  @level = data['level'].intern
  @message = data['message']
  @source = data['source']
  @tags = Puppet::Util::TagSet.new(data['tags'])
  @time = data['time']
  if @time.is_a? String
    @time = Time.parse(@time)
  end
  # Don't add these unless defined (preserve 3.x API as much as possible)
  %w(file line pos issue_code environment node backtrace).each do |name|
    value = data[name]
    next unless value
    send(name + '=', value)
  end
end

#to_data_hash ⇒ Object 


338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/puppet/util/log.rb', line 338

def to_data_hash
  {
    'level' => @level.to_s,
    'message' => to_s,
    'source' => @source,
    'tags' => @tags.to_a,
    'time' => @time.iso8601(9),
    'file' => @file,
    'line' => @line,
  }
end

#to_hash ⇒ Object 


334
335
336
 
# File 'lib/puppet/util/log.rb', line 334

def to_hash
  self.to_data_hash
end

#to_report ⇒ Object 


396
397
398
 
# File 'lib/puppet/util/log.rb', line 396

def to_report
  "#{time} #{source} (#{level}): #{self}"
end

#to_s ⇒ Object 


400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/puppet/util/log.rb', line 400

def to_s
  msg = message

  # Issue based messages do not have details in the message. It
  # must be appended here
  unless issue_code.nil?
    msg = _("Could not parse for environment %{environment}: %{msg}") % { environment: environment, msg: msg } unless environment.nil?
    msg += Puppet::Util::Errors.error_location_with_space(file, line, pos)
    msg = _("%{msg} on node %{node}") % { msg: msg, node: node } unless node.nil?
    if @backtrace.is_a?(Array)
      msg += "\n"
      msg += @backtrace.join("\n")
    end
  end
  msg
end

#to_structured_hash ⇒ Object 


350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/puppet/util/log.rb', line 350

def to_structured_hash
  hash = {
    'level' => @level,
    'message' => @message,
    'source' => @source,
    'tags' => @tags.to_a,
    'time' => @time.iso8601(9),
  }
  %w(file line pos issue_code environment node backtrace).each do |name|
    attr_name = "@#{name}"
    hash[name] = instance_variable_get(attr_name) if instance_variable_defined?(attr_name)
  end
  hash
end