RubyGems - inspec-reporter-honeycomb - Versions diffs - 0.1.2 → 0.1.5 - Mend

inspec-reporter-honeycomb 0.1.2 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

checksums.yaml +4 -4
data/lib/inspec-reporter-honeycomb/reporter.rb +122 -32
metadata +4 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0da6bc7af71195b03caa4c18a6328024ad2707778b9ca183d4bd900d141a0ee7
-  data.tar.gz: c337c14a866a179a3ea350a60877bab0e9cb5ce178076a6036ab1561ed67f23c
+  metadata.gz: 6a8e894a1f5773a7dbfec2acf30dde30e556c46378f12a09e916a782a476588e
+  data.tar.gz: e6ad1c6e8c297b22f09aee6b03bfd864ea1f5956469f37a06bf88f1eb30dea97
 SHA512:
-  metadata.gz: 0236b9d5449584924e895b2b69fd72e1179b20243d863437668b97140d4cd9d3538a2b88897460fface12228fe749bb4cb954a7165a302a2a6000fe69e44f327
-  data.tar.gz: 4441f6b32430b734acec407277c6a69a7692352eeacfd05ccb1f2a9bfc15bc288b14344be98ecec6c49cebdc060c8d71f489455481a30697f0b53538287a0f0c
+  metadata.gz: d4bfef6d8d1ab99b4cdbcf54d9049f99f6be89830784758136c7488d60c36a6cd13093c3b43fb570bbfc843dee1d9111d6df5e8028cbbcc22cf580b741773163
+  data.tar.gz: 4ab196b5290d34d8a8685426139467a8de1fe04489ad1aac536e2473e1b5679c3f0ee29fd7c9ab578f188e5244481cc6b186f9cc7a1e4841b9f0dee7a245ce7b

data/lib/inspec-reporter-honeycomb/reporter.rb CHANGED Viewed

@@ -1,7 +1,8 @@
 require 'inspec/plugin/v2'
 require 'json'
-require "securerandom" unless defined?(SecureRandom)
+require 'socket'
+require 'securerandom' unless defined?(SecureRandom)
 module InspecPlugins::HoneycombReporter
   # Reporter Plugin Class
@@ -15,10 +16,14 @@ module InspecPlugins::HoneycombReporter
     end
     def report
-      report = Inspec::Reporters::Json.new(@config).report
+      report = Inspec::Reporters::JsonAutomate.new(@config).report
       trace_id = SecureRandom.hex(16)
       root_span_id = SecureRandom.hex(8)
       trace_batch = []
+      ip_addresses = []
+      Socket.ip_address_list.each do |ipaddr|
+        ip_addresses << ipaddr.ip_address unless ipaddr.ip_address == '127.0.0.1'
+      end
       root_span_data = Hash.new
       root_span_data[:data] = {
         'trace.trace_id' => trace_id,
@@ -26,48 +31,98 @@ module InspecPlugins::HoneycombReporter
         'service.name' => 'compliance',
         'name' => 'inspec-run',
         'platform.name' => report[:platform][:name],
+        'platform.release' => report[:platform][:release],
         'duration' => report[:statistics][:duration]*1000,
         'version' => report[:version],
+        'hostname' => Socket.gethostname,
+        'arch' => ::RbConfig::CONFIG['arch'],
+        'os' => ::RbConfig::CONFIG['host_os'],
+        'ip_addresses' => ip_addresses,
       }
       trace_batch << root_span_data
       report[:profiles].each do |profile|
         profile_span_id = SecureRandom.hex(8)
+        profile_duration = 0.0
+        profile_statuses = []
+        profile_name = profile[:name]
+        profile_title = profile[:title]
+        profile_version = profile[:version]
+        profile_attributes = profile[:attributes]
         profile[:controls].each do |control|
-            control_span_id = SecureRandom.hex(8)
-            control[:results].each do |result|
-                result_span_id = SecureRandom.hex(8)
-                trace_batch << generate_span_data(
-                    parent_id: control_span_id,
-                    span_id: result_span_id,
-                    trace_id: trace_id,
-                    data: result,
-                    platform: report[:platform][:name],
-                    type: 'result',
-                    name: result[:code_desc],
-                    duration: result[:run_time],
-                )
-            end
-            control.tap { |ct| ct.delete(:results) }
+          control_span_id = SecureRandom.hex(8)
+          control_duration = 0.0
+          control_statuses = []
+          control_name = control[:name]
+          control_id = control[:id]
+          control_desc = control[:desc]
+          control_impact = control[:impact]
+          control[:results].each do |result|
+            result_span_id = SecureRandom.hex(8)
+            control_duration += result[:run_time]
+            control_statuses << result[:status]
             trace_batch << generate_span_data(
-                parent_id: profile_span_id,
-                span_id: control_span_id,
-                trace_id: trace_id,
-                data: control,
-                platform: report[:platform][:name],
-                type: 'control',
-                name: control[:title],
+              parent_id: control_span_id,
+              span_id: result_span_id,
+              trace_id: trace_id,
+              data: result,
+              platform: report[:platform][:name],
+              platform_release: report[:platform][:release],
+              type: 'result',
+              name: result[:code_desc],
+              duration: result[:run_time],
+              profile_name: profile_name,
+              profile_title: profile_title,
+              profile_version: profile_version,
+              profile_attributes: profile_attributes,
+              control_name: control_name,
+              control_id: control_id,
+              control_desc: control_desc,
+              control_impact: control_impact,
             )
-        end
-        profile.tap { |pf| pf.delete(:controls) }
-        trace_batch << generate_span_data(
-            parent_id: root_span_id,
-            span_id: profile_span_id,
+          end
+          control.tap { |ct| ct.delete(:results) }
+          profile_duration += control_duration
+          profile_statuses += control_statuses
+          control_status = get_status(control_statuses)
+          trace_batch << generate_span_data(
+            parent_id: profile_span_id,
+            span_id: control_span_id,
             trace_id: trace_id,
-            data: profile,
+            data: control,
+            status: control_status,
             platform: report[:platform][:name],
-            type: 'profile',
+            platform_release: report[:platform][:release],
+            type: 'control',
+            duration: control_duration,
+            name: control[:title],
+            profile_name: profile_name,
+            profile_title: profile_title,
+            profile_version: profile_version,
+            profile_attributes: profile_attributes,
+            control_name: control_name,
+            control_id: control_id,
+            control_desc: control_desc,
+            control_impact: control_impact,
+          )
+        end
+        profile.tap { |pf| pf.delete(:controls); pf.delete(:status) }
+        profile_status = get_status(profile_statuses)
+        trace_batch << generate_span_data(
+          parent_id: root_span_id,
+          span_id: profile_span_id,
+          trace_id: trace_id,
+          data: profile,
+          status: profile_status,
+          platform: report[:platform][:name],
+          platform_release: report[:platform][:release],
+          duration: profile_duration,
+          type: 'profile',
+          profile_name: profile_name,
+          profile_title: profile_title,
+          profile_version: profile_version,
+          profile_attributes: profile_attributes,
         )
       end
@@ -91,7 +146,7 @@ module InspecPlugins::HoneycombReporter
         res = http.request(req)
         if res.is_a?(Net::HTTPSuccess)
-          true
+          Inspec::Log.debug "send_report: Honeycomb POST to #{uri.path} succeeded and returned: #{res.body} "
         else
           Inspec::Log.error "send_report: POST to #{uri.path} returned: #{res.body}"
           false
@@ -100,10 +155,31 @@ module InspecPlugins::HoneycombReporter
         Inspec::Log.error "send_report: POST to #{uri.path} returned: #{e.message}"
         false
       end
+      Inspec::Log.debug "Successfully sent report"
     end
     private
+    def safe_time(time)
+      if time.nil?
+        nil
+      else
+        time.iso8601(fraction_digits = 3)
+      end
+    end
+    def get_status(status_array)
+      if status_array.include?('failed')
+        'failed'
+      elsif status_array.include?('skipped') && !status_array.include?('passed')
+        'skipped'
+      elsif status_array.empty?
+        'skipped'
+      else
+        'passed'
+      end
+    end
     def generate_span_data(**args)
         time_in_ms = args[:duration] ? args[:duration] * 1000 : 0
@@ -113,9 +189,23 @@ module InspecPlugins::HoneycombReporter
             'service.name' => 'compliance',
             'trace.parent_id' => args[:parent_id],
             'platform.name' => args[:platform],
+            'platform.release' => args[:platform_release],
+            'status' => args[:status],
             'type' => args[:type],
             'name' => args[:name],
             'duration' => time_in_ms,
+            'hostname' => Socket.gethostname,
+            'arch' => ::RbConfig::CONFIG['arch'],
+            'os' => ::RbConfig::CONFIG['host_os'],
+            'ip_addresses' => ip_addresses,
+            'profile.name' => args[:profile_name],
+            'profile.title' => args[:profile_title],
+            'profile.version' => args[:profile_version],
+            'profile.attributes' => args[:profile_attributes],
+            'control.name' => args[:control_name],
+            'control.id' => args[:control_id],
+            'control.desc' => args[:control_desc],
+            'control.impact' => args[:control_impact],
         }
         args[:data].each do |k,v|

metadata CHANGED Viewed

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: inspec-reporter-honeycomb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Andy Dufour
+- Davin Taddeo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inspec
@@ -27,6 +28,7 @@ dependencies:
 description: InSpec Reporter plugin to report Otel formatted traces to Honeycomb.
 email:
 - andy.k.dufour@gmail.com
+- davin@davintaddeo.com
 executables: []
 extensions: []
 extra_rdoc_files: []