chef-reporting 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +1 -0
- data/Gemfile +5 -0
- data/LICENSE +201 -0
- data/Makefile +7 -0
- data/README.md +72 -0
- data/chef-reporting.gemspec +20 -0
- data/lib/chef_reporting.rb +19 -0
- data/lib/chef_reporting/resource_reporter.rb +320 -0
- data/lib/chef_reporting/start_handler.rb +48 -0
- data/lib/chef_reporting/version.rb +23 -0
- metadata +72 -0
data/.gitignore
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
*.gem
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/Makefile
ADDED
data/README.md
ADDED
@@ -0,0 +1,72 @@
|
|
1
|
+
# chef-reporting
|
2
|
+
|
3
|
+
## Overview
|
4
|
+
|
5
|
+
This gem contains an event handler for Chef that allows older (< 11.6.0)
|
6
|
+
version of chef to publish reporting information to Opscode Hosted Chef
|
7
|
+
or Opscode Private Chef.
|
8
|
+
|
9
|
+
## Configuration
|
10
|
+
|
11
|
+
There are 2 different methods on how to install the handler:
|
12
|
+
|
13
|
+
### Option A - Configuration using the `chef-client` cookbook
|
14
|
+
The `chef-client` cookbook is able to automatically install and
|
15
|
+
configure gems used for start and event handlers:
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
node.set['chef_client']['load_gems']['chef-reporting'] = {
|
19
|
+
:require_name => 'chef_reporting',
|
20
|
+
:action => :install
|
21
|
+
}
|
22
|
+
|
23
|
+
node.set['chef_client']['start_handlers'] = [
|
24
|
+
{
|
25
|
+
:class => "Chef::Reporting::StartHandler",
|
26
|
+
:arguments => []
|
27
|
+
}
|
28
|
+
]
|
29
|
+
include_recipe "chef-client::config"
|
30
|
+
```
|
31
|
+
|
32
|
+
### Option B - Direct Configuration by modifying client.rb
|
33
|
+
You can also do the same configuration e.g. as part of your bootstrap
|
34
|
+
process if you want to have the first client run on the host send data
|
35
|
+
to reporting.
|
36
|
+
|
37
|
+
#### Loading the gem
|
38
|
+
The `chef-reporting` gem is required to be loaded. You can do this is a
|
39
|
+
`gem install` before running Chef if you want the first client run to
|
40
|
+
report or else use the `chef_gem` resource to install the gem on first
|
41
|
+
chef-client run.
|
42
|
+
|
43
|
+
```ruby
|
44
|
+
chef_gem "chef-reporting" do
|
45
|
+
action :install
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
#### Loading the gem and configuring the event handler in `client.rb`
|
50
|
+
|
51
|
+
The Event Handler should be configured in your `client.rb` to enable the
|
52
|
+
handler. Copy the following block to the top of your `client.rb`.
|
53
|
+
|
54
|
+
```ruby
|
55
|
+
begin
|
56
|
+
require chef_reporting
|
57
|
+
start_handlers << Chef::Reporting::StartHandler.new()
|
58
|
+
rescue LoadError
|
59
|
+
Chef::Log.warn "Failed to load #{lib}. This should be resolved after a chef run."
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
|
64
|
+
## Licence and Author
|
65
|
+
|
66
|
+
Chef Reporting - A client library for Chef Reporting features
|
67
|
+
|
68
|
+
| | |
|
69
|
+
|:---------------------|:-----------------------------------------|
|
70
|
+
| **Author:** | James Casey (<james@opscode.com>)
|
71
|
+
| **Copyright:** | Copyright (c) 2012-2013 Opscode, Inc.
|
72
|
+
| **License:** | Apache License, Version 2.0
|
@@ -0,0 +1,20 @@
|
|
1
|
+
lib = File.expand_path('../lib', __FILE__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
require 'chef_reporting/version'
|
4
|
+
|
5
|
+
Gem::Specification.new do |gem|
|
6
|
+
gem.name = 'chef-reporting'
|
7
|
+
gem.version = Chef::Reporting::VERSION
|
8
|
+
gem.license = "Apache 2.0"
|
9
|
+
gem.author = "Opscode"
|
10
|
+
gem.email = "info@opscode.com"
|
11
|
+
gem.description = "Backport of Chef Reporting handler for Chef < 11.6.0"
|
12
|
+
gem.summary = gem.description
|
13
|
+
gem.homepage = "https://github.com/opscode/chef-reporting"
|
14
|
+
|
15
|
+
gem.files = `git ls-files`.split($/)
|
16
|
+
gem.require_paths = ["lib"]
|
17
|
+
|
18
|
+
# TODO - Can we relax this dependency
|
19
|
+
gem.add_dependency "chef", ">= 11.0.0"
|
20
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
#
|
2
|
+
# Copyright:: Copyright (c) 2013 Opscode, Inc.
|
3
|
+
# License:: Apache License, Version 2.0
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
#
|
17
|
+
|
18
|
+
require 'chef_reporting/start_handler'
|
19
|
+
require 'chef_reporting/resource_reporter'
|
@@ -0,0 +1,320 @@
|
|
1
|
+
#
|
2
|
+
# Author:: Daniel DeLeo (<dan@opscode.com>)
|
3
|
+
# Author:: Prajakta Purohit (prajakta@opscode.com>)
|
4
|
+
# Auther:: Tyler Cloke (<tyler@opscode.com>)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright (c) 2012-13 Opscode, Inc.
|
7
|
+
# License:: Apache License, Version 2.0
|
8
|
+
#
|
9
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
10
|
+
# you may not use this file except in compliance with the License.
|
11
|
+
# You may obtain a copy of the License at
|
12
|
+
#
|
13
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
14
|
+
#
|
15
|
+
# Unless required by applicable law or agreed to in writing, software
|
16
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
17
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
18
|
+
# See the License for the specific language governing permissions and
|
19
|
+
# limitations under the License.
|
20
|
+
#
|
21
|
+
|
22
|
+
require 'uri'
|
23
|
+
require 'chef/event_dispatch/base'
|
24
|
+
|
25
|
+
class Chef
|
26
|
+
class Reporting
|
27
|
+
class ResourceReporter < Chef::EventDispatch::Base
|
28
|
+
class ResourceReport < Struct.new(:new_resource,
|
29
|
+
:current_resource,
|
30
|
+
:action,
|
31
|
+
:exception,
|
32
|
+
:elapsed_time)
|
33
|
+
|
34
|
+
def self.new_with_current_state(new_resource, action, current_resource)
|
35
|
+
report = new
|
36
|
+
report.new_resource = new_resource
|
37
|
+
report.action = action
|
38
|
+
report.current_resource = current_resource
|
39
|
+
report
|
40
|
+
end
|
41
|
+
|
42
|
+
def self.new_for_exception(new_resource, action)
|
43
|
+
report = new
|
44
|
+
report.new_resource = new_resource
|
45
|
+
report.action = action
|
46
|
+
report
|
47
|
+
end
|
48
|
+
|
49
|
+
def for_json
|
50
|
+
as_hash = {}
|
51
|
+
as_hash["type"] = new_resource.class.dsl_name
|
52
|
+
as_hash["name"] = new_resource.name
|
53
|
+
as_hash["id"] = new_resource.identity
|
54
|
+
as_hash["after"] = new_resource.state
|
55
|
+
as_hash["before"] = current_resource ? current_resource.state : {}
|
56
|
+
as_hash["duration"] = (elapsed_time * 1000).to_i.to_s
|
57
|
+
as_hash["delta"] = new_resource.diff if new_resource.respond_to?("diff")
|
58
|
+
as_hash["delta"] = "" if as_hash["delta"].nil?
|
59
|
+
|
60
|
+
# TODO: rename as "action"
|
61
|
+
as_hash["result"] = action.to_s
|
62
|
+
if success?
|
63
|
+
else
|
64
|
+
#as_hash["result"] = "failed"
|
65
|
+
end
|
66
|
+
as_hash["cookbook_name"] = new_resource.cookbook_name
|
67
|
+
as_hash["cookbook_version"] = new_resource.cookbook_version.version
|
68
|
+
as_hash
|
69
|
+
end
|
70
|
+
|
71
|
+
def finish
|
72
|
+
self.elapsed_time = new_resource.elapsed_time
|
73
|
+
end
|
74
|
+
|
75
|
+
def success?
|
76
|
+
!self.exception
|
77
|
+
end
|
78
|
+
|
79
|
+
end # End class ResouceReport
|
80
|
+
|
81
|
+
attr_reader :updated_resources
|
82
|
+
attr_reader :status
|
83
|
+
attr_reader :exception
|
84
|
+
attr_reader :run_id
|
85
|
+
attr_reader :error_descriptions
|
86
|
+
|
87
|
+
PROTOCOL_VERSION = '0.1.0'
|
88
|
+
|
89
|
+
def initialize(rest_client)
|
90
|
+
if Chef::Config[:enable_reporting] && !Chef::Config[:why_run]
|
91
|
+
@reporting_enabled = true
|
92
|
+
else
|
93
|
+
@reporting_enabled = false
|
94
|
+
end
|
95
|
+
@updated_resources = []
|
96
|
+
@total_res_count = 0
|
97
|
+
@pending_update = nil
|
98
|
+
@status = "success"
|
99
|
+
@exception = nil
|
100
|
+
begin
|
101
|
+
@run_id = uuid
|
102
|
+
rescue LoadError
|
103
|
+
Chef::Log.debug("Can't load SecureRandom - disabling resource_reporter")
|
104
|
+
@reporting_enabled = false
|
105
|
+
end
|
106
|
+
@rest_client = rest_client
|
107
|
+
@error_descriptions = {}
|
108
|
+
end
|
109
|
+
|
110
|
+
def run_started(run_status)
|
111
|
+
@run_status = run_status
|
112
|
+
|
113
|
+
if reporting_enabled?
|
114
|
+
begin
|
115
|
+
resource_history_url = "reports/nodes/#{node_name}/runs"
|
116
|
+
server_response = @rest_client.post_rest(resource_history_url, {:action => :start, :run_id => @run_id,
|
117
|
+
:start_time => start_time.to_s}, headers)
|
118
|
+
rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
|
119
|
+
handle_error_starting_run(e, resource_history_url)
|
120
|
+
end
|
121
|
+
end
|
122
|
+
end
|
123
|
+
|
124
|
+
def handle_error_starting_run(e, url)
|
125
|
+
message = "Reporting error starting run. URL: #{url} "
|
126
|
+
code = if e.response.code
|
127
|
+
e.response.code.to_s
|
128
|
+
else
|
129
|
+
"Exception Code Empty"
|
130
|
+
end
|
131
|
+
|
132
|
+
if !e.response || (code != "404" && code != "406")
|
133
|
+
exception = "Exception: #{code} "
|
134
|
+
if Chef::Config[:enable_reporting_url_fatals]
|
135
|
+
reporting_status = "Reporting fatals enabled. Aborting run. "
|
136
|
+
Chef::Log.error(message + exception + reporting_status)
|
137
|
+
raise
|
138
|
+
else
|
139
|
+
reporting_status = "Disabling reporting for run."
|
140
|
+
Chef::Log.info(message + exception + reporting_status)
|
141
|
+
end
|
142
|
+
else
|
143
|
+
reason = "Received #{code}. "
|
144
|
+
if code == "406"
|
145
|
+
reporting_status = "Client version not supported. Please update the client. Disabling reporting for run."
|
146
|
+
Chef::Log.info(message + reason + reporting_status)
|
147
|
+
else
|
148
|
+
reporting_status = "Disabling reporting for run."
|
149
|
+
Chef::Log.debug(message + reason + reporting_status)
|
150
|
+
end
|
151
|
+
end
|
152
|
+
|
153
|
+
@reporting_enabled = false
|
154
|
+
end
|
155
|
+
|
156
|
+
def resource_current_state_loaded(new_resource, action, current_resource)
|
157
|
+
unless nested_resource?(new_resource)
|
158
|
+
@pending_update = ResourceReport.new_with_current_state(new_resource, action, current_resource)
|
159
|
+
end
|
160
|
+
end
|
161
|
+
|
162
|
+
def resource_up_to_date(new_resource, action)
|
163
|
+
@total_res_count += 1
|
164
|
+
@pending_update = nil unless nested_resource?(new_resource)
|
165
|
+
end
|
166
|
+
|
167
|
+
def resource_skipped(resource, action, conditional)
|
168
|
+
@total_res_count += 1
|
169
|
+
@pending_update = nil unless nested_resource?(resource)
|
170
|
+
end
|
171
|
+
|
172
|
+
def resource_updated(new_resource, action)
|
173
|
+
@total_res_count += 1
|
174
|
+
end
|
175
|
+
|
176
|
+
def resource_failed(new_resource, action, exception)
|
177
|
+
@total_res_count += 1
|
178
|
+
unless nested_resource?(new_resource)
|
179
|
+
@pending_update ||= ResourceReport.new_for_exception(new_resource, action)
|
180
|
+
@pending_update.exception = exception
|
181
|
+
end
|
182
|
+
description = Formatters::ErrorMapper.resource_failed(new_resource, action, exception)
|
183
|
+
@error_descriptions = description.for_json
|
184
|
+
end
|
185
|
+
|
186
|
+
def resource_completed(new_resource)
|
187
|
+
if @pending_update && !nested_resource?(new_resource)
|
188
|
+
@pending_update.finish
|
189
|
+
@updated_resources << @pending_update
|
190
|
+
@pending_update = nil
|
191
|
+
end
|
192
|
+
end
|
193
|
+
|
194
|
+
def run_completed(node)
|
195
|
+
@status = "success"
|
196
|
+
post_reporting_data
|
197
|
+
end
|
198
|
+
|
199
|
+
def run_failed(exception)
|
200
|
+
@exception = exception
|
201
|
+
@status = "failure"
|
202
|
+
# If we failed before we received the run_started callback, there's not much we can do
|
203
|
+
# in terms of reporting
|
204
|
+
if @run_status
|
205
|
+
post_reporting_data
|
206
|
+
end
|
207
|
+
end
|
208
|
+
|
209
|
+
def post_reporting_data
|
210
|
+
if reporting_enabled?
|
211
|
+
run_data = prepare_run_data
|
212
|
+
resource_history_url = "reports/nodes/#{node_name}/runs/#{@run_id}"
|
213
|
+
Chef::Log.info("Sending resource update report (run-id: #{@run_id})")
|
214
|
+
Chef::Log.debug run_data.inspect
|
215
|
+
compressed_data = encode_gzip(run_data.to_json)
|
216
|
+
begin
|
217
|
+
Chef::Log.debug("Sending compressed run data...")
|
218
|
+
# Since we're posting compressed data we can not directly call post_rest which expects JSON
|
219
|
+
reporting_url = @rest_client.create_url(resource_history_url)
|
220
|
+
@rest_client.raw_http_request(:POST, reporting_url, headers({'Content-Encoding' => 'gzip'}), compressed_data)
|
221
|
+
rescue Net::HTTPServerException => e
|
222
|
+
if e.response.code.to_s == "400"
|
223
|
+
Chef::FileCache.store("failed-reporting-data.json", Chef::JSONCompat.to_json_pretty(run_data), 0640)
|
224
|
+
Chef::Log.error("Failed to post reporting data to server (HTTP 400), saving to #{Chef::FileCache.load("failed-reporting-data.json", false)}")
|
225
|
+
else
|
226
|
+
Chef::Log.error("Failed to post reporting data to server (HTTP #{e.response.code.to_s})")
|
227
|
+
end
|
228
|
+
end
|
229
|
+
else
|
230
|
+
Chef::Log.debug("Server doesn't support resource history, skipping resource report.")
|
231
|
+
end
|
232
|
+
end
|
233
|
+
|
234
|
+
def headers(additional_headers = {})
|
235
|
+
options = {'X-Ops-Reporting-Protocol-Version' => PROTOCOL_VERSION}
|
236
|
+
options.merge(additional_headers)
|
237
|
+
end
|
238
|
+
|
239
|
+
def node_name
|
240
|
+
@run_status.node.name
|
241
|
+
end
|
242
|
+
|
243
|
+
def start_time
|
244
|
+
@run_status.start_time
|
245
|
+
end
|
246
|
+
|
247
|
+
def end_time
|
248
|
+
@run_status.end_time
|
249
|
+
end
|
250
|
+
|
251
|
+
def prepare_run_data
|
252
|
+
run_data = {}
|
253
|
+
run_data["action"] = "end"
|
254
|
+
run_data["resources"] = updated_resources.map do |resource_record|
|
255
|
+
resource_record.for_json
|
256
|
+
end
|
257
|
+
run_data["status"] = @status
|
258
|
+
run_data["run_list"] = @run_status.node.run_list.to_json
|
259
|
+
run_data["total_res_count"] = @total_res_count.to_s
|
260
|
+
run_data["data"] = {}
|
261
|
+
run_data["start_time"] = start_time.to_s
|
262
|
+
run_data["end_time"] = end_time.to_s
|
263
|
+
|
264
|
+
if exception
|
265
|
+
exception_data = {}
|
266
|
+
exception_data["class"] = exception.inspect
|
267
|
+
exception_data["message"] = exception.message
|
268
|
+
exception_data["backtrace"] = exception.backtrace.to_json
|
269
|
+
exception_data["description"] = @error_descriptions
|
270
|
+
run_data["data"]["exception"] = exception_data
|
271
|
+
end
|
272
|
+
run_data
|
273
|
+
end
|
274
|
+
|
275
|
+
def run_list_expand_failed(node, exception)
|
276
|
+
description = Formatters::ErrorMapper.run_list_expand_failed(node, exception)
|
277
|
+
@error_descriptions = description.for_json
|
278
|
+
end
|
279
|
+
|
280
|
+
def cookbook_resolution_failed(expanded_run_list, exception)
|
281
|
+
description = Formatters::ErrorMapper.cookbook_resolution_failed(expanded_run_list, exception)
|
282
|
+
@error_descriptions = description.for_json
|
283
|
+
end
|
284
|
+
|
285
|
+
def cookbook_sync_failed(cookbooks, exception)
|
286
|
+
description = Formatters::ErrorMapper.cookbook_sync_failed(cookbooks, exception)
|
287
|
+
@error_descriptions = description.for_json
|
288
|
+
end
|
289
|
+
|
290
|
+
def reporting_enabled?
|
291
|
+
@reporting_enabled
|
292
|
+
end
|
293
|
+
|
294
|
+
private
|
295
|
+
|
296
|
+
# If we are getting messages about a resource while we are in the middle of
|
297
|
+
# another resource's update, we assume that the nested resource is just the
|
298
|
+
# implementation of a provider, and we want to hide it from the reporting
|
299
|
+
# output.
|
300
|
+
def nested_resource?(new_resource)
|
301
|
+
@pending_update && @pending_update.new_resource != new_resource
|
302
|
+
end
|
303
|
+
|
304
|
+
def encode_gzip(data)
|
305
|
+
"".tap do |out|
|
306
|
+
Zlib::GzipWriter.wrap(StringIO.new(out)){|gz| gz << data }
|
307
|
+
end
|
308
|
+
end
|
309
|
+
|
310
|
+
def uuid
|
311
|
+
require 'securerandom'
|
312
|
+
# Ruby 1.8.7 does not have SecureRandom::uuid, so copy the 1.9.2 impl here
|
313
|
+
ary = SecureRandom.random_bytes(16).unpack("NnnnnN")
|
314
|
+
ary[2] = (ary[2] & 0x0fff) | 0x4000
|
315
|
+
ary[3] = (ary[3] & 0x3fff) | 0x8000
|
316
|
+
"%08x-%04x-%04x-%04x-%04x%08x" % ary
|
317
|
+
end
|
318
|
+
end
|
319
|
+
end
|
320
|
+
end
|
@@ -0,0 +1,48 @@
|
|
1
|
+
#
|
2
|
+
# Copyright:: Copyright (c) 2013 Opscode, Inc.
|
3
|
+
# License:: Apache License, Version 2.0
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
#
|
17
|
+
|
18
|
+
require 'chef/handler'
|
19
|
+
require 'chef/rest'
|
20
|
+
require 'chef/version_constraint'
|
21
|
+
|
22
|
+
|
23
|
+
class Chef
|
24
|
+
class Reporting
|
25
|
+
class StartHandler < ::Chef::Handler
|
26
|
+
|
27
|
+
attr_reader :config
|
28
|
+
|
29
|
+
def initialize(config={})
|
30
|
+
@config = config
|
31
|
+
end
|
32
|
+
|
33
|
+
def report
|
34
|
+
version_checker = Chef::VersionConstraint.new("< 11.6.0")
|
35
|
+
if version_checker.include?(Chef::VERSION)
|
36
|
+
Chef::Log.info("Enabling backported resource reporting Handler")
|
37
|
+
rest = Chef::REST.new(Chef::Config[:chef_server_url], @run_status.node.name, Chef::Config[:client_key])
|
38
|
+
resource_reporter = Chef::Reporting::ResourceReporter.new(rest)
|
39
|
+
@run_status.events.register(resource_reporter)
|
40
|
+
|
41
|
+
resource_reporter.run_started(@run_status)
|
42
|
+
else
|
43
|
+
Chef::Log.debug("Chef Version already has new Resource Reporter - skipping startup of backport version")
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
#
|
2
|
+
# Copyright:: Copyright (c) 2012 Opscode, Inc.
|
3
|
+
# License:: Apache License, Version 2.0
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
#
|
17
|
+
|
18
|
+
module Chef
|
19
|
+
module Reporting
|
20
|
+
VERSION = "0.1.0"
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
metadata
ADDED
@@ -0,0 +1,72 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: chef-reporting
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Opscode
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-05-03 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: chef
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: 11.0.0
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ! '>='
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: 11.0.0
|
30
|
+
description: Backport of Chef Reporting handler for Chef < 11.6.0
|
31
|
+
email: info@opscode.com
|
32
|
+
executables: []
|
33
|
+
extensions: []
|
34
|
+
extra_rdoc_files: []
|
35
|
+
files:
|
36
|
+
- .gitignore
|
37
|
+
- Gemfile
|
38
|
+
- LICENSE
|
39
|
+
- Makefile
|
40
|
+
- README.md
|
41
|
+
- chef-reporting.gemspec
|
42
|
+
- lib/chef_reporting.rb
|
43
|
+
- lib/chef_reporting/resource_reporter.rb
|
44
|
+
- lib/chef_reporting/start_handler.rb
|
45
|
+
- lib/chef_reporting/version.rb
|
46
|
+
homepage: https://github.com/opscode/chef-reporting
|
47
|
+
licenses:
|
48
|
+
- Apache 2.0
|
49
|
+
post_install_message:
|
50
|
+
rdoc_options: []
|
51
|
+
require_paths:
|
52
|
+
- lib
|
53
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
54
|
+
none: false
|
55
|
+
requirements:
|
56
|
+
- - ! '>='
|
57
|
+
- !ruby/object:Gem::Version
|
58
|
+
version: '0'
|
59
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
60
|
+
none: false
|
61
|
+
requirements:
|
62
|
+
- - ! '>='
|
63
|
+
- !ruby/object:Gem::Version
|
64
|
+
version: '0'
|
65
|
+
requirements: []
|
66
|
+
rubyforge_project:
|
67
|
+
rubygems_version: 1.8.23
|
68
|
+
signing_key:
|
69
|
+
specification_version: 3
|
70
|
+
summary: Backport of Chef Reporting handler for Chef < 11.6.0
|
71
|
+
test_files: []
|
72
|
+
has_rdoc:
|