Class: Chef::EventLoggers::WindowsEventLogger

Inherits:
Base show all
Defined in:
lib/chef/event_loggers/windows_eventlog.rb

Constant Summary collapse

RUN_START_EVENT_ID =

These must match those that are defined in the manifest file

10000
RUN_STARTED_EVENT_ID = 
10001
RUN_COMPLETED_EVENT_ID = 
10002
RUN_FAILED_EVENT_ID = 
10003
EVENT_CATEGORY_ID = 
11000
LOG_CATEGORY_ID = 
11001
SOURCE =

Since we must install the event logger, this is not really configurable

ChefUtils::Dist::Infra::SHORT.freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

short_name

Methods inherited from Chef::EventDispatch::Base

#action_collection_registration, #attribute_changed, #attribute_file_load_failed, #attribute_file_loaded, #attribute_load_complete, #attribute_load_start, #compliance_input_enabled, #compliance_input_loaded, #compliance_load_complete, #compliance_load_start, #compliance_profile_enabled, #compliance_profile_loaded, #compliance_waiver_enabled, #compliance_waiver_loaded, #converge_complete, #converge_failed, #converge_start, #cookbook_clean_complete, #cookbook_clean_start, #cookbook_compilation_complete, #cookbook_compilation_start, #cookbook_gem_failed, #cookbook_gem_finished, #cookbook_gem_installing, #cookbook_gem_start, #cookbook_gem_using, #cookbook_resolution_complete, #cookbook_resolution_failed, #cookbook_resolution_start, #cookbook_sync_complete, #cookbook_sync_failed, #cookbook_sync_start, #definition_file_load_failed, #definition_file_loaded, #definition_load_complete, #definition_load_start, #deprecation, #handler_executed, #handlers_completed, #handlers_start, #inputs_load_complete, #inputs_load_start, #key_migration_status, #library_file_load_failed, #library_file_loaded, #library_load_complete, #library_load_start, #lwrp_file_load_failed, #lwrp_file_loaded, #lwrp_load_complete, #lwrp_load_start, #msg, #node_load_completed, #node_load_failed, #node_load_start, #node_load_success, #ohai_completed, #ohai_plugin_file_load_failed, #ohai_plugin_file_loaded, #ohai_plugin_load_complete, #ohai_plugin_load_start, #policyfile_loaded, #profiles_load_complete, #profiles_load_start, #provider_requirement_failed, #recipe_file_load_failed, #recipe_file_loaded, #recipe_load_complete, #recipe_load_start, #recipe_not_found, #registration_completed, #registration_failed, #registration_start, #removed_cookbook_file, #resource_action_start, #resource_after_state_loaded, #resource_bypassed, #resource_completed, #resource_current_state_load_bypassed, #resource_current_state_loaded, #resource_failed, #resource_failed_retriable, #resource_skipped, #resource_up_to_date, #resource_update_applied, #resource_update_progress, #resource_updated, #run_list_expand_failed, #run_list_expanded, #skipping_registration, #stream_closed, #stream_opened, #stream_output, #synchronized_cookbook, #updated_cookbook_file, #waivers_load_complete, #waivers_load_start, #whyrun_assumption

Constructor Details

#initialize ⇒ WindowsEventLogger

Returns a new instance of WindowsEventLogger.



45
46
47
 
# File 'lib/chef/event_loggers/windows_eventlog.rb', line 45

def initialize
  @eventlog = ::Win32::EventLog.open("Application")
end

Class Method Details

.available? ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/chef/event_loggers/windows_eventlog.rb', line 41

def self.available?
  ChefUtils.windows?
end

Instance Method Details

#run_completed(node) ⇒ Object 



68
69
70
71
72
73
74
75
 
# File 'lib/chef/event_loggers/windows_eventlog.rb', line 68

def run_completed(node)
  @eventlog.report_event(
    event_type: ::Win32::EventLog::INFO_TYPE,
    source: SOURCE,
    event_id: RUN_COMPLETED_EVENT_ID,
    data: [@run_status.run_id, @run_status.elapsed_time.to_s]
  )
end

#run_failed(e) ⇒ Object

Failed chef-client run %1 in %2 seconds. Exception type: %3 Exception message: %4 Exception backtrace: %5



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/chef/event_loggers/windows_eventlog.rb', line 81

def run_failed(e)
  data =
    if @run_status
      [@run_status.run_id,
       @run_status.elapsed_time.to_s]
    else
      %w{UNKNOWN UNKNOWN}
    end

  @eventlog.report_event(
    event_type: ::Win32::EventLog::ERROR_TYPE,
    source: SOURCE,
    event_id: RUN_FAILED_EVENT_ID,
    data: data + [e.class.name,
                     e.message,
                     e.backtrace.join("\n")]
  )
end

#run_start(version, run_status) ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'lib/chef/event_loggers/windows_eventlog.rb', line 49

def run_start(version, run_status)
  @eventlog.report_event(
    event_type: ::Win32::EventLog::INFO_TYPE,
    source: SOURCE,
    event_id: RUN_START_EVENT_ID,
    data: [version]
  )
end

#run_started(run_status) ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'lib/chef/event_loggers/windows_eventlog.rb', line 58

def run_started(run_status)
  @run_status = run_status
  @eventlog.report_event(
    event_type: ::Win32::EventLog::INFO_TYPE,
    source: SOURCE,
    event_id: RUN_STARTED_EVENT_ID,
    data: [run_status.run_id]
  )
end