Module: Puppet::Util::Logging

Included in:
Puppet, FileServing::Mount, Module, Parameter, Parser::Resource, Provider, Transaction::Event, Type, Type, ResourceTemplate
Defined in:
lib/puppet/util/logging.rb

Defined Under Namespace

Classes: DeprecationWarning

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.setup_facter_logging! ⇒ Object

Sets up Facter logging. This method causes Facter output to be forwarded to Puppet.



258
259
260
261
 
# File 'lib/puppet/util/logging.rb', line 258

def self.setup_facter_logging!
  Puppet.runtime[:facter]
  true
end

Instance Method Details

#clear_deprecation_warnings ⇒ Object 



217
218
219
220
 
# File 'lib/puppet/util/logging.rb', line 217

def clear_deprecation_warnings
  $unique_warnings.clear if $unique_warnings
  $deprecation_warnings.clear if $deprecation_warnings
end

#debug(*args) ⇒ Object

Output a debug log message if debugging is on (but only then) If the output is anything except a static string, give the debug a block - it will be called with all other arguments, and is expected to return the single string result.

Use a block at all times for increased performance.

Examples:

This takes 40% of the time compared to not using a block

Puppet.debug { "This is a string that interpolated #{x} and #{y} }"


34
35
36
37
38
39
40
41
42
 
# File 'lib/puppet/util/logging.rb', line 34

def debug(*args)
  return nil unless Puppet::Util::Log.level == :debug

  if block_given?
    send_log(:debug, yield(*args))
  else
    send_log(:debug, args.join(" "))
  end
end

#deprecation_warning(message, key = nil) ⇒ Object

Logs a warning indicating that the Ruby code path is deprecated. Note that this method keeps track of the offending lines of code that triggered the deprecation warning, and will only log a warning once per offending line of code. It will also stop logging deprecation warnings altogether after 100 unique deprecation warnings have been logged. Finally, if Puppet includes ‘deprecations’, it will squelch all warning calls made via this method.

Parameters:

  • message (String) —

    The message to log (logs via warning)

  • key (String) (defaults to: nil) —

    Optional key to mark the message as unique. If not passed in, the originating call line will be used instead.



143
144
145
 
# File 'lib/puppet/util/logging.rb', line 143

def deprecation_warning(message, key = nil)
  issue_deprecation_warning(message, key, nil, nil, true)
end

#format_backtrace(exception, combined_trace, puppet_trace) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/puppet/util/logging.rb', line 113

def format_backtrace(exception, combined_trace, puppet_trace)
  puppetstack = exception.respond_to?(:puppetstack) ? exception.puppetstack : []

  if combined_trace and exception.backtrace
    Puppet::Util.format_backtrace_array(exception.backtrace, puppetstack)
  elsif puppet_trace && !puppetstack.empty?
    Puppet::Util.format_backtrace_array(puppetstack)
  else
    []
  end
end

#format_exception(exception, message = :default, combined_trace = true, puppet_trace = false) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/puppet/util/logging.rb', line 92

def format_exception(exception, message = :default, combined_trace = true, puppet_trace = false)
  arr = []
  case message
  when :default
    arr << exception.message
  when nil
    # don't log anything if they passed a nil; they are just calling for the optional backtrace logging
  else
    arr << message
  end

  arr += format_backtrace(exception, combined_trace, puppet_trace)

  if exception.respond_to?(:original) and exception.original
    arr << _("Wrapped exception:")
    arr << format_exception(exception.original, :default, combined_trace, puppet_trace)
  end

  arr.flatten.join("\n")
end

#get_deprecation_offender ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/puppet/util/logging.rb', line 204

def get_deprecation_offender
  # we have to put this in its own method to simplify testing; we need to be able to mock the offender results in
  # order to test this class, and our framework does not appear to enjoy it if you try to mock Kernel.caller
  #
  # let's find the offending line;  we need to jump back up the stack a few steps to find the method that called
  #  the deprecated method
  if Puppet[:trace]
    caller(3)
  else
    [caller(3, 1).first]
  end
end

#log_and_raise(exception, message) ⇒ Object

Raises:

  • (exception) 


125
126
127
128
 
# File 'lib/puppet/util/logging.rb', line 125

def log_and_raise(exception, message)
  log_exception(exception, message)
  raise exception, message + "\n" + exception.to_s, exception.backtrace
end

#log_deprecations_to_file(deprecations_file, pattern = nil) ⇒ Object

utility method that can be called, e.g., from spec_helper config.after, when tracking down calls to deprecated code. Parameters:

deprecations_file

relative or absolute path of a file to log the deprecations to

pattern

(default nil) if specified, will only log deprecations whose message matches the provided pattern



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/puppet/util/logging.rb', line 230

def log_deprecations_to_file(deprecations_file, pattern = nil)
  # this method may get called lots and lots of times (e.g., from spec_helper config.after) without the global
  # list of deprecation warnings being cleared out.  We don't want to keep logging the same offenders over and over,
  # so, we need to keep track of what we've logged.
  #
  # It'd be nice if we could just clear out the list of deprecation warnings, but then the very next spec might
  # find the same offender, and we'd end up logging it again.
  $logged_deprecation_warnings ||= {}

  # Deprecation messages are UTF-8 as they are produced by Ruby
  Puppet::FileSystem.open(deprecations_file, nil, "a:UTF-8") do |f|
    if $deprecation_warnings then
      $deprecation_warnings.each do |offender, message|
        next if $logged_deprecation_warnings.has_key?(offender)

        $logged_deprecation_warnings[offender] = true
        next unless pattern.nil? || (message =~ pattern)

        f.puts(message)
        f.puts(offender)
        f.puts()
      end
    end
  end
end

#log_exception(exception, message = :default, options = {}) ⇒ Object

Log an exception via Puppet.err. Will also log the backtrace if Puppet is set. Parameters:

exception

an Exception to log

message

an optional String overriding the message to be logged; by default, we log Exception.message.

If you pass a String here, your string will be logged instead.  You may also pass nil if you don't
wish to log a message at all; in this case it is likely that you are only calling this method in order
to take advantage of the backtrace logging.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/puppet/util/logging.rb', line 51

def log_exception(exception, message = :default, options = {})
  level = options[:level] || :err
  combined_trace = Puppet[:trace] || options[:trace]
  puppet_trace = Puppet[:puppet_trace] || options[:puppet_trace]

  if message == :default && exception.is_a?(Puppet::ParseErrorWithIssue)
    # Retain all detailed info and keep plain message and stacktrace separate
    backtrace = build_exception_trace(exception, combined_trace, puppet_trace)
    Puppet::Util::Log.create({
      :level => level,
      :source => log_source,
      :message => exception.basic_message,
      :issue_code => exception.issue_code,
      :backtrace => backtrace.empty? ? nil : backtrace,
      :file => exception.file,
      :line => exception.line,
      :pos => exception.pos,
      :environment => exception.environment,
      :node => exception.node
    }.merge(log_metadata))
  else
    send_log(level, format_exception(exception, message, combined_trace, puppet_trace))
  end
end

#puppet_deprecation_warning(message, options = {}) ⇒ Object

Logs a warning whose origin comes from Puppet source rather than somewhere internal within Puppet. Otherwise the same as deprecation_warning()

Either :file and :line and/or :key must be passed.

Parameters:

  • message (String) —

    The message to log (logs via warning)

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :file (String) —

    File we are warning from

  • :line (Integer) —

    Line number we are warning from

  • :key (String) — default: :file + :line —

    Alternative key used to mark warning as unique

Raises:



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

def puppet_deprecation_warning(message, options = {})
  key = options[:key]
  file = options[:file]
  line = options[:line]
  # TRANSLATORS the literals ":file", ":line", and ":key" should not be translated
  raise Puppet::DevError, _("Need either :file and :line, or :key") if key.nil? && (file.nil? || line.nil?)

  key ||= "#{file}:#{line}"
  issue_deprecation_warning(message, key, file, line, false)
end

#send_log(level, message) ⇒ Object 



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

def send_log(level, message)
  Puppet::Util::Log.create({ :level => level, :source => log_source, :message => message }.merge(log_metadata))
end

#warn_once(kind, key, message, file = nil, line = nil, level = :warning) ⇒ Object

Logs a (non deprecation) warning once for a given key.

Either :file and :line and/or :key must be passed.

Parameters:

  • kind (String) —

    The kind of warning. The kind must be one of the defined kinds for the Puppet setting.

  • message (String) —

    The message to log (logs via warning)

  • key (String) —

    Key used to make this warning unique

  • file (String, :default, nil) (defaults to: nil) —

    the File related to the warning

  • line (Integer, :default, nil) (defaults to: nil) —

    the Line number related to the warning warning as unique

  • level (Symbol) (defaults to: :warning) —

    log level to use, defaults to :warning



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/puppet/util/logging.rb', line 181

def warn_once(kind, key, message, file = nil, line = nil, level = :warning)
  return if Puppet[:disable_warnings].include?(kind)

  $unique_warnings ||= {}
  if $unique_warnings.length < 100 then
    unless $unique_warnings.has_key?(key) then
      $unique_warnings[key] = message
      call_trace = if file == :default and line == :default
                     # Suppress the file and line number output
                     ''
                   else
                     error_location_str = Puppet::Util::Errors.error_location(file, line)
                     if error_location_str.empty?
                       "\n   " + _('(file & line not available)')
                     else
                       "\n   %{error_location}" % { error_location: error_location_str }
                     end
                   end
      send_log(level, "#{message}#{call_trace}")
    end
  end
end