greenhat 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff63bc1345ac9a27d3fa6263fc3a68e9c851aa30f2b3bf58cdee484ce142cbb
-  data.tar.gz: a150c0d19b954883ef2372280b78a89606a5e9039944b794289c9541c3548ed3
+  metadata.gz: d9cc86956963d9d4d6a11b8d84b3a047d66bbbd3ac1c0cbb45f7e9f91d0a55e2
+  data.tar.gz: c4df69de408709de93713f4e2a98ce6263f15b83c28bc3c353589368bb325efd
 SHA512:
-  metadata.gz: 7011298d19ac200f7ea4bd10686642ac30911cbd509eb7dd0152a29b88f4dedd942803fdbd4198a9374e868d060cdf7f3458860c407210d0aa4e5a3e812d63e9
-  data.tar.gz: 8a7cdc716bd4c7f6edddfae2488593f2ec17908203218df57d542057753973528262ff96d1b9986b7c02ec4a08f33a740e0ba162e32752c75725c2c2a60affb5
+  metadata.gz: 813350d41deb97b978afc55d3aad33e3bf1b383a721ab3a33b8ed56cfdd4b2158ba5c6e7368839d3f7ac74e53614c644e2f92a3a6ccc64608d1b89c5274396a1
+  data.tar.gz: 78074ff71327905079cbd603d640d09625d4e49bf1dc9e8a7e7823b8ba923d1abb0c69c833a0a956aa6d0e1af92e53bbae97015827d83219d8c384abf8a349b0

data/lib/greenhat/accessors/disk.rb

@@ -30,7 +30,6 @@ module GreenHat
     end
 
     # Unified Output Handler
-    # rubocop:disable Metrics/MethodLength
     def self.format_output(file, name = false, limit = nil, filter = %w[tmpfs loop])
       output = []
 
@@ -62,7 +61,7 @@ module GreenHat
           disk.use.rjust(5).ljust(5).pastel(:green),
           '  ['.pastel(:blue),
           ('=' * (disk.use.to_i / 2)).pastel(:green),
-          ' ' * (50 - disk.use.to_i / 2),
+          ' ' * (50 - (disk.use.to_i / 2)),
           ']'.pastel(:blue)
         ].join
 
@@ -78,7 +77,6 @@ module GreenHat
 
       output
     end
-    # rubocop:enable Metrics/MethodLength
 
     # Unified Output Handler
     def self.markdown_format(file, name = false, limit = nil, filter = %w[tmpfs loop])

data/lib/greenhat/accessors/gitlab.rb

@@ -35,6 +35,7 @@ module GreenHat
     end
 
     # Show GitLab Services in a grid / include versions
+    # rubocop:disable Metrics/PerceivedComplexity
     def self.services(archive, indent = 0)
       manifest = archive.things.find { |x| x.type == 'gitlab/version-manifest.json' }
       gitlab_status = archive.things.find { |x| x.name == 'gitlab_status' }
@@ -43,6 +44,7 @@ module GreenHat
 
       list = gitlab_status.data.keys.sort.map do |service|
         color = gitlab_status.data.dig(service, 0, :status) == 'run' ? :green : :red
+        status = gitlab_status.data.dig(service, 0, :status) == 'run' ? '↑' : '↓'
 
         # Collect Service version from manifest
         version = manifest.data.software[service.to_sym]&.display_version
@@ -50,7 +52,7 @@ module GreenHat
         # If able to identify version use / fallback
         if version
           [
-            service.pastel(color),
+            "#{service}#{status}".pastel(color),
             "(#{version})".pastel(:bright_black)
           ].join(' ')
         else
@@ -71,13 +73,14 @@ module GreenHat
 
       table.render(:unicode, padding: [0, 1, 0, 1], indent: indent)
     end
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def self.services_markdown(archive)
       # manifest = archive.things.find { |x| x.type == 'gitlab/version-manifest.json' }
       gitlab_status = archive.things.find { |x| x.name == 'gitlab_status' }
 
       list = gitlab_status.data.keys.sort.map do |service|
-        status = gitlab_status.data.dig(service, 0, :status) == 'run' ? '↑' : '!'
+        status = gitlab_status.data.dig(service, 0, :status) == 'run' ? '↑' : '↓'
 
         "#{service}#{status}"
       end

data/lib/greenhat/archive.rb

@@ -102,11 +102,16 @@ class Archive < Teron
     "#<Archive name: '#{name}'>"
   end
 
-  def report
-    GreenHat::Report.new(self)
+  def report(flags)
+    GreenHat::Report.new(self, flags)
   end
 
   def report_markdown
     GreenHat::ReportMarkdown.new(self)
   end
+
+  # Helper for finding thing
+  def thing?(thing_name = 'gitlab-workhorse/current')
+    things.find { |x| x.name == thing_name }
+  end
 end

data/lib/greenhat/cli.rb

@@ -348,6 +348,7 @@ module GreenHat
       @quiet = !@quiet
     end
 
+    # rubocop:disable Metrics/MethodLength
     def self.cli_help
       Shell.version
       puts
@@ -361,6 +362,14 @@ module GreenHat
       puts '    Run `report` against archives and exit'
       puts
 
+      puts '  --full-report, -f'.pastel(:green)
+      puts '    Run `report` with all details. e.g. include fast-stats top/errors'
+      puts
+
+      puts '  --markdown, -m'.pastel(:green)
+      puts '    Run `markdown_report` against archives and exit'
+      puts
+
       puts '  --quiet, -r'.pastel(:green)
       puts '    Surpress GreenHat logging output'
       puts
@@ -373,10 +382,19 @@ module GreenHat
       puts '    Run and then exit a GreenHat Shell command'
       puts
 
+      puts '  --web, -w'.pastel(:green)
+      puts '    Start Sinatra Webservice on load (4567)'
+      puts
+
+      puts '  --no-color, -n'.pastel(:green)
+      puts '    Disable color output'
+      puts
+
       puts '  --version, -v'.pastel(:green)
       puts '    Print version and exit'
       puts
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Arguments before general processing
     def self.pre_args(flags, files)
@@ -408,21 +426,38 @@ module GreenHat
 
     # Arguments to be handled after general processing
     def self.post_args(flags)
+      # Supress Color
+      GreenHat::Settings.settings[:color] = false if flags?(%i[no-color n], flags)
+
       # Run report and exit / Don't Clear for reports
       if flags?(%i[report r], flags)
         @quiet = true
         # Don't Use Pagination
         GreenHat::Shell.report(['--raw'])
         exit 0
+      elsif flags?(%i[full-report f], flags)
+        @quiet = true
+        # Don't Use Pagination
+        GreenHat::Shell.report(['--raw', '--full'])
+        exit 0
+      elsif flags?(%i[markdown m], flags)
+        @quiet = true
+        # Don't Use Pagination
+        GreenHat::Shell.markdown_report(['--raw'])
+        exit 0
       else
         clear_screen
       end
+    end
 
+    def self.post_setup(flags)
       # CTL Tails need to be parsed for new 'things'
       Thing.where(kind: :gitlab_tail)&.map(&:process)
       Thing.where(kind: :kube_webservice)&.map(&:process)
 
       Thing.all.each(&:process) if flags?(%i[load l], flags)
+
+      Shell.web if flags?(%i[web w], flags)
     end
 
     # Helper to Simplify checking flags
@@ -438,6 +473,7 @@ module GreenHat
       load_files files
       run_command(args) if args.any? { |arg| run_command?(arg) }
       post_args(flags)
+      post_setup(flags)
 
       value ||= '' # Empty Start
 

data/lib/greenhat/host.rb

@@ -14,17 +14,23 @@ class Host < Teron
   # end
 
   def archive_name
-    File.basename archive
+    archive.friendly_name
   end
 
   def find_file(file_name)
     files.find { |x| x.name == file_name }
   end
 
-  def icon
-    release_file = find_file files.map(&:name).grep(/_release/).first
+  def things
+    archive.things
+  end
 
-    release = release_file.raw.join
+  def find_thing(param)
+    things.find { |x| x.name.include? param }
+  end
+
+  def icon
+    release = find_thing('etc/os-release').data['ID_LIKE']
 
     if release.include? 'ubuntu'
       'fa-ubuntu'
@@ -57,41 +63,36 @@ class Host < Teron
   end
   # ---------------------------
 
-  def manifest
-    file = find_file 'gitlab_version_manifest_json'
+  def gitlab_version
+    file = find_thing 'gitlab/version-manifest.json'
     return nil unless file
 
-    Oj.load file.raw.join
+    file.data.build_version
   end
 
   def uptime
-    file = find_file 'uptime'
+    file = find_thing 'uptime'
     return nil unless file
 
     file.raw
   end
 
   def uname
-    file = find_file 'uname'
+    file = find_thing 'uname'
     return nil unless file
 
     file.raw.join
   end
 
   def cpuinfo
-    file = find_file 'cpuinfo'
+    file = find_thing 'lscpu'
     return nil unless file
 
-    file.raw.join("\n").split("\n\n").map do |cpu|
-      all = cpu.split("\n").map do |row|
-        row.delete("\t").split(': ')
-      end
-      { details: all[1..], order: all[0].last }
-    end
+    file.data
   end
 
   def cpu_speed
-    file = find_file 'lscpu'
+    file = find_thing 'lscpu'
     return nil unless file
 
     details = file.raw.find { |x| x.include? 'MHz' }
@@ -99,7 +100,7 @@ class Host < Teron
   end
 
   def total_memory
-    file = find_file 'free_m'
+    file = find_thing 'free_m'
     return nil unless file
 
     value = file.raw.dig(1, 1).to_i
@@ -107,28 +108,28 @@ class Host < Teron
   end
 
   def free_m
-    file = find_file 'free_m'
+    file = find_thing 'free_m'
     return nil unless file
 
     file.raw
   end
 
   def df_h
-    file = find_file 'df_h'
+    file = find_thing 'df_h'
     return nil unless file
 
     file.raw
   end
 
   def netstat
-    file = find_file 'netstat'
+    file = find_thing 'netstat'
     return nil unless file
 
     file.raw
   end
 
   def ulimit
-    file = find_file 'ulimit'
+    file = find_thing 'ulimit'
     return nil unless file
 
     results = file.raw.map do |entry|
@@ -142,7 +143,7 @@ class Host < Teron
   end
 
   def processes
-    file = find_file 'ps'
+    file = find_thing 'ps'
     return nil unless file
 
     headers = file.raw.first.split(' ', 11)
@@ -155,7 +156,7 @@ class Host < Teron
   end
 
   def systemctl_unit_files
-    file = find_file 'systemctl_unit_files'
+    file = find_thing 'systemctl_unit_files'
     return nil unless file
 
     all = file.raw[1..-2].map do |x|
@@ -167,16 +168,3 @@ class Host < Teron
     all.sort_by(&:unit)
   end
 end
-
-# # Slim Wrapper
-# class List
-#   attr_accessor :hosts
-
-#   def initialize
-#     self.hosts = []
-#   end
-
-#   def slim(file, host = nil)
-#     Slim::Template.new("#{__dir__}/views/#{file}.slim").render(host)
-#   end
-# end

data/lib/greenhat/shell/args.rb

@@ -1,12 +1,5 @@
 module GreenHat
   # Module for Argument Parsing
-  # Possible Args
-  # --value=thing
-  # --value / Default => --value=thing
-  # --flag
-  # --slice=value,value2
-  # files
-
   # Variable Breakdown
   # Args:Array supplied or default values for entry looping action
   # Flags:Hash Key/Value filter Actionables
@@ -15,7 +8,14 @@ module GreenHat
     def self.parse(raw, skip_flags = [])
       # Don't affect original object / Better deep clone?
       cmd = raw.clone
-      # cmd = Marshal.load(Marshal.dump(raw))
+
+      # Handle Pipe Params
+      pipe = nil
+      if cmd.include?('|')
+        list = cmd.split('|')
+        cmd = list.shift
+        pipe = list.map { |x| x.join(' ') }.join('|')
+      end
 
       # Extract Files
       files = cmd.grep_v(/^-+([^=]+)/)
@@ -33,6 +33,9 @@ module GreenHat
       # And / Or
       flag_defaults(flags, skip_flags)
 
+      # Set command includes
+      flags[:pipe] = pipe if pipe
+
       [files, flags, args]
     end
 
@@ -78,19 +81,29 @@ module GreenHat
     # Arg Scan (Split -- values into keys)
     def self.arg_scan(arg)
       arg.scan(/^-+([^=]+)=(.*)/).map do |field, value|
+        logic = :include?
         bang = false
+
+        # Exclude Logic
         if field.include? '!'
           field.delete!('!')
           bang = true
         end
 
+        # Numeric Magic Logic
+        logic = :<= if field.include? '<'
+        logic = :>= if field.include? '>'
+        field.delete!('<')
+        field.delete!('>')
+
         # Symbolize
         field = field.to_sym
 
         {
           field: field,
           value: arg_normalize(field, value),
-          bang: bang
+          bang: bang,
+          logic: logic
         }
       end
     end

data/lib/greenhat/shell/faststats.rb

@@ -137,7 +137,7 @@ module GreenHat
       # --limit=X
       # --sort=count,fail,max,median,min,p95,p99,rps,score
       # ========================================================================
-      def self.top(raw)
+      def self.top(raw = [], internal = false)
         unless TTY::Which.exist? 'fast-stats'
           faststats_installation
           return false
@@ -155,6 +155,9 @@ module GreenHat
           ]
         end
 
+        # Quick exit for internal processing
+        return results.flatten if internal
+
         ShellHelper.show(results.flatten, flags)
       end
       # ========================================================================
@@ -162,14 +165,14 @@ module GreenHat
       # ========================================================================
       # ===== [ Fast Stats - Errors ] ====================
       # ========================================================================
-      def self.errors(raw)
+      def self.errors(raw = [], internal = false)
         unless TTY::Which.exist? 'fast-stats'
           faststats_installation
           return false
         end
 
         # Add Color Output
-        raw.push '--color-output'
+        raw.push '--color-output' if Settings.settings.color?
         files, flags, cmd = ShellHelper::Faststats.parse(raw)
 
         LogBot.debug('FastStats CMD', cmd) if ENV['DEBUG']
@@ -182,6 +185,9 @@ module GreenHat
           ]
         end
 
+        # Quick exit for internal processing
+        return results.flatten if internal
+
         ShellHelper.show(results.flatten, flags)
       end
       # ========================================================================
@@ -236,6 +242,20 @@ module GreenHat
           files.any? { |x| thing.name.include? x }
         end
       end
+
+      # =====================================
+      # Internal Helpers
+      # =====================================
+      def self.faststats?
+        TTY::Which.exist?('fast-stats')
+      end
+
+      def self.run(thing, cmd = '')
+        # Blank return if cannot possibly run
+        return {} unless thing || !faststats?
+
+        Oj.load `fast-stats #{cmd} #{thing.file} --format=json`
+      end
     end
   end
 end

data/lib/greenhat/shell/field_helper.rb

@@ -60,7 +60,7 @@ module GreenHat
       auto = fields.split(',').last
 
       # Field Finder
-      matches = fields_find(files, auto, flags)
+      matches = fields_find(files, auto, flags).uniq
 
       if matches.count == 1
         "--#{cmd}=#{(complete + matches).join(',')}"

data/lib/greenhat/shell/filter_help.rb

@@ -2,7 +2,7 @@ module GreenHat
   # CLI Helper
   module ShellHelper
     # Unify Filter / Filter Help
-    # rubocop:disable Metrics/MethodLength,Metrics/ModuleLength
+    # rubocop:disable Metrics/MethodLength,Metrics/ModuleLength,Layout/LineLength
     module Filter
       def self.help
         puts "\u2500".pastel(:cyan) * 20
@@ -38,7 +38,7 @@ module GreenHat
         puts
 
         puts '--total'.pastel(:green)
-        puts '  Print only total count of matching entries'
+        puts '  Show total count, duration, start/end time for matching entries'
         puts
 
         puts '--fields'.pastel(:green)
@@ -138,17 +138,39 @@ module GreenHat
         puts '  Ex: --truncate=200, --truncate=2048"'
         puts
 
-        puts 'Field Searching'.pastel(:blue)
-        puts '  --[key]=[value]'
-        puts '  Search in key for value'
-        puts '  Example: --path=mirror/pull'
-        puts
-
         puts 'Search specific logs'.pastel(:blue)
         puts '  Any non dash parameters will be the log list to search from'
         puts "  Ex: log filter --path=api sidekiq/current (hint: use  `#{'ls'.pastel(:yellow)}` for log names"
         puts
 
+        puts 'General (Field) Searching'.pastel(:blue)
+        puts "  There are different ways filter within specific keys/fields within log. The baseline is #{'--[key]=[value]'.pastel(:green)}"
+        puts '  This will, by default, select any entries with any partial match (case insensitive) of [value] in the entry [key]'
+        puts '  Example: --path=mirror/pull'
+        puts
+
+        puts "  You can modify logic with params like: #{'case'.pastel(:green)}, #{'exact'.pastel(:green)}"
+        puts '  Ex Case turn on case sensitivity, exact will change from the inclusive to only exact matching.'
+        puts
+
+        puts "  You can also use multiple #{'--[key]=[value]'.pastel(:green)} to narrow down, or combine it with #{'or'.pastel(:green)} to be more inclusive"
+        puts '  Ex nginx/gitlab_access.log --http_user_agent=gitlab-runner --path=/api/v4/jobs/request'
+        puts '  This will look through the access logs for anything that is a runner (user agent) and hitting the request endpoint'
+        puts
+
+        puts " You can also modify whether a field search excluded or a integer (and technically string) comparison by changing the operator:  #{'(!= >= <=)'.pastel(:green)}"
+        puts ' Ex "nginx/gitlab_access.log --http_user_agent=gitlab-runner  --http_user_agent!=13.12.0" will exclude any entries with 13.12.0/13.12 runners'
+        puts ' Ex "sidekiq/current --duration_s>=5 --class!=LdapSyncWorker" Duration over 5 that is not an ldap job'
+        puts
+
+        puts 'Pipe to Shell'.pastel(:blue)
+        puts '  This is very experimental! The idea is to take all the output from the search and allow a pipe into a traditional shell command.'
+        puts '  Due to the arg parsing its not a straight send to the terminal. You may need to escape quotes.'
+        puts '  Order is relevant, no arguments after the pipe'
+        puts
+        puts '  <files> <params> | grep path'
+        puts
+
         puts 'Example Queries'.pastel(:blue)
         puts "  Also see #{'examples'.pastel(:bright_blue)} for even more examples"
         puts '  log filter --class=BuildFinishedWorker sidekiq/current --slice=time,message'
@@ -202,7 +224,7 @@ module GreenHat
 
           total: [
             '--total'.pastel(:green),
-            '  Print only total count of matching entries'
+            '  Show total count, duration, start/end time for matching entries'
           ],
 
           fields: [
@@ -357,7 +379,7 @@ module GreenHat
 
         }
       end
-      # rubocop:enable Metrics/MethodLength,Metrics/ModuleLength
+      # rubocop:enable Metrics/MethodLength,Metrics/ModuleLength,Layout/LineLength
     end
   end
 end