Class: Chef::Resource::Log

Inherits:
Chef::Resource show all
Defined in:
lib/chef/resource/log.rb

Overview

Sends a string from a recipe to a log provider

log “some string to log” do

level :info  # (default)  also supports :warn, :debug, and :error

end

Example

log “your string to log”

or

log “a debug string” { level :debug }

Constant Summary

Constants inherited from Chef::Resource

HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #delayed_notifications, #enclosing_provider, #immediate_notifications, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, #add_notification, attribute, build_from_file, #epic_fail, #ignore_failure, #is, json_create, #load_prior_resource, #method_missing, #name, #node, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, provider_base, #resolve_notification_references, #resources, #run_action, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::Deprecation

#deprecated_ivar

Methods included from Mixin::Language

#data_bag, #data_bag_item, #platform?, #search, #value_for_platform

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from Mixin::CheckHelper

#set_if_args

Constructor Details

#initialize(name, run_context = nil) ⇒ Log

Initialize log resource with a name as the string to log

Parameters

name<String>

Message to log

collection<Array>

Collection of included recipes

node<Chef::Node>

Node where resource will be used



42
43
44
45
46
47
 
# File 'lib/chef/resource/log.rb', line 42

def initialize(name, run_context=nil)
  super
  @resource_name = :log
  @level = :info
  @action = :write
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Resource

Instance Method Details

#level(arg = nil) ⇒ Object

<Symbol> Log level, one of :debug, :info, :warn, :error or :fatal



50
51
52
53
54
55
56
 
# File 'lib/chef/resource/log.rb', line 50

def level(arg=nil)
  set_or_return(
    :level,
    arg,
    :equal_to => [ :debug, :info, :warn, :error, :fatal ]
  )
end