Class: Chef::EventDispatch::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/chef/event_dispatch/base.rb

Overview

EventDispatch::Base

EventDispatch::Base is a completely abstract base class that defines the API used by both the classes that collect event information and those that process them.

Direct Known Subclasses

Dispatcher, Formatters::Base, ResourceReporter

Instance Method Summary collapse

Instance Method Details

#attribute_file_load_failed(path, exception) ⇒ Object

Called when an attribute file fails to load.



174
175
 
# File 'lib/chef/event_dispatch/base.rb', line 174

def attribute_file_load_failed(path, exception)
end

#attribute_file_loaded(path) ⇒ Object

Called after the attribute file is loaded



170
171
 
# File 'lib/chef/event_dispatch/base.rb', line 170

def attribute_file_loaded(path)
end

#attribute_load_complete ⇒ Object

Called when attribute file loading is finished



178
179
 
# File 'lib/chef/event_dispatch/base.rb', line 178

def attribute_load_complete
end

#attribute_load_start(attribute_file_count) ⇒ Object

Called before attribute files are loaded



166
167
 
# File 'lib/chef/event_dispatch/base.rb', line 166

def attribute_load_start(attribute_file_count)
end

#converge_complete ⇒ Object

Called when the converge phase is finished.



222
223
 
# File 'lib/chef/event_dispatch/base.rb', line 222

def converge_complete
end

#converge_start(run_context) ⇒ Object

Called before convergence starts



218
219
 
# File 'lib/chef/event_dispatch/base.rb', line 218

def converge_start(run_context)
end

#cookbook_clean_complete ⇒ Object

Called when cookbook cleaning is finished.



106
107
 
# File 'lib/chef/event_dispatch/base.rb', line 106

def cookbook_clean_complete
end

#cookbook_clean_start ⇒ Object

Called before unneeded cookbooks are removed



96
97
 
# File 'lib/chef/event_dispatch/base.rb', line 96

def cookbook_clean_start
end

#cookbook_resolution_complete(cookbook_collection) ⇒ Object

Called when the cookbook collection is returned from the server.



92
93
 
# File 'lib/chef/event_dispatch/base.rb', line 92

def cookbook_resolution_complete(cookbook_collection)
end

#cookbook_resolution_failed(expanded_run_list, exception) ⇒ Object

Called when there is an error getting the cookbook collection from the server.



88
89
 
# File 'lib/chef/event_dispatch/base.rb', line 88

def cookbook_resolution_failed(expanded_run_list, exception)
end

#cookbook_resolution_start(expanded_run_list) ⇒ Object

Called before the cookbook collection is fetched from the server.



83
84
 
# File 'lib/chef/event_dispatch/base.rb', line 83

def cookbook_resolution_start(expanded_run_list)
end

#cookbook_sync_complete ⇒ Object

Called after all cookbooks have been sync’d.



126
127
 
# File 'lib/chef/event_dispatch/base.rb', line 126

def cookbook_sync_complete
end

#cookbook_sync_failed(cookbooks, exception) ⇒ Object

Called when an error occurs during cookbook sync



122
123
 
# File 'lib/chef/event_dispatch/base.rb', line 122

def cookbook_sync_failed(cookbooks, exception)
end

#cookbook_sync_start(cookbook_count) ⇒ Object

Called before cookbook sync starts



110
111
 
# File 'lib/chef/event_dispatch/base.rb', line 110

def cookbook_sync_start(cookbook_count)
end

#definition_file_load_failed(path, exception) ⇒ Object

Called when a resource definition file fails to load



190
191
 
# File 'lib/chef/event_dispatch/base.rb', line 190

def definition_file_load_failed(path, exception)
end

#definition_file_loaded(path) ⇒ Object

Called when a resource definition has been loaded



186
187
 
# File 'lib/chef/event_dispatch/base.rb', line 186

def definition_file_loaded(path)
end

#definition_load_complete ⇒ Object

Called when resource defintions are done loading



194
195
 
# File 'lib/chef/event_dispatch/base.rb', line 194

def definition_load_complete
end

#definition_load_start(definition_file_count) ⇒ Object

Called before resource definitions are loaded



182
183
 
# File 'lib/chef/event_dispatch/base.rb', line 182

def definition_load_start(definition_file_count)
end

#handler_executed(handler) ⇒ Object

Called after an individual handler has run



282
283
 
# File 'lib/chef/event_dispatch/base.rb', line 282

def handler_executed(handler)
end

#handlers_completed ⇒ Object

Called after all handlers have executed



286
287
 
# File 'lib/chef/event_dispatch/base.rb', line 286

def handlers_completed
end

#handlers_start(handler_count) ⇒ Object

Called before handlers run



278
279
 
# File 'lib/chef/event_dispatch/base.rb', line 278

def handlers_start(handler_count)
end

#library_file_load_failed(path, exception) ⇒ Object

Called when a library file has an error on load.



142
143
 
# File 'lib/chef/event_dispatch/base.rb', line 142

def library_file_load_failed(path, exception)
end

#library_file_loaded(path) ⇒ Object

Called when library file has been loaded



138
139
 
# File 'lib/chef/event_dispatch/base.rb', line 138

def library_file_loaded(path)
end

#library_load_complete ⇒ Object

Called when library file loading has finished



146
147
 
# File 'lib/chef/event_dispatch/base.rb', line 146

def library_load_complete
end

#library_load_start(file_count) ⇒ Object

Called when library file loading starts



134
135
 
# File 'lib/chef/event_dispatch/base.rb', line 134

def library_load_start(file_count)
end

#lwrp_file_load_failed(path, exception) ⇒ Object

Called after a LWR or LWP file errors on load



158
159
 
# File 'lib/chef/event_dispatch/base.rb', line 158

def lwrp_file_load_failed(path, exception)
end

#lwrp_file_loaded(path) ⇒ Object

Called after a LWR or LWP has been loaded



154
155
 
# File 'lib/chef/event_dispatch/base.rb', line 154

def lwrp_file_loaded(path)
end

#lwrp_load_complete ⇒ Object

Called when LWRPs are finished loading



162
163
 
# File 'lib/chef/event_dispatch/base.rb', line 162

def lwrp_load_complete
end

#lwrp_load_start(lwrp_file_count) ⇒ Object

Called when LWRP loading starts



150
151
 
# File 'lib/chef/event_dispatch/base.rb', line 150

def lwrp_load_start(lwrp_file_count)
end

#msg(message) ⇒ Object

An uncategorized message. This supports the case that a user needs to pass output that doesn’t fit into one of the callbacks above. Note that there’s no semantic information about the content or importance of the message. That means that if you’re using this too often, you should add a callback for it.



306
307
 
# File 'lib/chef/event_dispatch/base.rb', line 306

def msg(message)
end

#node_load_completed(node, expanded_run_list, config) ⇒ Object

Called after Chef client has loaded the node data. Default and override attrs from roles have been computed, but not yet applied. Normal attrs from JSON have been added to the node.



79
80
 
# File 'lib/chef/event_dispatch/base.rb', line 79

def node_load_completed(node, expanded_run_list, config)
end

#node_load_failed(node_name, exception, config) ⇒ Object

Failed to load node data from the server



69
70
 
# File 'lib/chef/event_dispatch/base.rb', line 69

def node_load_failed(node_name, exception, config)
end

#node_load_start(node_name, config) ⇒ Object

Called before Chef client loads the node data from the server



63
64
 
# File 'lib/chef/event_dispatch/base.rb', line 63

def node_load_start(node_name, config)
end

#ohai_completed(node) ⇒ Object

Called right after ohai runs.



44
45
 
# File 'lib/chef/event_dispatch/base.rb', line 44

def ohai_completed(node)
end

#provider_requirement_failed(action, resource, exception, message) ⇒ Object

Called when an assertion declared by a provider fails



290
291
 
# File 'lib/chef/event_dispatch/base.rb', line 290

def provider_requirement_failed(action, resource, exception, message)
end

#recipe_file_load_failed(path, exception) ⇒ Object

Called after a recipe file fails to load



206
207
 
# File 'lib/chef/event_dispatch/base.rb', line 206

def recipe_file_load_failed(path, exception)
end

#recipe_file_loaded(path) ⇒ Object

Called after the recipe has been loaded



202
203
 
# File 'lib/chef/event_dispatch/base.rb', line 202

def recipe_file_loaded(path)
end

#recipe_load_complete ⇒ Object

Called when recipes have been loaded.



214
215
 
# File 'lib/chef/event_dispatch/base.rb', line 214

def recipe_load_complete
end

#recipe_load_start(recipe_count) ⇒ Object

Called before recipes are loaded



198
199
 
# File 'lib/chef/event_dispatch/base.rb', line 198

def recipe_load_start(recipe_count)
end

#recipe_not_found(exception) ⇒ Object

Called when a recipe cannot be resolved



210
211
 
# File 'lib/chef/event_dispatch/base.rb', line 210

def recipe_not_found(exception)
end

#registration_completed ⇒ Object 



55
56
 
# File 'lib/chef/event_dispatch/base.rb', line 55

def registration_completed
end

#registration_failed(node_name, exception, config) ⇒ Object

Failed to register this client with the server.



59
60
 
# File 'lib/chef/event_dispatch/base.rb', line 59

def registration_failed(node_name, exception, config)
end

#registration_start(node_name, config) ⇒ Object

About to attempt to register as node_name



52
53
 
# File 'lib/chef/event_dispatch/base.rb', line 52

def registration_start(node_name, config)
end

#removed_cookbook_file(path) ⇒ Object

Called after the file at path is removed. It may be removed if the cookbook containing it was removed from the run list, or if the file was removed from the cookbook.



102
103
 
# File 'lib/chef/event_dispatch/base.rb', line 102

def removed_cookbook_file(path)
end

#resource_action_start(resource, action, notification_type = nil, notifier = nil) ⇒ Object

Called before action is executed on a resource.



230
231
 
# File 'lib/chef/event_dispatch/base.rb', line 230

def resource_action_start(resource, action, notification_type=nil, notifier=nil)
end

#resource_bypassed(resource, action, current_resource) ⇒ Object

Called when evaluating a resource that does not support whyrun in whyrun mode



259
260
 
# File 'lib/chef/event_dispatch/base.rb', line 259

def resource_bypassed(resource, action, current_resource)
end

#resource_completed(resource) ⇒ Object

Called when a resource action has been completed



246
247
 
# File 'lib/chef/event_dispatch/base.rb', line 246

def resource_completed(resource)
end

#resource_current_state_load_bypassed(resource, action, current_resource) ⇒ Object

Called when resource current state load is skipped due to the provider not supporting whyrun mode.



255
256
 
# File 'lib/chef/event_dispatch/base.rb', line 255

def resource_current_state_load_bypassed(resource, action, current_resource)
end

#resource_current_state_loaded(resource, action, current_resource) ⇒ Object

Called after #load_current_resource has run.



250
251
 
# File 'lib/chef/event_dispatch/base.rb', line 250

def resource_current_state_loaded(resource, action, current_resource)
end

#resource_failed(resource, action, exception) ⇒ Object

Called when a resource fails and will not be retried.



238
239
 
# File 'lib/chef/event_dispatch/base.rb', line 238

def resource_failed(resource, action, exception)
end

#resource_failed_retriable(resource, action, retry_count, exception) ⇒ Object

Called when a resource fails, but will retry.



234
235
 
# File 'lib/chef/event_dispatch/base.rb', line 234

def resource_failed_retriable(resource, action, retry_count, exception)
end

#resource_skipped(resource, action, conditional) ⇒ Object

Called when a resource action has been skipped b/c of a conditional



242
243
 
# File 'lib/chef/event_dispatch/base.rb', line 242

def resource_skipped(resource, action, conditional)
end

#resource_up_to_date(resource, action) ⇒ Object

Called when a resource has no converge actions, e.g., it was already correct.



263
264
 
# File 'lib/chef/event_dispatch/base.rb', line 263

def resource_up_to_date(resource, action)
end

#resource_update_applied(resource, action, update) ⇒ Object

Called when a change has been made to a resource. May be called multiple times per resource, e.g., a file may have its content updated, and then its permissions updated.



269
270
 
# File 'lib/chef/event_dispatch/base.rb', line 269

def resource_update_applied(resource, action, update)
end

#resource_updated(resource, action) ⇒ Object

Called after a resource has been completely converged, but only if modifications were made.



274
275
 
# File 'lib/chef/event_dispatch/base.rb', line 274

def resource_updated(resource, action)
end

#run_completed(node) ⇒ Object

Called at the end a successful Chef run.



36
37
 
# File 'lib/chef/event_dispatch/base.rb', line 36

def run_completed(node)
end

#run_failed(exception) ⇒ Object

Called at the end of a failed Chef run.



40
41
 
# File 'lib/chef/event_dispatch/base.rb', line 40

def run_failed(exception)
end

#run_list_expand_failed(node, exception) ⇒ Object

Error expanding the run list



73
74
 
# File 'lib/chef/event_dispatch/base.rb', line 73

def run_list_expand_failed(node, exception)
end

#run_start(version) ⇒ Object

Called at the very start of a Chef Run



32
33
 
# File 'lib/chef/event_dispatch/base.rb', line 32

def run_start(version)
end

#skipping_registration(node_name, config) ⇒ Object

Already have a client key, assuming this node has registered.



48
49
 
# File 'lib/chef/event_dispatch/base.rb', line 48

def skipping_registration(node_name, config)
end

#synchronized_cookbook(cookbook_name) ⇒ Object

Called when cookbook cookbook_name has been sync’d



114
115
 
# File 'lib/chef/event_dispatch/base.rb', line 114

def synchronized_cookbook(cookbook_name)
end

#updated_cookbook_file(cookbook_name, path) ⇒ Object

Called when an individual file in a cookbook has been updated



118
119
 
# File 'lib/chef/event_dispatch/base.rb', line 118

def updated_cookbook_file(cookbook_name, path)
end

#whyrun_assumption(action, resource, message) ⇒ Object

Called when a provider makes an assumption after a failed assertion in whyrun mode, in order to allow execution to continue



295
296
 
# File 'lib/chef/event_dispatch/base.rb', line 295

def whyrun_assumption(action, resource, message) 
end