Puppet Function: extlib::echo

Defined in:
lib/puppet/functions/extlib/echo.rb
Function type:
Ruby 4.x API

Overview

extlib::echo(Any $value, Optional[String] $comment) ⇒ Undef

This function outputs the variable content and its type to the debug log. It’s similiar to the ‘notice` function but provides a better output format useful to trace variable types and values in the manifests.

“‘ $v1 = ’test’ $v2 = [“1”, “2”, “3”] $v3 = “b”=>“2” $v4 = true # $v5 is not defined $v6 = { “b” => { “b” => [1,2,3], “c” => true, “d” => { ‘x’ => ‘y’ }}, ‘x’ => ‘y’, ‘z’ => [1,2,3,4,5,6]} $v7 = 12345

echo($v1, ‘My string’) echo($v2, ‘My array’) echo($v3, ‘My hash’) echo($v4, ‘My boolean’) echo($v5, ‘My undef’) echo($v6, ‘My structure’) echo($v7) # no comment here debug log output My string (String) “test” My array (Array) [“1”, “2”, “3”] My hash (Hash) “b”=>“2” My boolean (TrueClass) true My undef (String) “” My structure (Hash) “2”, “3”], “c”=>true, “d”=>{“x”=>“y”}, “x”=>“y”, “z”=>[“1”, “2”, “3”, “4”, “5”, “6”]} (String) “12345” “‘

Parameters:

  • value (Any) —

    The value you want to inspect.

  • comment (Optional[String]) —

    An optional comment to prepend to the debug output.

Returns:

  • (Undef) —

    Returns nothing.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/puppet/functions/extlib/echo.rb', line 33

Puppet::Functions.create_function(:'extlib::echo') do
  # @param value The value you want to inspect.
  # @param comment An optional comment to prepend to the debug output.
  # @return [Undef] Returns nothing.
  dispatch :echo do
    param 'Any', :value
    optional_param 'String', :comment
  end

  def echo(value, comment = nil)
    message = "(#{value.class}) #{value.inspect}"
    message = "#{comment} #{message}" if comment
    Puppet.debug message
  end
end