smart_proxy_reports 0.0.5

data/lib/smart_proxy_reports/spooled_http_client.rb

@@ -0,0 +1,102 @@
+module Proxy::Reports
+  class SpooledHttpClient
+    include Proxy::Log
+    include Singleton
+
+    def spool_path(state = "temp", filename = nil)
+      if filename
+        File.join(@spool_dir, state, filename)
+      else
+        File.join(@spool_dir, state)
+      end
+    end
+
+    def spool_move(from_state, to_state, filename)
+      # TODO: implement fsync?
+      FileUtils.mv(spool_path(from_state, filename), spool_path(to_state, filename))
+    end
+
+    def initialize
+      @worker = nil
+    end
+
+    def initialize_directory(spool_dir = Proxy::Reports::Plugin.settings.spool_dir)
+      raise("Setting spool_dir uninitialized") unless spool_dir
+      @spool_dir = spool_dir
+      ["temp", "todo", "done", "fail"].each do |state|
+        FileUtils.mkdir_p(spool_path(state))
+      end
+      self
+    end
+
+    def start
+      @worker_running = true
+      @worker = Thread.new do
+        while @worker_running
+          begin
+            logger.info "Started host reports spooled http client"
+            process
+          rescue StandardError => e
+            logger.error "Error during spool processing: #{e}", e
+          end
+          Thread.stop
+        end
+        logger.info "Stopped host reports spooled http client"
+      end
+    end
+
+    # smart proxy currently does not support stopping services
+    def stop
+      @worker_running = false
+      wakeup
+      @worker.join
+    end
+
+    def process
+      processed = 0
+      client = ::Proxy::HttpRequest::ForemanRequest.new
+      factory = client.request_factory
+      # send all files via a single persistent HTTP connection
+      logger.debug "Opening HTTP connection to Foreman"
+      client.http.start do |http|
+        Dir.glob(spool_path("todo", "*")) do |filename|
+          basename = File.basename(filename)
+          logger.debug "Sending report #{basename}"
+          begin
+            post = factory.create_post("/api/v2/host_reports", File.read(filename))
+            response = http.request(post)
+            logger.info "Report #{basename} sent with HTTP response #{response.code}"
+            logger.debug { "Response body: #{response.body}" }
+            if response.code.start_with?("2")
+              if Proxy::Reports::Plugin.settings.keep_reports
+                spool_move("todo", "done", basename)
+              else
+                FileUtils.rm_f spool_path("todo", basename)
+              end
+            else
+              logger.debug { "Moving failed report to 'fail' spool directory" }
+              spool_move("todo", "done", basename)
+            end
+            processed += 1
+          rescue StandardError => e
+            logger.warn "Unable to send #{basename}, will try on next request: #{e}", e
+            raise if ENV["RACK_ENV"] == "test"
+          end
+        end
+      end
+      logger.debug "Finished uploading #{processed} reports, closing connection"
+    end
+
+    def wakeup
+      @worker.wakeup if @worker
+    end
+
+    def spool(filename, data)
+      filename = filename.gsub(/[^0-9a-z]/i, "")
+      file = spool_path("temp", filename)
+      File.open(file, "w") { |f| f.write(data) }
+      spool_move("temp", "todo", filename)
+      wakeup
+    end
+  end
+end

data/lib/smart_proxy_reports/version.rb

@@ -0,0 +1,5 @@
+module Proxy
+  module Reports
+    VERSION = "0.0.5"
+  end
+end

data/lib/smart_proxy_reports.rb

@@ -0,0 +1,2 @@
+require "smart_proxy_reports/version"
+require "smart_proxy_reports/reports"

data/settings.d/reports.yml.example

@@ -0,0 +1,22 @@
+---
+:enabled: true
+
+# Proxy hostname to appear in reports JSON
+:reported_proxy_hostname: localhost
+
+# Print intput and output to the debug level
+:debug_payload: false
+
+# Spool directory with processed reports
+:spool_dir: /var/lib/foreman-proxy/reports
+
+# Keep sent reports in spool_dir/done directory
+# - when enabled, move files from the place on
+# a regular basis (e.g. via cronjob).
+:keep_reports: false
+
+# Development settings (do not use)
+# Override hostnames of incoming reports
+#:override_hostname: report.example.com
+# Store input payloads in a directory
+#:incoming_save_dir: /var/lib/foreman-proxy/reports/incoming

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: smart_proxy_reports
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Lukas Zapletal
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Transform and upload Foreman host reports via REST API
+email: lukas-x@zapletalovi.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- bundler.d/reports.rb
+- lib/smart_proxy_reports.rb
+- lib/smart_proxy_reports/ansible_processor.rb
+- lib/smart_proxy_reports/processor.rb
+- lib/smart_proxy_reports/puppet_processor.rb
+- lib/smart_proxy_reports/reports.rb
+- lib/smart_proxy_reports/reports_api.rb
+- lib/smart_proxy_reports/reports_http_config.ru
+- lib/smart_proxy_reports/spooled_http_client.rb
+- lib/smart_proxy_reports/version.rb
+- settings.d/reports.yml.example
+homepage: http://github.com/theforeman/smart_proxy_reports
+licenses:
+- GPL-3.0-or-later
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Foreman Host Reports processor
+test_files: []