summaryrefslogtreecommitdiff
path: root/lib/chef/resource/log.rb
blob: b6da123526f91941be82f68408d9270fa05133df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
#
# Author:: Cary Penniman (<cary@rightscale.com>)
# Author:: Tyler Cloke (<tyler@chef.io>)
# Copyright:: Copyright 2008-2016, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require "chef/resource"

class Chef
  class Resource
    # Use the log resource to create log entries. The log resource behaves like any other resource: built into the resource
    # collection during the compile phase, and then run during the execution phase. (To create a log entry that is not built
    # into the resource collection, use Chef::Log instead of the log resource.)
    #
    # Allows logging a :debug, :info, :warn, and :error levels
    # Defaults to :info level
    #
    # @example logging at default info level
    #   log "your string to log"
    #
    # @example logging at specified debug level
    #   log "a debug string" do
    #     level :debug
    #   end
    #
    class Log < Chef::Resource
      resource_name :log

      property :message, String, name_property: true
      property :level, Symbol, equal_to: [ :debug, :info, :warn, :error, :fatal ], default: :info

      allowed_actions :write
      default_action :write
    end
  end
end