chef-handler-influxdb 0.1.0

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2013 Simple Finance Technology Corp
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,84 @@
+# ChefInfluxDB handler
+A Chef handler to update InfluxDB with data from the most recent Chef run. By
+default, it will report on:
+
+* Run status (success/fail)
+* Number of updated resources
+* Elapsed time
+* Time the Chef run approximately ended
+
+You can also ship arbitrary data into InfluxDB using the `data` argument. Be
+warned, however, that this is somewhat sensitive to timing, as all data must be
+finalized before being passed into the handler. In otherwords, if you pass in
+an attribute and then change its value after declaring the handler, you will
+see the previous/initial value.
+
+At least the `:database` and `:series` arguments are required. The handler
+otherwise assumes an InfluxDB server on localhost:8086, with credentials of
+`root:root` (defaults for InfluxDB).
+
+## Prerequisites
+The `influxdb` Rubygem as well as an InfluxDB server setup somewhere. Install the gem
+using the following:
+
+```ruby
+chef_gem 'influxdb' do
+  action :nothing
+end.run_action(:install)
+```
+
+## Usage
+Either just pull the handler file into the files/ directory of one of your
+cookbooks, or download as a Rubygem and source it that way.
+
+```ruby
+# Option 1
+cookbook_file "#{node[:chef_handler][:handler_path]}/chef-handler-influxdb.rb" do
+  source 'chef-handler-influxdb.rb'
+  mode 00600
+end
+
+chef_handler 'ChefInfluxDB' do
+  source "#{node[:chef_handler][:handler_path]}/chef-handler-influxdb.rb"
+  arguments [
+    :database => 'database',
+    :series => 'my_series',
+    :data => node[:cookbook][:attribute].to_hash,
+  ]
+  action :enable
+end
+
+# Option 2
+chef_gem 'chef-handler-influxdb' do
+  action :install
+end
+
+chef_handler 'ChefInfluxDB' do
+  source ::File.join(Gem::Specification.find_by_name('chef-handler-influxdb').lib_dirs_glob,
+                     'chef-handler-influxdb.rb')
+  arguments [
+    :database => 'database',
+    :series => 'my_series',
+    :data => node[:cookbook][:attribute].to_hash,
+  ]
+  action :enable
+end
+```
+
+### Arguments
+* `database` - The database to connect to (required)
+* `series` - The timeseries to write to (required)
+* `host` - The host of the InfluxDB server (default: `localhost`)
+* `port` - The port of the InfluxDB server (default: `8086`)
+* `user` - The user to connect as (default: `root`)
+* `pass` - The password to authenticate with (default: `root`)
+* `data` - Send arbitrary data to InfluxDB (default: `{}`)
+
+## Questions?
+Hop on ##simple on Freenode with any questions or concerns.
+
+## Author and License
+Simple Finance <ops@simple.com>
+
+Apache License, Version 2.0
+

data/chef-handler-influxdb.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name = 'chef-handler-influxdb'
+  s.version = '0.1.0'
+  s.author = 'Simple Finance'
+  s.email = 'ops@simple.com'
+  s.homepage = 'http://github.com/SimpleFinance/chef-handler-influxdb'
+  s.summary = 'Updates InfluxDB with Chef run data'
+  s.description = 'Updates InfluxDB with Chef run and arbitrary user data'
+  s.files = ::Dir.glob('**/*')
+  s.require_paths = ['lib']
+end
+

data/lib/chef-handler-influxdb.rb

@@ -0,0 +1,78 @@
+# lib/chef-handler-influxdb.rb
+#
+# Author: Simple Finance <ops@simple.com>
+# Copyright 2013 Simple Finance Technology Corporation.
+# Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Chef handler to add Chef run and optional user data to InfluxDB
+
+require 'rubygems'
+require 'chef'
+require 'chef/handler'
+require 'influxdb'
+
+class ChefInfluxDB < Chef::Handler
+    attr_reader :host, :port, :user, :pass, :database, :series, :data
+
+    def initialize(options = defaults)
+      @database = options[:database]
+      @series = options[:series]
+      @host = options[:host]
+      @port = options[:port]
+      @user = options[:user]
+      @pass = options[:pass]
+      @data = options[:data]
+    end
+
+    def defaults
+      return {
+        :user => 'root',
+        :pass => 'root',
+        :host => 'localhost',
+        :port => 8086,
+        :data => {},
+        :database => nil,
+        :series => nil
+      }
+    end
+
+    def client
+      return InfluxDB::Client.new(
+        :database => @database,
+        :host => @host,
+        :port => @port,
+        :username => @user,
+        :password => @pass
+      )
+    end
+
+    def generate_data
+      return JSON.generate({
+        :host => node.name,
+        :status => run_status.success? 1 : 0,
+        :resources_updated => run_status.updated_resources.length,
+        :elapsed_time => run_status.elapsed_time,
+        :end_time => Time.now.to_s
+      }.merge(@data))
+    end
+
+    def report
+      Chef::Log.info 'Exporting Chef run data to InfluxDB'
+      client.write_point(@series, generate_data)
+    end
+
+end
+

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: chef-handler-influxdb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Simple Finance
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-15 00:00:00.000000000 Z
+dependencies: []
+description: Updates InfluxDB with Chef run and arbitrary user data
+email: ops@simple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- chef-handler-influxdb.gemspec
+- lib/chef-handler-influxdb.rb
+- LICENSE
+- README.md
+homepage: http://github.com/SimpleFinance/chef-handler-influxdb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Updates InfluxDB with Chef run data
+test_files: []