chef-handler-logstash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f79b874cd24605235c8a9245770df64467ca11f
+  data.tar.gz: 7af14eea0760d0234dd9261ec79be232f7bf359a
+SHA512:
+  metadata.gz: 186816d7d8356f8222d216b16438fc9d98e49c76cdc967f573ba0a7c3c31ca56df78994c3629e4d9e9973b88405d2292f6437694e6da93105eeac95c70648b99
+  data.tar.gz: a03fc1e943e0369120fa177ce1abc265d24b95d07917dc79f32461c6ab0900ac901769390745ea4903405a370d5d58117c78960b4f4c92cf3bcace2d27e8ea99

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lostmy.name Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+Description
+===========
+
+This is a Chef report handler that exports a report in json format to the configured server/port 
+We are using it to report to logstash but probably you can hook it into anything that accepts a json :)
+
+* http://wiki.opscode.com/display/chef/Exception+and+Report+Handlers
+
+Requirements
+============
+
+Only works on Chef >= 10.14
+
+Usage
+=====
+
+There are two ways to use Chef Handlers.
+
+### Method 1 (recommended)
+
+Use the
+[chef_handler cookbook by Opscode](http://community.opscode.com/cookbooks/chef_handler).
+Create a recipe with the following:
+
+    include_recipe "chef_handler"
+
+    # Install `chef-handler-logstash` gem during the compile phase
+    chef_gem "chef-handler-logstash"
+
+    # load the gem here so it gets added to the $LOAD_PATH, otherwise chef_handler
+    # will fail.
+    require 'chef/handler/chef_profiler'
+
+    # Activate the handler immediately during compile phase
+    chef_handler "Chef::Handler::Profiler" do
+      source "chef/handler/chef_profiler"
+      action :nothing
+    end.run_action(:enable)
+
+
+### Method 2
+
+Install the gem ahead of time, and configure Chef to use
+them:
+
+    gem install chef-handler-logstash
+
+Then add to the configuration (`/etc/chef/solo.rb` for chef-solo or
+`/etc/chef/client.rb` for chef-client):
+
+    require "chef/handler/chef_profiler"
+    report_handlers << Chef::Handler::Profiler.new
+    exception_handlers << Chef::Handler::Profiler.new
+
+
+### Example output
+
+
+License and Author
+==================
+
+Licensed under the MIT license. See `LICENSE` file for details.
+
+Author:: Nadir Lloret <https://github.com/nadirollo>

data/lib/chef/handler/chef_logstash.rb

@@ -0,0 +1,85 @@
+require "chef"
+require "chef/handler"
+require "socket"
+require "timeout"
+
+class Chef
+  class Handler
+    class Logstash < Chef::Handler
+      attr_writer :tags, :host, :port, :timeout
+
+      def initialize(options = {})
+        options[:tags] ||= Array.new
+        options[:timeout] ||= 15
+        @tags = options[:tags]
+        @timeout = options[:timeout]
+        @host = options[:host]
+        @port = options[:port]
+      end
+
+      def report
+        # A logstash json_event looks like this:
+        # {
+        #   "@source":"typicall determined by logstash input def",
+        #   "@type":"determined by logstash input def",
+        #   "@tags":[],
+        #   "@fields":{},
+        #   "@timestamp":"ISO8601 of report seen by logstash",
+        #   "@source_host":"host.foo.com",
+        #   "@source_path":"typically the name of the log file",
+        #   "@message":"escaped representation of report"
+        # }
+        #
+        # When sending an report in native `json_event` format
+        # - You are required to set everything EXCEPT @type and @timestamp
+        # - @type CAN be overridden
+        # - @timestamp will be ignored
+        @updated_resources = []
+        @updated_resources_count = 0
+        if run_status.updated_resources
+          run_status.updated_resources.each do |r|
+            @updated_resources << r.to_s
+            @updated_resources_count += 1
+          end
+        end
+        report = Hash.new
+        report["@source"] = "chef://#{run_status.node.name}/handler/logstash"
+        report["@source_path"] = "#{__FILE__}"
+        report["@source_host"] = run_status.node.name
+        report["@tags"] = @tags
+        report["@fields"] = Hash.new
+        report["@fields"]["environment"] = run_status.node.chef_environment
+        report["@fields"]["run_list"] = run_status.node.run_list
+        report["@fields"]["updated_resources"] = @updated_resources
+        report["@fields"]["updated_resources_count"] = @updated_resources_count
+        report["@fields"]["elapsed_time"] = run_status.elapsed_time
+        report["@fields"]["success"] = run_status.success?
+        # (TODO) Convert to ISO8601
+        report["@fields"]["start_time"] = run_status.start_time.to_time.iso8601
+        report["@fields"]["end_time"] = run_status.end_time.to_time.iso8601
+        if run_status.backtrace
+          report["@fields"]["backtrace"] = run_status.backtrace.join("\n")
+        else
+          report["@fields"]["backtrace"] = ""
+        end
+        if run_status.exception
+          report["@fields"]["exception"] = run_status.exception
+        else
+          report["@fields"]["exception"] = ""
+        end
+        report["@message"] = run_status.exception || "Chef client run completed in #{run_status.elapsed_time}"
+
+        begin
+          Timeout::timeout(@timeout) do
+            json = report.to_json
+            ls = TCPSocket.new "#{@host}" , @port
+            ls.puts json
+            ls.close
+          end
+        rescue Exception => e
+          Chef::Log.info("Failed to write to #{@host} on port #{@port}: #{e.message}")
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: chef-handler-logstash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- LostMyName
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '10.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '10.14'
+description: Send report to logstash port listening for json_events
+email:
+- nadir@lostmy.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/chef/handler/chef_logstash.rb
+homepage: https://github.com/lostmyname/chef-handler-logstash
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Chef Profiler Logstash
+test_files: []