class Chef::EventDispatch::Base
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.
Public Instance Methods
Callback hook for handlers to grab a reference to the action_collection (sent before compiling cookbooks, consumers can also find it off the run_context.action_collection)
# File lib/chef/event_dispatch/base.rb, line 268 def action_collection_registration(action_collection); end
Called when an attribute is changed by simple assignment
# File lib/chef/event_dispatch/base.rb, line 391 def attribute_changed(precedence, keys, value); end
Called when an attribute file fails to load.
# File lib/chef/event_dispatch/base.rb, line 228 def attribute_file_load_failed(path, exception); end
Called after the attribute file is loaded
# File lib/chef/event_dispatch/base.rb, line 225 def attribute_file_loaded(path); end
Called when attribute file loading is finished
# File lib/chef/event_dispatch/base.rb, line 231 def attribute_load_complete; end
Called before attribute files are loaded
# File lib/chef/event_dispatch/base.rb, line 222 def attribute_load_start(attribute_file_count); end
Called when a compliance input is enabled (by include_input)
# File lib/chef/event_dispatch/base.rb, line 219 def compliance_input_enabled(input); end
Called when a compliance waiver is found in a cookbook by the cookbook_compiler
# File lib/chef/event_dispatch/base.rb, line 210 def compliance_input_loaded(input); end
Called when compliance file loading ends
# File lib/chef/event_dispatch/base.rb, line 183 def compliance_load_complete; end
Called when compliance file loading starts
# File lib/chef/event_dispatch/base.rb, line 180 def compliance_load_start; end
Called when a compliance profile is enabled (by include_profile)
# File lib/chef/event_dispatch/base.rb, line 213 def compliance_profile_enabled(profile); end
Called when a compliance profile is found in a cookbook by the cookbook_compiler
# File lib/chef/event_dispatch/base.rb, line 204 def compliance_profile_loaded(profile); end
Called when a compliance waiver is enabled (by include_waiver)
# File lib/chef/event_dispatch/base.rb, line 216 def compliance_waiver_enabled(waiver); end
Called when a compliance waiver is found in a cookbook by the cookbook_compiler
# File lib/chef/event_dispatch/base.rb, line 207 def compliance_waiver_loaded(waiver); end
Called when the converge phase is finished.
# File lib/chef/event_dispatch/base.rb, line 271 def converge_complete; end
Called if the converge phase fails
# File lib/chef/event_dispatch/base.rb, line 274 def converge_failed(exception); end
Called before convergence starts
# File lib/chef/event_dispatch/base.rb, line 264 def converge_start(run_context); end
Called when cookbook cleaning is finished.
# File lib/chef/event_dispatch/base.rb, line 104 def cookbook_clean_complete; end
Called before unneeded cookbooks are removed
# File lib/chef/event_dispatch/base.rb, line 96 def cookbook_clean_start; end
This is called after all cookbook compilation phases are completed.
# File lib/chef/event_dispatch/base.rb, line 261 def cookbook_compilation_complete(run_context); end
Called immediately after creating the run_context and before any cookbook compilation happens
# File lib/chef/event_dispatch/base.rb, line 141 def cookbook_compilation_start(run_context); end
Called when cookbook gem installation fails
# File lib/chef/event_dispatch/base.rb, line 134 def cookbook_gem_failed(exception); end
Called when finished installing cookbook gems
# File lib/chef/event_dispatch/base.rb, line 131 def cookbook_gem_finished; end
Called when the result of installing the bundle is to install the gem
# File lib/chef/event_dispatch/base.rb, line 125 def cookbook_gem_installing(gem, version); end
Called when starting to collect gems from the cookbooks
# File lib/chef/event_dispatch/base.rb, line 122 def cookbook_gem_start(gems); end
Called when the result of installing the bundle is to use the gem
# File lib/chef/event_dispatch/base.rb, line 128 def cookbook_gem_using(gem, version); end
Called when the cookbook collection is returned from the server.
# File lib/chef/event_dispatch/base.rb, line 93 def cookbook_resolution_complete(cookbook_collection); end
Called when there is an error getting the cookbook collection from the server.
# File lib/chef/event_dispatch/base.rb, line 90 def cookbook_resolution_failed(expanded_run_list, exception); end
Called before the cookbook collection is fetched from the server.
# File lib/chef/event_dispatch/base.rb, line 86 def cookbook_resolution_start(expanded_run_list); end
Called after all cookbooks have been sync’d.
# File lib/chef/event_dispatch/base.rb, line 119 def cookbook_sync_complete; end
Called when an error occurs during cookbook sync
# File lib/chef/event_dispatch/base.rb, line 116 def cookbook_sync_failed(cookbooks, exception); end
Called before cookbook sync starts
# File lib/chef/event_dispatch/base.rb, line 107 def cookbook_sync_start(cookbook_count); end
Called when a resource definition file fails to load
# File lib/chef/event_dispatch/base.rb, line 240 def definition_file_load_failed(path, exception); end
Called when a resource definition has been loaded
# File lib/chef/event_dispatch/base.rb, line 237 def definition_file_loaded(path); end
Called when resource definitions are done loading
# File lib/chef/event_dispatch/base.rb, line 243 def definition_load_complete; end
Called before resource definitions are loaded
# File lib/chef/event_dispatch/base.rb, line 234 def definition_load_start(definition_file_count); end
Emit a message about something being deprecated.
# File lib/chef/event_dispatch/base.rb, line 379 def deprecation(message, location = caller(2..2)[0]); end
Called after an individual handler has run
# File lib/chef/event_dispatch/base.rb, line 366 def handler_executed(handler); end
Called after all handlers have executed
# File lib/chef/event_dispatch/base.rb, line 369 def handlers_completed; end
Called before handlers run
# File lib/chef/event_dispatch/base.rb, line 363 def handlers_start(handler_count); end
Called when compliance input loading end
# File lib/chef/event_dispatch/base.rb, line 195 def inputs_load_complete; end
Called when compliance input loading starts
# File lib/chef/event_dispatch/base.rb, line 192 def inputs_load_start; end
Called when migrating from a pem on disk to a pem stored in Keychain or Windows Certstore
# File lib/chef/event_dispatch/base.rb, line 277 def key_migration_status(key_migrated = false); end
Called when a library file has an error on load.
# File lib/chef/event_dispatch/base.rb, line 150 def library_file_load_failed(path, exception); end
Called when library file has been loaded
# File lib/chef/event_dispatch/base.rb, line 147 def library_file_loaded(path); end
Called when library file loading has finished
# File lib/chef/event_dispatch/base.rb, line 153 def library_load_complete; end
Called when library file loading starts
# File lib/chef/event_dispatch/base.rb, line 144 def library_load_start(file_count); end
Called after a LWR or LWP file errors on load
# File lib/chef/event_dispatch/base.rb, line 162 def lwrp_file_load_failed(path, exception); end
Called after a LWR or LWP has been loaded
# File lib/chef/event_dispatch/base.rb, line 159 def lwrp_file_loaded(path); end
Called when LWRPs are finished loading
# File lib/chef/event_dispatch/base.rb, line 165 def lwrp_load_complete; end
Called when LWRP loading starts
# File lib/chef/event_dispatch/base.rb, line 156 def lwrp_load_start(lwrp_file_count); end
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.
# File lib/chef/event_dispatch/base.rb, line 388 def msg(message); end
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.
# File lib/chef/event_dispatch/base.rb, line 79 def node_load_completed(node, expanded_run_list, config); end
Failed to load node data from the server
# File lib/chef/event_dispatch/base.rb, line 71 def node_load_failed(node_name, exception, config); end
Called before Chef
client loads the node data from the server
# File lib/chef/event_dispatch/base.rb, line 63 def node_load_start(node_name, config); end
Called once the node is loaded by the policy builder
# File lib/chef/event_dispatch/base.rb, line 68 def node_load_success(node); end
Called right after ohai runs. NOTE: the node object here is always nil because of when it is called
# File lib/chef/event_dispatch/base.rb, line 44 def ohai_completed(node); end
Called when an ohai plugin file has an error on load.
# File lib/chef/event_dispatch/base.rb, line 174 def ohai_plugin_file_load_failed(path, exception); end
Called when an ohai plugin file has been loaded
# File lib/chef/event_dispatch/base.rb, line 171 def ohai_plugin_file_loaded(path); end
Called when ohai plugin file loading has finished
# File lib/chef/event_dispatch/base.rb, line 177 def ohai_plugin_load_complete; end
Called when ohai plugin file loading starts
# File lib/chef/event_dispatch/base.rb, line 168 def ohai_plugin_load_start(file_count); end
Called after the Policyfile was loaded. This event only occurs when chef is in policyfile mode.
# File lib/chef/event_dispatch/base.rb, line 83 def policyfile_loaded(policy); end
Called when compliance profile loading end
# File lib/chef/event_dispatch/base.rb, line 189 def profiles_load_complete; end
Called when compliance profile loading starts
# File lib/chef/event_dispatch/base.rb, line 186 def profiles_load_start; end
Called when an assertion declared by a provider fails
# File lib/chef/event_dispatch/base.rb, line 372 def provider_requirement_failed(action, resource, exception, message); end
Called after a recipe file fails to load
# File lib/chef/event_dispatch/base.rb, line 252 def recipe_file_load_failed(path, exception, recipe); end
Called after the recipe has been loaded
# File lib/chef/event_dispatch/base.rb, line 249 def recipe_file_loaded(path, recipe); end
Called when recipes have been loaded.
# File lib/chef/event_dispatch/base.rb, line 258 def recipe_load_complete; end
Called before recipes are loaded
# File lib/chef/event_dispatch/base.rb, line 246 def recipe_load_start(recipe_count); end
Called when a recipe cannot be resolved
# File lib/chef/event_dispatch/base.rb, line 255 def recipe_not_found(exception); end
Successfully created the private key and registered this client with the server.
# File lib/chef/event_dispatch/base.rb, line 57 def registration_completed; end
Failed to register this client with the server.
# File lib/chef/event_dispatch/base.rb, line 60 def registration_failed(node_name, exception, config); end
About to attempt to create a private key registered to the server with client node_name
.
# File lib/chef/event_dispatch/base.rb, line 53 def registration_start(node_name, config); end
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.
# File lib/chef/event_dispatch/base.rb, line 101 def removed_cookbook_file(path); end
Called before action is executed on a resource.
# File lib/chef/event_dispatch/base.rb, line 307 def resource_action_start(resource, action, notification_type = nil, notifier = nil); end
Called after load_after_resource has run.
# File lib/chef/event_dispatch/base.rb, line 316 def resource_after_state_loaded(resource, action, after_resource); end
Called when evaluating a resource that does not support whyrun in whyrun mode
# File lib/chef/event_dispatch/base.rb, line 323 def resource_bypassed(resource, action, current_resource); end
Called when a resource action has been completed
# File lib/chef/event_dispatch/base.rb, line 349 def resource_completed(resource); end
Called when resource current state load is skipped due to the provider not supporting whyrun mode.
# File lib/chef/event_dispatch/base.rb, line 320 def resource_current_state_load_bypassed(resource, action, current_resource); end
Called after load_current_resource
has run.
# File lib/chef/event_dispatch/base.rb, line 313 def resource_current_state_loaded(resource, action, current_resource); end
Called when a resource fails and will not be retried.
# File lib/chef/event_dispatch/base.rb, line 339 def resource_failed(resource, action, exception); end
Called when a resource fails, but will retry.
# File lib/chef/event_dispatch/base.rb, line 336 def resource_failed_retriable(resource, action, retry_count, exception); end
Called when a resource action has been skipped b/c of a conditional
# File lib/chef/event_dispatch/base.rb, line 310 def resource_skipped(resource, action, conditional); end
Called when a resource has no converge actions, e.g., it was already correct.
# File lib/chef/event_dispatch/base.rb, line 346 def resource_up_to_date(resource, action); end
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.
# File lib/chef/event_dispatch/base.rb, line 328 def resource_update_applied(resource, action, update); end
Called when a progress notification should be sent to the user to indicate the overall progress of a long running operation, such as a large file download.
# File lib/chef/event_dispatch/base.rb, line 333 def resource_update_progress(resource, current, total, interval); end
Called after a resource has been completely converged, but only if modifications were made.
# File lib/chef/event_dispatch/base.rb, line 343 def resource_updated(resource, action); end
Called at the end a successful Chef
run.
# File lib/chef/event_dispatch/base.rb, line 37 def run_completed(node, run_status); end
Called at the end of a failed Chef
run.
# File lib/chef/event_dispatch/base.rb, line 40 def run_failed(exception, run_status); end
Error expanding the run list
# File lib/chef/event_dispatch/base.rb, line 74 def run_list_expand_failed(node, exception); end
# File lib/chef/event_dispatch/base.rb, line 381 def run_list_expanded(run_list_expansion); end
Called at the very start of a Chef
Run
# File lib/chef/event_dispatch/base.rb, line 32 def run_start(version, run_status); end
# File lib/chef/event_dispatch/base.rb, line 34 def run_started(run_status); end
Announce that we’re not going to register the client. Generally because we already have the private key, or because we’re deliberately not using a key.
# File lib/chef/event_dispatch/base.rb, line 49 def skipping_registration(node_name, config); end
A stream has closed.
# File lib/chef/event_dispatch/base.rb, line 355 def stream_closed(stream, options = {}); end
A stream has opened.
# File lib/chef/event_dispatch/base.rb, line 352 def stream_opened(stream, options = {}); end
A chunk of data from a stream. The stream is managed by “stream,” which can be any tag whatsoever. Data in different “streams” may not be placed on the same line or even sent to the same console.
# File lib/chef/event_dispatch/base.rb, line 360 def stream_output(stream, output, options = {}); end
Called when cookbook cookbook
has been sync’d
# File lib/chef/event_dispatch/base.rb, line 110 def synchronized_cookbook(cookbook_name, cookbook); end
Called when an individual file in a cookbook has been updated
# File lib/chef/event_dispatch/base.rb, line 113 def updated_cookbook_file(cookbook_name, path); end
Called when compliance waiver loading end
# File lib/chef/event_dispatch/base.rb, line 201 def waivers_load_complete; end
Called when compliance waiver loading starts
# File lib/chef/event_dispatch/base.rb, line 198 def waivers_load_start; end
Called when a provider makes an assumption after a failed assertion in whyrun mode, in order to allow execution to continue
# File lib/chef/event_dispatch/base.rb, line 376 def whyrun_assumption(action, resource, message); end