LrcReport 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd0f3ca8d3a47b2348fab1095dc1afc53c1491d777f68620a894af959a419c80
+  data.tar.gz: 616999d192609e127ecfd838ab22dacb6df3c50d7001771a136be9f5ec8bdd04
+SHA512:
+  metadata.gz: 1ee3dba435c58e815f1e77119e0f652cc04b196933267c4f656f8e4d8044eba0fc2532d282bbabde90b55de0d2f461f7ccaf0e29e2bcb8eb2dee2009700d9b96
+  data.tar.gz: 56a189b0c165d77d07f36899b8882e75dbffdef4d6d40b04e95c5db7577aa5e550d1aff1e553d24aad99a69a22efc65b9195f9bc1d7374d024a9d271962300b3

data/LICENSE.md

@@ -0,0 +1,24 @@
+# Copyright (c) LINKBYNET 2017
+
+based on chef_handler_foreman gem package (Copyright (c) 2013 Marek Hulan)
+
+MIT License
+
+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,40 @@
+# Description
+
+This gem adds Chef report and attributes handlers that send reports to LRC Project.
+LRC mean LinkByNet Reporter for Chef
+
+## Installation
+
+Since it's released as a gem you can simply run this command under root
+
+```sh
+chef gem install lrc_handler
+```
+
+## Usage
+
+In /etc/chef/client.rb:
+
+```ruby
+# this adds new functions to chef configuration
+require 'lrc_handler'
+# here you can specify your connection options
+lrc_server_options  :url => 'https://lrc.lbn.fr'
+# add following line if you want to upload reports
+lrc_reports_upload  true
+# add following line to manage reports verbosity. Allowed values are debug, notice and error
+lrc_reports_level       "notice"
+```
+
+## packaging
+
+Edit the `lib\lbn_report_chef\version.rb` with a new version
+
+run the following command:
+
+```sh
+gem build lrc_handler.gemspec
+gem push lrc_handler-x.x.x.gem
+```
+
+gem push require that you can login to rubygems.org

data/lib/chef/handler/lrc_report.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+# Importing Required libs
+require 'chef'
+require 'chef/handler'
+require 'net/http'
+require 'uri'
+
+class Chef
+  class Handler
+    # Class for Lrc report
+    class LrcReport < Chef::Handler
+      attr_writer :url, :upload, :level
+
+      # Initalizing Variables
+      def initialize(options = {})
+        options[:url] ||= 'https://gate.linkbynet.com/881c1287e9c9e04af8c1f054bb1c40fe6c44625c0d0c89d1509d3bbfd62f7c21/'
+        options[:upload] ||= true
+        options[:level] ||= 'info'
+        options[:ssl_verify] ||= true
+        @url = options[:url]
+        @upload = options[:upload]
+        @level = options[:level]
+        @ssl_verify = options[:ssl_verify] ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+      end
+
+      # Defining Function for posting data to LRC
+      # Running chef in debug mode (-l debug) will display the POST data to Stdout
+      def lrc_request(path, body, method = 'post')
+        uri = URI.parse(@url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = @ssl_verify
+        req = Net::HTTP.const_get(method.capitalize).new("#{uri}#{path}")
+        req.add_field('Accept', 'application/json')
+        req.add_field('Content-Type', 'application/json')
+        req.add_field('User-Agent', "LRC_handler v1.1, NODE:#{body['report']['host']}, chef-client v#{Chef::VERSION}")
+        req.body = body.to_json
+        response = http.request(req)
+        Chef::Log.info("The report API has return: #{response.inspect} from #{uri}#{path}")
+        Chef::Log.debug("Report Content: #{body.to_json}")
+      end
+
+      def resources_per_status
+        if Chef::Config.why_run
+          {
+            'applied'         => 0,
+            'restarted'       => 0,
+            'failed'          => 0,
+            'failed_restarts' => 0,
+            'skipped'         => @total_skipped,
+            'pending'         => @total_updated + @total_restarted + @total_failed + @total_failed_restart,
+          }
+        else
+          {
+            'applied'         => @total_updated,
+            'restarted'       => @total_restarted,
+            'failed'          => @total_failed,
+            'failed_restarts' => @total_failed_restart,
+            'skipped'         => @total_skipped,
+            'pending'         => 0,
+          }
+        end
+      end
+
+      def report
+        report                   = { 'host' => node.name, 'reported_at' => Time.now.utc.to_s }
+        report_status            = Hash.new(0)
+        report_status['failed']  = 1 if failed?
+        report_status['applied'] = run_status.updated_resources.count
+        report['status']         = resources_per_status
+
+        # I can't compute much metrics for now
+        metrics                  = {}
+        metrics['resources']     = { 'total' => run_status.all_resources.count }
+
+        times = {}
+        run_status.all_resources.each do |resource|
+          resource_name = resource.resource_name
+          if times[resource_name].nil?
+            times[resource_name] = resource.elapsed_time
+          else
+            times[resource_name] += resource.elapsed_time
+          end
+        end
+        metrics['time']   = times.merge!('total' => run_status.elapsed_time)
+        report['metrics'] = metrics
+
+        logs = []
+        run_status.updated_resources.each do |resource|
+          l = { 'log' => { 'sources' => {}, 'messages' => {}, 'level' => 'notice' } }
+
+          case resource.resource_name.to_s
+          when 'template', 'cookbook_file'
+            message = resource.diff
+          when 'package'
+            message = "Installed #{resource.package_name} package in #{resource.version}"
+          else
+            message = resource.action.to_s
+          end
+          l['log']['messages']['message'] = message
+          l['log']['sources']['source']   = [resource.resource_name.to_s, resource.name].join(' ')
+          logs << l
+        end
+
+        # I only set failed to 1 if chef run failed
+        if failed?
+          logs << {
+            'log' => {
+              'sources' => { 'source' => 'chef' },
+              'messages' => { 'message' => run_status.exception },
+              'level' => 'err'
+            }
+          }
+        end
+
+        report['logs'] = logs
+        lrc_request('/report', { 'report' => report })
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: LrcReport
+version: !ruby/object:Gem::Version
+  version: 0.1.10
+platform: ruby
+authors:
+- Haïdar Salauroo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-26 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: Create and Send Chef execution report to LRC
+email:
+- h.salauroo@linkbynet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/chef/handler/lrc_report.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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Custom Chef Handler for LRC
+test_files: []