Merge pull request #2229 from opscode/jdmundrawala/12-evt-log

Logging events to the Windows Event Log

4 files changed, 198 insertions, 1 deletions

diff --git a/lib/chef/client.rb b/lib/chef/client.rb
index e8ff352116..4f37bd0ee3 100644
--- a/lib/chef/client.rb
+++ b/lib/chef/client.rb
@@ -36,6 +36,8 @@ require 'chef/cookbook/file_vendor'
 require 'chef/cookbook/file_system_file_vendor'
 require 'chef/cookbook/remote_file_vendor'
 require 'chef/event_dispatch/dispatcher'
+require 'chef/event_loggers/base'
+require 'chef/event_loggers/windows_eventlog'
 require 'chef/formatters/base'
 require 'chef/formatters/doc'
 require 'chef/formatters/minimal'
@@ -151,7 +153,7 @@ class Chef
       @runner = nil
       @ohai = Ohai::System.new
 
-      event_handlers = configure_formatters
+      event_handlers = configure_formatters + configure_event_loggers
       event_handlers += Array(Chef::Config[:event_handlers])
 
       @events = EventDispatch::Dispatcher.new(*event_handlers)
@@ -191,6 +193,22 @@ class Chef
       end
     end
 
+    def configure_event_loggers
+      if Chef::Config.disable_event_logger
+        []
+      else
+        Chef::Config.event_loggers.map do |evt_logger|
+          case evt_logger
+          when Symbol
+            Chef::EventLoggers.new(evt_logger)
+          when Class
+            evt_logger.new
+          else
+          end
+        end
+      end
+    end
+
     # Instantiates a Chef::Node object, possibly loading the node's prior state
     # when using chef-client. Delegates to policy_builder
     #
diff --git a/lib/chef/config.rb b/lib/chef/config.rb
index 9a8117d2c2..d033a2981b 100644
--- a/lib/chef/config.rb
+++ b/lib/chef/config.rb
@@ -78,6 +78,10 @@ class Chef
       formatters << [name, file_path]
     end
 
+    def self.add_event_logger(logger)
+      event_handlers << logger
+    end
+
     # Config file to load (client.rb, knife.rb, etc. defaults set differently in knife, chef-client, etc.)
     configurable(:config_file)
 
@@ -451,6 +455,15 @@ class Chef
     # Event Handlers
     default :event_handlers, []
 
+    default :disable_event_loggers, false
+    default :event_loggers do
+      evt_loggers = []
+      if Chef::Platform::windows?
+        evt_loggers << :win_evt
+      end
+      evt_loggers
+    end
+
     # Exception Handlers
     default :exception_handlers, []
 
diff --git a/lib/chef/event_loggers/base.rb b/lib/chef/event_loggers/base.rb
new file mode 100644
index 0000000000..1f676dd516
--- /dev/null
+++ b/lib/chef/event_loggers/base.rb
@@ -0,0 +1,62 @@
+#
+# Author:: Jay Mundrawala (<jdm@getchef.com>)
+#
+# Copyright:: 2014, Chef Software, Inc.
+#
+# 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/event_dispatch/base'
+
+class Chef
+  module EventLoggers
+    class UnknownEventLogger < StandardError; end
+    class UnavailableEventLogger < StandardError; end
+
+    def self.event_loggers_by_name
+      @event_loggers_by_name ||= {}
+    end
+
+    def self.register(name, logger)
+      event_loggers_by_name[name.to_s] = logger
+    end
+
+    def self.by_name(name)
+      event_loggers_by_name[name]
+    end
+
+    def self.available_event_loggers
+      event_loggers_by_name.select do |key, val|
+        val.available?
+      end.keys
+    end
+
+    def self.new(name)
+      event_logger_class = by_name(name.to_s) or
+        raise UnknownEventLogger, "No event logger found for #{name} (available: #{available_event_loggers.join(', ')})"
+      raise UnavailableEventLogger unless available_event_loggers.include? name.to_s
+      event_logger_class.new
+    end
+
+    class Base < EventDispatch::Base
+      def self.short_name(name)
+        Chef::EventLoggers.register(name, self)
+      end
+
+      # Returns true if this implementation of EventLoggers can be used
+      def self.available?
+        false
+      end
+    end
+  end
+end
diff --git a/lib/chef/event_loggers/windows_eventlog.rb b/lib/chef/event_loggers/windows_eventlog.rb
new file mode 100644
index 0000000000..e3bbbfa1e6
--- /dev/null
+++ b/lib/chef/event_loggers/windows_eventlog.rb
@@ -0,0 +1,104 @@
+#
+# Author:: Jay Mundrawala (<jdm@getchef.com>)
+#
+# Copyright:: 2014, Chef Software, Inc.
+#
+# 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/event_loggers/base'
+require 'chef/platform/query_helpers'
+
+if Chef::Platform::windows?
+  [:INFINITE, :WAIT_FAILED, :FORMAT_MESSAGE_IGNORE_INSERTS, :ERROR_INSUFFICIENT_BUFFER].each do |c|
+    # These are redefined in 'win32/eventlog'
+    Windows::Constants.send(:remove_const, c)
+  end
+
+  require 'win32/eventlog'
+  include Win32
+end
+
+class Chef
+  module EventLoggers
+    class WindowsEventLogger < EventLoggers::Base
+      short_name(:win_evt)
+
+      # These must match those that are defined in the manifest file
+      RUN_START_EVENT_ID = 10000
+      RUN_STARTED_EVENT_ID = 10001
+      RUN_COMPLETED_EVENT_ID = 10002
+      RUN_FAILED_EVENT_ID = 10003
+
+      EVENT_CATEGORY_ID = 11000
+      LOG_CATEGORY_ID = 11001
+
+      # Since we must install the event logger, this is not really configurable
+      SOURCE = 'Chef'
+
+      def self.available?
+        return Chef::Platform::windows?
+      end
+
+      def initialize
+        @eventlog = EventLog::open('Application')
+      end
+
+      def run_start(version)
+        @eventlog.report_event(
+          :event_type => EventLog::INFO_TYPE, 
+          :source => SOURCE,
+          :event_id => RUN_START_EVENT_ID,
+          :data => [version]
+        )
+      end
+
+      def run_started(run_status)
+        @run_status = run_status
+        @eventlog.report_event(
+          :event_type => EventLog::INFO_TYPE, 
+          :source => SOURCE,
+          :event_id => RUN_STARTED_EVENT_ID,
+          :data => [run_status.run_id]
+        )
+      end
+
+      def run_completed(node)
+        @eventlog.report_event(
+          :event_type => EventLog::INFO_TYPE, 
+          :source => SOURCE,
+          :event_id => RUN_COMPLETED_EVENT_ID,
+          :data => [@run_status.run_id, @run_status.elapsed_time.to_s]
+        )
+      end
+
+      #Failed chef-client run %1 in %2 seconds.
+      #Exception type: %3
+      #Exception message: %4
+      #Exception backtrace: %5
+      def run_failed(e)
+        @eventlog.report_event(
+          :event_type => EventLog::ERROR_TYPE, 
+          :source => SOURCE, 
+          :event_id => RUN_FAILED_EVENT_ID,
+          :data => [@run_status.run_id, 
+                    @run_status.elapsed_time.to_s, 
+                    e.class.name, 
+                    e.message, 
+                    e.backtrace.join("\n")]
+        )
+      end
+
+    end
+  end
+end