Class: Chef::ResourceReporter
Defined Under Namespace
Classes: ResourceReport
Constant Summary
collapse
- PROTOCOL_VERSION =
"0.1.0"
Instance Attribute Summary collapse
Instance Method Summary
collapse
-
#cookbook_resolution_failed(expanded_run_list, exception) ⇒ Object
-
#cookbook_sync_failed(cookbooks, exception) ⇒ Object
-
#end_time ⇒ Object
-
#handle_error_starting_run(e, url) ⇒ Object
-
#headers(additional_headers = {}) ⇒ Object
-
#initialize(rest_client) ⇒ ResourceReporter
constructor
A new instance of ResourceReporter.
-
#node_name ⇒ Object
-
#post_reporting_data ⇒ Object
-
#prepare_run_data ⇒ Object
-
#reporting_enabled? ⇒ Boolean
-
#resource_completed(new_resource) ⇒ Object
-
#resource_current_state_loaded(new_resource, action, current_resource) ⇒ Object
-
#resource_failed(new_resource, action, exception) ⇒ Object
-
#resource_skipped(resource, action, conditional) ⇒ Object
-
#resource_up_to_date(new_resource, action) ⇒ Object
-
#resource_updated(new_resource, action) ⇒ Object
-
#run_completed(node) ⇒ Object
-
#run_failed(exception) ⇒ Object
-
#run_list_expand_failed(node, exception) ⇒ Object
-
#run_list_expanded(run_list_expansion) ⇒ Object
-
#run_started(run_status) ⇒ Object
-
#start_time ⇒ Object
#attribute_file_load_failed, #attribute_file_loaded, #attribute_load_complete, #attribute_load_start, #audit_phase_complete, #audit_phase_failed, #audit_phase_start, #control_example_failure, #control_example_success, #control_group_started, #converge_complete, #converge_failed, #converge_start, #cookbook_clean_complete, #cookbook_clean_start, #cookbook_gem_failed, #cookbook_gem_finished, #cookbook_gem_installing, #cookbook_gem_start, #cookbook_gem_using, #cookbook_resolution_complete, #cookbook_resolution_start, #cookbook_sync_complete, #cookbook_sync_start, #definition_file_load_failed, #definition_file_loaded, #definition_load_complete, #definition_load_start, #deprecation, #handler_executed, #handlers_completed, #handlers_start, #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, #ohai_completed, #policyfile_loaded, #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_bypassed, #resource_current_state_load_bypassed, #resource_failed_retriable, #resource_update_applied, #resource_update_progress, #run_start, #skipping_registration, #stream_closed, #stream_opened, #stream_output, #synchronized_cookbook, #updated_cookbook_file, #whyrun_assumption
Constructor Details
Returns a new instance of ResourceReporter.
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
# File 'lib/chef/resource_reporter.rb', line 102
def initialize(rest_client)
if Chef::Config[:enable_reporting] && !Chef::Config[:why_run]
@reporting_enabled = true
else
@reporting_enabled = false
end
@updated_resources = []
@total_res_count = 0
@pending_update = nil
@status = "success"
@exception = nil
@rest_client = rest_client
@error_descriptions = {}
@expanded_run_list = {}
end
|
Instance Attribute Details
#error_descriptions ⇒ Object
Returns the value of attribute error_descriptions.
98
99
100
|
# File 'lib/chef/resource_reporter.rb', line 98
def error_descriptions
@error_descriptions
end
|
#exception ⇒ Object
Returns the value of attribute exception.
96
97
98
|
# File 'lib/chef/resource_reporter.rb', line 96
def exception
@exception
end
|
#run_id ⇒ Object
Returns the value of attribute run_id.
97
98
99
|
# File 'lib/chef/resource_reporter.rb', line 97
def run_id
@run_id
end
|
#status ⇒ Object
Returns the value of attribute status.
95
96
97
|
# File 'lib/chef/resource_reporter.rb', line 95
def status
@status
end
|
#updated_resources ⇒ Object
94
95
96
|
# File 'lib/chef/resource_reporter.rb', line 94
def updated_resources
@updated_resources
end
|
Instance Method Details
#cookbook_resolution_failed(expanded_run_list, exception) ⇒ Object
296
297
298
299
|
# File 'lib/chef/resource_reporter.rb', line 296
def cookbook_resolution_failed(expanded_run_list, exception)
description = Formatters::ErrorMapper.cookbook_resolution_failed(expanded_run_list, exception)
@error_descriptions = description.for_json
end
|
#cookbook_sync_failed(cookbooks, exception) ⇒ Object
301
302
303
304
|
# File 'lib/chef/resource_reporter.rb', line 301
def cookbook_sync_failed(cookbooks, exception)
description = Formatters::ErrorMapper.cookbook_sync_failed(cookbooks, exception)
@error_descriptions = description.for_json
end
|
#end_time ⇒ Object
262
263
264
|
# File 'lib/chef/resource_reporter.rb', line 262
def end_time
@run_status.end_time
end
|
#handle_error_starting_run(e, url) ⇒ Object
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
# File 'lib/chef/resource_reporter.rb', line 132
def handle_error_starting_run(e, url)
message = "Reporting error starting run. URL: #{url} "
code = if e.response.code
e.response.code.to_s
else
"Exception Code Empty"
end
if !e.response || (code != "404" && code != "406")
exception = "Exception: #{code} "
if Chef::Config[:enable_reporting_url_fatals]
reporting_status = "Reporting fatals enabled. Aborting run. "
Chef::Log.error(message + exception + reporting_status)
raise
else
reporting_status = "Disabling reporting for run."
Chef::Log.info(message + exception + reporting_status)
end
else
reason = "Received #{code}. "
if code == "406"
reporting_status = "Client version not supported. Please update the client. Disabling reporting for run."
Chef::Log.info(message + reason + reporting_status)
else
reporting_status = "Disabling reporting for run."
Chef::Log.debug(message + reason + reporting_status)
end
end
@reporting_enabled = false
end
|
249
250
251
252
|
# File 'lib/chef/resource_reporter.rb', line 249
def ( = {})
options = { "X-Ops-Reporting-Protocol-Version" => PROTOCOL_VERSION }
options.merge()
end
|
#node_name ⇒ Object
254
255
256
|
# File 'lib/chef/resource_reporter.rb', line 254
def node_name
@run_status.node.name
end
|
#post_reporting_data ⇒ Object
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
# File 'lib/chef/resource_reporter.rb', line 225
def post_reporting_data
if reporting_enabled?
run_data = prepare_run_data
resource_history_url = "reports/nodes/#{node_name}/runs/#{run_id}"
Chef::Log.info("Sending resource update report (run-id: #{run_id})")
Chef::Log.debug run_data.inspect
compressed_data = encode_gzip(Chef::JSONCompat.to_json(run_data))
Chef::Log.debug("Sending compressed run data...")
begin
@rest_client.raw_request(:POST, resource_history_url, ({ "Content-Encoding" => "gzip" }), compressed_data)
rescue StandardError => e
if e.respond_to? :response
Chef::FileCache.store("failed-reporting-data.json", Chef::JSONCompat.to_json_pretty(run_data), 0640)
Chef::Log.error("Failed to post reporting data to server (HTTP #{e.response.code}), saving to #{Chef::FileCache.load("failed-reporting-data.json", false)}")
else
Chef::Log.error("Failed to post reporting data to server (#{e})")
end
end
else
Chef::Log.debug("Server doesn't support resource history, skipping resource report.")
end
end
|
#prepare_run_data ⇒ Object
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
# File 'lib/chef/resource_reporter.rb', line 266
def prepare_run_data
run_data = {}
run_data["action"] = "end"
run_data["resources"] = updated_resources.map do |resource_record|
resource_record.for_json
end
run_data["status"] = @status
run_data["run_list"] = Chef::JSONCompat.to_json(@run_status.node.run_list)
run_data["total_res_count"] = @total_res_count.to_s
run_data["data"] = {}
run_data["start_time"] = start_time.to_s
run_data["end_time"] = end_time.to_s
run_data["expanded_run_list"] = Chef::JSONCompat.to_json(@expanded_run_list)
if exception
exception_data = {}
exception_data["class"] = exception.inspect
exception_data["message"] = exception.message
exception_data["backtrace"] = Chef::JSONCompat.to_json(exception.backtrace)
exception_data["description"] = @error_descriptions
run_data["data"]["exception"] = exception_data
end
run_data
end
|
#reporting_enabled? ⇒ Boolean
306
307
308
|
# File 'lib/chef/resource_reporter.rb', line 306
def reporting_enabled?
@reporting_enabled
end
|
#resource_completed(new_resource) ⇒ Object
198
199
200
201
202
203
204
|
# File 'lib/chef/resource_reporter.rb', line 198
def resource_completed(new_resource)
if @pending_update && !nested_resource?(new_resource)
@pending_update.finish
@updated_resources << @pending_update
@pending_update = nil
end
end
|
#resource_current_state_loaded(new_resource, action, current_resource) ⇒ Object
168
169
170
171
172
|
# File 'lib/chef/resource_reporter.rb', line 168
def resource_current_state_loaded(new_resource, action, current_resource)
unless nested_resource?(new_resource)
@pending_update = ResourceReport.new_with_current_state(new_resource, action, current_resource)
end
end
|
#resource_failed(new_resource, action, exception) ⇒ Object
188
189
190
191
192
193
194
195
196
|
# File 'lib/chef/resource_reporter.rb', line 188
def resource_failed(new_resource, action, exception)
@total_res_count += 1
unless nested_resource?(new_resource)
@pending_update ||= ResourceReport.new_for_exception(new_resource, action)
@pending_update.exception = exception
end
description = Formatters::ErrorMapper.resource_failed(new_resource, action, exception)
@error_descriptions = description.for_json
end
|
#resource_skipped(resource, action, conditional) ⇒ Object
179
180
181
182
|
# File 'lib/chef/resource_reporter.rb', line 179
def resource_skipped(resource, action, conditional)
@total_res_count += 1
@pending_update = nil unless nested_resource?(resource)
end
|
#resource_up_to_date(new_resource, action) ⇒ Object
174
175
176
177
|
# File 'lib/chef/resource_reporter.rb', line 174
def resource_up_to_date(new_resource, action)
@total_res_count += 1
@pending_update = nil unless nested_resource?(new_resource)
end
|
#resource_updated(new_resource, action) ⇒ Object
184
185
186
|
# File 'lib/chef/resource_reporter.rb', line 184
def resource_updated(new_resource, action)
@total_res_count += 1
end
|
#run_completed(node) ⇒ Object
206
207
208
209
|
# File 'lib/chef/resource_reporter.rb', line 206
def run_completed(node)
@status = "success"
post_reporting_data
end
|
#run_failed(exception) ⇒ Object
211
212
213
214
215
216
217
218
219
|
# File 'lib/chef/resource_reporter.rb', line 211
def run_failed(exception)
@exception = exception
@status = "failure"
if @run_status
post_reporting_data
end
end
|
#run_list_expand_failed(node, exception) ⇒ Object
291
292
293
294
|
# File 'lib/chef/resource_reporter.rb', line 291
def run_list_expand_failed(node, exception)
description = Formatters::ErrorMapper.run_list_expand_failed(node, exception)
@error_descriptions = description.for_json
end
|
#run_list_expanded(run_list_expansion) ⇒ Object
221
222
223
|
# File 'lib/chef/resource_reporter.rb', line 221
def run_list_expanded(run_list_expansion)
@expanded_run_list = run_list_expansion
end
|
#run_started(run_status) ⇒ Object
118
119
120
121
122
123
124
125
126
127
128
129
130
|
# File 'lib/chef/resource_reporter.rb', line 118
def run_started(run_status)
@run_status = run_status
if reporting_enabled?
begin
resource_history_url = "reports/nodes/#{node_name}/runs"
server_response = @rest_client.post(resource_history_url, { :action => :start, :run_id => run_id,
:start_time => start_time.to_s }, )
rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
handle_error_starting_run(e, resource_history_url)
end
end
end
|
#start_time ⇒ Object
258
259
260
|
# File 'lib/chef/resource_reporter.rb', line 258
def start_time
@run_status.start_time
end
|