chef-handler-influxdb 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +201 -0
- data/README.md +84 -0
- data/chef-handler-influxdb.gemspec +12 -0
- data/lib/chef-handler-influxdb.rb +78 -0
- metadata +48 -0
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 2013 Simple Finance Technology Corp
|
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/README.md
ADDED
@@ -0,0 +1,84 @@
|
|
1
|
+
# ChefInfluxDB handler
|
2
|
+
A Chef handler to update InfluxDB with data from the most recent Chef run. By
|
3
|
+
default, it will report on:
|
4
|
+
|
5
|
+
* Run status (success/fail)
|
6
|
+
* Number of updated resources
|
7
|
+
* Elapsed time
|
8
|
+
* Time the Chef run approximately ended
|
9
|
+
|
10
|
+
You can also ship arbitrary data into InfluxDB using the `data` argument. Be
|
11
|
+
warned, however, that this is somewhat sensitive to timing, as all data must be
|
12
|
+
finalized before being passed into the handler. In otherwords, if you pass in
|
13
|
+
an attribute and then change its value after declaring the handler, you will
|
14
|
+
see the previous/initial value.
|
15
|
+
|
16
|
+
At least the `:database` and `:series` arguments are required. The handler
|
17
|
+
otherwise assumes an InfluxDB server on localhost:8086, with credentials of
|
18
|
+
`root:root` (defaults for InfluxDB).
|
19
|
+
|
20
|
+
## Prerequisites
|
21
|
+
The `influxdb` Rubygem as well as an InfluxDB server setup somewhere. Install the gem
|
22
|
+
using the following:
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
chef_gem 'influxdb' do
|
26
|
+
action :nothing
|
27
|
+
end.run_action(:install)
|
28
|
+
```
|
29
|
+
|
30
|
+
## Usage
|
31
|
+
Either just pull the handler file into the files/ directory of one of your
|
32
|
+
cookbooks, or download as a Rubygem and source it that way.
|
33
|
+
|
34
|
+
```ruby
|
35
|
+
# Option 1
|
36
|
+
cookbook_file "#{node[:chef_handler][:handler_path]}/chef-handler-influxdb.rb" do
|
37
|
+
source 'chef-handler-influxdb.rb'
|
38
|
+
mode 00600
|
39
|
+
end
|
40
|
+
|
41
|
+
chef_handler 'ChefInfluxDB' do
|
42
|
+
source "#{node[:chef_handler][:handler_path]}/chef-handler-influxdb.rb"
|
43
|
+
arguments [
|
44
|
+
:database => 'database',
|
45
|
+
:series => 'my_series',
|
46
|
+
:data => node[:cookbook][:attribute].to_hash,
|
47
|
+
]
|
48
|
+
action :enable
|
49
|
+
end
|
50
|
+
|
51
|
+
# Option 2
|
52
|
+
chef_gem 'chef-handler-influxdb' do
|
53
|
+
action :install
|
54
|
+
end
|
55
|
+
|
56
|
+
chef_handler 'ChefInfluxDB' do
|
57
|
+
source ::File.join(Gem::Specification.find_by_name('chef-handler-influxdb').lib_dirs_glob,
|
58
|
+
'chef-handler-influxdb.rb')
|
59
|
+
arguments [
|
60
|
+
:database => 'database',
|
61
|
+
:series => 'my_series',
|
62
|
+
:data => node[:cookbook][:attribute].to_hash,
|
63
|
+
]
|
64
|
+
action :enable
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Arguments
|
69
|
+
* `database` - The database to connect to (required)
|
70
|
+
* `series` - The timeseries to write to (required)
|
71
|
+
* `host` - The host of the InfluxDB server (default: `localhost`)
|
72
|
+
* `port` - The port of the InfluxDB server (default: `8086`)
|
73
|
+
* `user` - The user to connect as (default: `root`)
|
74
|
+
* `pass` - The password to authenticate with (default: `root`)
|
75
|
+
* `data` - Send arbitrary data to InfluxDB (default: `{}`)
|
76
|
+
|
77
|
+
## Questions?
|
78
|
+
Hop on ##simple on Freenode with any questions or concerns.
|
79
|
+
|
80
|
+
## Author and License
|
81
|
+
Simple Finance <ops@simple.com>
|
82
|
+
|
83
|
+
Apache License, Version 2.0
|
84
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
Gem::Specification.new do |s|
|
2
|
+
s.name = 'chef-handler-influxdb'
|
3
|
+
s.version = '0.1.0'
|
4
|
+
s.author = 'Simple Finance'
|
5
|
+
s.email = 'ops@simple.com'
|
6
|
+
s.homepage = 'http://github.com/SimpleFinance/chef-handler-influxdb'
|
7
|
+
s.summary = 'Updates InfluxDB with Chef run data'
|
8
|
+
s.description = 'Updates InfluxDB with Chef run and arbitrary user data'
|
9
|
+
s.files = ::Dir.glob('**/*')
|
10
|
+
s.require_paths = ['lib']
|
11
|
+
end
|
12
|
+
|
@@ -0,0 +1,78 @@
|
|
1
|
+
# lib/chef-handler-influxdb.rb
|
2
|
+
#
|
3
|
+
# Author: Simple Finance <ops@simple.com>
|
4
|
+
# Copyright 2013 Simple Finance Technology Corporation.
|
5
|
+
# Apache License, Version 2.0
|
6
|
+
#
|
7
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
16
|
+
# implied.
|
17
|
+
# See the License for the specific language governing permissions and
|
18
|
+
# limitations under the License.
|
19
|
+
#
|
20
|
+
# Chef handler to add Chef run and optional user data to InfluxDB
|
21
|
+
|
22
|
+
require 'rubygems'
|
23
|
+
require 'chef'
|
24
|
+
require 'chef/handler'
|
25
|
+
require 'influxdb'
|
26
|
+
|
27
|
+
class ChefInfluxDB < Chef::Handler
|
28
|
+
attr_reader :host, :port, :user, :pass, :database, :series, :data
|
29
|
+
|
30
|
+
def initialize(options = defaults)
|
31
|
+
@database = options[:database]
|
32
|
+
@series = options[:series]
|
33
|
+
@host = options[:host]
|
34
|
+
@port = options[:port]
|
35
|
+
@user = options[:user]
|
36
|
+
@pass = options[:pass]
|
37
|
+
@data = options[:data]
|
38
|
+
end
|
39
|
+
|
40
|
+
def defaults
|
41
|
+
return {
|
42
|
+
:user => 'root',
|
43
|
+
:pass => 'root',
|
44
|
+
:host => 'localhost',
|
45
|
+
:port => 8086,
|
46
|
+
:data => {},
|
47
|
+
:database => nil,
|
48
|
+
:series => nil
|
49
|
+
}
|
50
|
+
end
|
51
|
+
|
52
|
+
def client
|
53
|
+
return InfluxDB::Client.new(
|
54
|
+
:database => @database,
|
55
|
+
:host => @host,
|
56
|
+
:port => @port,
|
57
|
+
:username => @user,
|
58
|
+
:password => @pass
|
59
|
+
)
|
60
|
+
end
|
61
|
+
|
62
|
+
def generate_data
|
63
|
+
return JSON.generate({
|
64
|
+
:host => node.name,
|
65
|
+
:status => run_status.success? 1 : 0,
|
66
|
+
:resources_updated => run_status.updated_resources.length,
|
67
|
+
:elapsed_time => run_status.elapsed_time,
|
68
|
+
:end_time => Time.now.to_s
|
69
|
+
}.merge(@data))
|
70
|
+
end
|
71
|
+
|
72
|
+
def report
|
73
|
+
Chef::Log.info 'Exporting Chef run data to InfluxDB'
|
74
|
+
client.write_point(@series, generate_data)
|
75
|
+
end
|
76
|
+
|
77
|
+
end
|
78
|
+
|
metadata
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: chef-handler-influxdb
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Simple Finance
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-11-15 00:00:00.000000000 Z
|
13
|
+
dependencies: []
|
14
|
+
description: Updates InfluxDB with Chef run and arbitrary user data
|
15
|
+
email: ops@simple.com
|
16
|
+
executables: []
|
17
|
+
extensions: []
|
18
|
+
extra_rdoc_files: []
|
19
|
+
files:
|
20
|
+
- chef-handler-influxdb.gemspec
|
21
|
+
- lib/chef-handler-influxdb.rb
|
22
|
+
- LICENSE
|
23
|
+
- README.md
|
24
|
+
homepage: http://github.com/SimpleFinance/chef-handler-influxdb
|
25
|
+
licenses: []
|
26
|
+
post_install_message:
|
27
|
+
rdoc_options: []
|
28
|
+
require_paths:
|
29
|
+
- lib
|
30
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
31
|
+
none: false
|
32
|
+
requirements:
|
33
|
+
- - ! '>='
|
34
|
+
- !ruby/object:Gem::Version
|
35
|
+
version: '0'
|
36
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
37
|
+
none: false
|
38
|
+
requirements:
|
39
|
+
- - ! '>='
|
40
|
+
- !ruby/object:Gem::Version
|
41
|
+
version: '0'
|
42
|
+
requirements: []
|
43
|
+
rubyforge_project:
|
44
|
+
rubygems_version: 1.8.23
|
45
|
+
signing_key:
|
46
|
+
specification_version: 3
|
47
|
+
summary: Updates InfluxDB with Chef run data
|
48
|
+
test_files: []
|