greenhat 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf89eef7afeef6861dde013e8cc7992a92d1c9f4dca79ca0a438913f6d9a7a89
-  data.tar.gz: eed033653f4723f19962f5643ac02c71d9f950f97aa4a68375cc3174152e5513
+  metadata.gz: 6ff63bc1345ac9a27d3fa6263fc3a68e9c851aa30f2b3bf58cdee484ce142cbb
+  data.tar.gz: a150c0d19b954883ef2372280b78a89606a5e9039944b794289c9541c3548ed3
 SHA512:
-  metadata.gz: 90c1a58ef0334bd864480ad422957758850ecacd39bc85db1fd47233192e09bda768e15331dc179d8860f4842aed58fafb439f4f9499ff22d1c25e3ebf8bff74
-  data.tar.gz: aea2b938e6b1a5956d7811084b1ab725cf41f2d0766affffed696755ac497cc41a67ebfc562ce516ce448ebb983e6e504a493e772348fd536f1e5c711954f612
+  metadata.gz: 7011298d19ac200f7ea4bd10686642ac30911cbd509eb7dd0152a29b88f4dedd942803fdbd4198a9374e868d060cdf7f3458860c407210d0aa4e5a3e812d63e9
+  data.tar.gz: 8a7cdc716bd4c7f6edddfae2488593f2ec17908203218df57d542057753973528262ff96d1b9986b7c02ec4a08f33a740e0ba162e32752c75725c2c2a60affb5

data/lib/greenhat/accessors/disk.rb

@@ -79,5 +79,46 @@ module GreenHat
       output
     end
     # rubocop:enable Metrics/MethodLength
+
+    # Unified Output Handler
+    def self.markdown_format(file, name = false, limit = nil, filter = %w[tmpfs loop])
+      output = []
+
+      output << file.friendly_name if name
+
+      # Reject TMPFS
+      disks = file.data.sort_by { |x| x.use.to_i }.reverse
+
+      # Filter
+      disks.reject! { |x| filter.any? { |y| x.filesystem.include? y } }
+
+      disks = disks[0..limit - 1] if limit
+
+      pad_mount, pad_size, pad_used, pad_avail = GreenHat::Disk.padding(disks)
+
+      # Headers
+      output << [
+        'Mount'.ljust(pad_mount),
+        'Size'.ljust(pad_size),
+        'Used'.ljust(pad_used),
+        'Avail'.ljust(pad_avail),
+        '% Use'.ljust(pad_avail)
+      ].join
+
+      # Table Summary
+      disks.map do |disk|
+        # Whole Thing
+        output << [
+          disk.mounted_on.ljust(pad_mount),
+          disk[:size].to_s.ljust(pad_size),
+          disk.used.to_s.ljust(pad_used),
+          disk.avail.to_s.ljust(pad_avail),
+          disk.use.rjust(5).ljust(5)
+        ].join
+      end
+
+      output
+    end
+    # =
   end
 end

data/lib/greenhat/accessors/gitlab.rb

@@ -71,5 +71,31 @@ module GreenHat
 
       table.render(:unicode, padding: [0, 1, 0, 1], indent: indent)
     end
+
+    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' ? '↑' : '!'
+
+        "#{service}#{status}"
+      end
+
+      # Keep Alphabetical Sort
+      groups = list.each_slice((list.size / 3.to_f).round).to_a
+
+      table = TTY::Table.new do |t|
+        loop do
+          break if groups.all?(&:empty?)
+
+          t << groups.map(&:shift)
+        end
+      end
+
+      "```\n#{table.render(:basic)}\n```"
+    end
+
+    # ==
   end
 end

data/lib/greenhat/accessors/memory.rb

@@ -6,7 +6,7 @@ module GreenHat
     end
 
     def self.percentage(used, total)
-      return 0 if used.to_i.zero?
+      return 0 if used.to_i.zero? || total.to_i.zero?
 
       # Show at least one bar if below 1%
       [1, ((used.to_i / total.to_f).round(1) * 100).round].max

data/lib/greenhat/archive.rb

@@ -105,4 +105,8 @@ class Archive < Teron
   def report
     GreenHat::Report.new(self)
   end
+
+  def report_markdown
+    GreenHat::ReportMarkdown.new(self)
+  end
 end

data/lib/greenhat/cli.rb

@@ -65,7 +65,9 @@ module GreenHat
     # Auto Complete
     # =========================================================
     def self.auto
-      word = reader.line.word
+      word = @list.last
+      # This is being weird with auto complete
+      # word = reader.line.word
 
       if word.blank?
         help
@@ -74,6 +76,10 @@ module GreenHat
       end
     end
 
+    def self.file_matches(word)
+      files.select { |x| x[/^#{Regexp.escape(word)}/] }
+    end
+
     def self.auto_match(matches, word)
       matches.select! { |x| x[/^#{Regexp.escape(word)}/] }
 
@@ -88,11 +94,14 @@ module GreenHat
       elsif matches.count > 1
         puts matches.join("\t").pastel(:bright_green)
 
-      # No other Matches
-      else
-        file_matches = files.select { |x| x[/^#{Regexp.escape(word)}/] }
-        auto_files(file_matches, word) unless file_matches.empty?
+      # General Filename Matching
+      elsif !file_matches(word).empty?
+        auto_files(file_matches(word), word)
 
+      # Submodule Autocompletion
+      elsif current_methods.include?('auto_complete')
+        update_text = current_location.auto_complete(@list, word)
+        auto_update(update_text, word) unless update_text.blank?
       end
     end
 
@@ -237,13 +246,17 @@ module GreenHat
       @list.any? { |x| x.include?(cmd) } && current_methods.include?('default')
     end
 
+    def self.current_commands
+      current_location.methods(false).map(&:to_s).sort - %w[auto_complete]
+    end
+
     # General Helper
     def self.help(long = true)
       if current_location.methods(false).count.zero?
         puts 'No Commands'.pastel(:red)
       else
         puts 'Commands: '
-        current_location.methods(false).map(&:to_s).sort.each do |item|
+        current_commands.each do |item|
           next if %w[default help].any? { |x| x == item }
 
           puts "=> #{item.to_s.pastel(:blue)}"
@@ -340,6 +353,7 @@ module GreenHat
       puts
       puts 'Usage'.pastel(:yellow)
       puts '  greenhat  <sos-archive.tgz> <sos-archive2.tgz> '
+      puts '  greenhat  <sos-archive.tgz> -q --command=df'
       puts
 
       puts 'Options'.pastel(:yellow)
@@ -406,6 +420,7 @@ module GreenHat
 
       # 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)
     end

data/lib/greenhat/shell/args.rb

@@ -70,8 +70,8 @@ module GreenHat
     # Flags Anything that isn't sent as a key/filter
     def self.arg_to_flag_list
       %i[
-        archive end except exists json limit pluck reverse round slice sort start stats
-        truncate uniq page
+        archive end except exists json limit pluck reverse round slice sort start
+        stats truncate uniq page time_zone table_style
       ]
     end
 

data/lib/greenhat/shell/faststats.rb

@@ -67,8 +67,20 @@ module GreenHat
       end
       # rubocop:enable Metrics/MethodLength)
 
+      def self.faststats_installation
+        puts "#{'Unable to find'.pastel(:red)} #{'fast-stats'.pastel(:blue)}"
+        puts '  Release Downloads here'
+        puts '    - https://gitlab.com/gitlab-com/support/toolbox/fast-stats/-/releases'.pastel(:yellow)
+        puts ''
+      end
+
       # List Files Helpers
       def self.list(args = [])
+        unless TTY::Which.exist? 'fast-stats'
+          faststats_installation
+          return false
+        end
+
         all = false
         all = true if args.include?('-a') || args.include?('--all')
 
@@ -96,6 +108,11 @@ module GreenHat
 
       # Vanilla Fast Stats
       def self.default(raw, _other = nil)
+        unless TTY::Which.exist? 'fast-stats'
+          faststats_installation
+          return false
+        end
+
         files, flags, cmd = ShellHelper::Faststats.parse(raw)
 
         LogBot.debug('FastStats CMD', cmd) if ENV['DEBUG']
@@ -121,6 +138,11 @@ module GreenHat
       # --sort=count,fail,max,median,min,p95,p99,rps,score
       # ========================================================================
       def self.top(raw)
+        unless TTY::Which.exist? 'fast-stats'
+          faststats_installation
+          return false
+        end
+
         files, flags, cmd = ShellHelper::Faststats.parse(raw)
 
         LogBot.debug('FastStats CMD', cmd) if ENV['DEBUG']
@@ -141,6 +163,11 @@ module GreenHat
       # ===== [ Fast Stats - Errors ] ====================
       # ========================================================================
       def self.errors(raw)
+        unless TTY::Which.exist? 'fast-stats'
+          faststats_installation
+          return false
+        end
+
         # Add Color Output
         raw.push '--color-output'
         files, flags, cmd = ShellHelper::Faststats.parse(raw)

data/lib/greenhat/shell/field_helper.rb

@@ -0,0 +1,75 @@
+module GreenHat
+  # Common Helpers
+  module FieldHelper
+    def self.fields_find(files, word, flags = {})
+      fields = ShellHelper.find_things(files, flags).map(&:fields).flatten.uniq
+
+      if word.blank?
+        puts 'Possible Fields:'.pastel(:bright_blue)
+        puts ShellHelper.field_table(fields)
+
+        return [] # Empty Result
+      end
+
+      list_select(fields, word)
+    end
+
+    def self.list_select(list, word)
+      list.select! { |x| x[/^#{Regexp.escape(word)}/] }
+    end
+
+    def self.filter_flags(word)
+      if word.blank?
+        puts 'Filter Options:'.pastel(:bright_blue)
+        puts ShellHelper.field_table(filter_opts, 6)
+        puts
+
+        return []
+      end
+
+      list_select(filter_opts, word)
+    end
+
+    def self.filter_opts
+      %w[
+        archive case combine end exact except exists json limit or page pluck
+        raw reverse round slice sort start stats table_style text time_zone
+        total truncate uniq
+      ]
+    end
+
+    def self.filter_auto_completes
+      %w[
+        except exists pluck slice sort stats uniq
+      ]
+    end
+
+    def self.field_auto_complete?(word)
+      return false if word.blank?
+
+      filter_auto_completes.include? word.split('=', 2).first
+    end
+
+    def self.field_auto_complete(word, files, flags = {})
+      # Prevent weird dupes
+      return nil if word[-1] == ','
+
+      # Command Manipulation
+      cmd, fields = word.split('=', 2)
+      complete = fields.split(',')[0..-2]
+      auto = fields.split(',').last
+
+      # Field Finder
+      matches = fields_find(files, auto, flags)
+
+      if matches.count == 1
+        "--#{cmd}=#{(complete + matches).join(',')}"
+      elsif matches.count > 1
+        puts "#{'Field Options:'.pastel(:bright_blue)} #{matches.join(' ').pastel(:bright_green)}"
+
+        list = [Cli.common_substr(matches.map(&:to_s))]
+        "--#{cmd}=#{(complete + list).join(',')}"
+      end
+    end
+  end
+end

data/lib/greenhat/shell/filter_help.rb

@@ -2,8 +2,8 @@ module GreenHat
   # CLI Helper
   module ShellHelper
     # Unify Filter / Filter Help
+    # rubocop:disable Metrics/MethodLength,Metrics/ModuleLength
     module Filter
-      # rubocop:disable Metrics/MethodLength
       def self.help
         puts "\u2500".pastel(:cyan) * 20
         puts 'Filter'.pastel(:yellow)
@@ -11,7 +11,7 @@ module GreenHat
 
         puts 'Options'.pastel(:blue)
         puts '--raw'.pastel(:green)
-        puts '  Do not use less/paging'
+        puts '  Disable formatting and page/less'
         puts
 
         puts '--page'.pastel(:green)
@@ -41,6 +41,10 @@ module GreenHat
         puts '  Print only total count of matching entries'
         puts
 
+        puts '--fields'.pastel(:green)
+        puts '  Print only Available fields for selected files'
+        puts
+
         puts '--slice'.pastel(:green)
         puts '  Extract specific fields from entries (slice multiple with comma)'
         puts '  Ex: --slice=path or --slice=path,params'
@@ -57,7 +61,7 @@ module GreenHat
         puts
 
         puts '--stats'.pastel(:green)
-        puts '  Order/Count occurrances by field'
+        puts '  Order/Count occurrances by field. Combine with `truncate` for key names'
         puts '  Ex: --stats=params --except=params,path'
         puts
 
@@ -113,6 +117,21 @@ module GreenHat
         puts '  Ex: log filter --end="2021-06-22"'
         puts
 
+        puts '--time_zone'.pastel(:green)
+        puts '  Manipulate the `time` field into a specific timezone'
+        puts '  Ex: log filter --time_zone=EDT'
+        puts
+
+        puts '--text'.pastel(:green)
+        puts '  Full entry text searching (slow)'
+        puts '    --text="anything here"'
+        puts
+
+        puts '--table_style'.pastel(:green)
+        puts '  Renderer used for formatted output. basic, ascii, or unicode(default)'
+        puts '  Ex: log filter --table_style=base'
+        puts
+
         puts '--truncate'.pastel(:green)
         puts '  Truncate field length. On by default (4 rows). Performance issues!'
         puts '  Disable with --truncate=0'.pastel(:bright_red)
@@ -137,7 +156,208 @@ module GreenHat
 
         puts
       end
-      # rubocop:enable Metrics/MethodLength
+
+      def self.help_index
+        {
+          title: [
+            "\u2500".pastel(:cyan) * 20,
+            'Filter'.pastel(:yellow),
+            "\u2500".pastel(:cyan) * 20
+          ],
+          options: [
+            'Options'.pastel(:blue)
+          ],
+
+          raw: [
+            '--raw'.pastel(:green),
+            '  Disable formatting and page/less'
+          ],
+
+          page: [
+            '--page'.pastel(:green),
+            '  Specifically enable or disable paging',
+            '  E.g. --page (default to true), --page=true, --page=false'
+          ],
+
+          round: ['--round'.pastel(:green),
+                  '  Attempt to round all integers. Default: 2.',
+                  '  E.g. --round, --round=3, --round=0'],
+
+          limit: [
+
+            '--limit'.pastel(:green),
+            '  Limit total output lines. Disabled by default. Default without value is based on screen height',
+            '  E.g. --limit, --limit=5'
+          ],
+
+          json: [
+            '--json'.pastel(:green),
+            '  Print output back into JSON'
+          ],
+
+          or: [
+            '--or'.pastel(:green),
+            '  Filters will use OR instead of AND (all match vs any match)'
+          ],
+
+          total: [
+            '--total'.pastel(:green),
+            '  Print only total count of matching entries'
+          ],
+
+          fields: [
+            '--fields'.pastel(:green),
+            '  Print only Available fields for selected files'
+          ],
+
+          slice: [
+            '--slice'.pastel(:green),
+            '  Extract specific fields from entries (slice multiple with comma)',
+            '  Ex: --slice=path or --slice=path,params'
+
+          ],
+
+          except: [
+            '--except'.pastel(:green),
+            '  Exclude specific fields (except multiple with comma)',
+            '  Ex: --except=params --except=params,path'
+
+          ],
+
+          exists: [
+            '--exists'.pastel(:green),
+            '  Ensure field exists regardless of contents',
+            '  Ex: --exists=params --exists=params,path'
+
+          ],
+
+          stats: [
+            '--stats'.pastel(:green),
+            '  Order/Count occurrances by field. Combine with `truncate` for key names',
+            '  Ex: --stats=params --except=params,path'
+
+          ],
+
+          uniq: [
+            '--uniq'.pastel(:green),
+            '  Show unique values only',
+            '  Ex: --uniq=params --uniq=params,path'
+
+          ],
+
+          pluck: [
+            '--pluck'.pastel(:green),
+            '  Extract values from entries',
+            '  Ex: --pluck=params --pluck=params,path'
+
+          ],
+
+          archive: [
+            '--archive'.pastel(:green),
+            '  Limit to specific archvie name (partial matching /inclusive). Matching SOS tar.gz name',
+            '  Ex: --archive=dev-gitlab_20210622154626, --archive=202106,202107'
+
+          ],
+
+          sort: [
+            '--sort'.pastel(:green),
+            '  Sort by multiple fields',
+            '  Ex: --sort=duration_s,db_duration_s'
+
+          ],
+
+          reverse: [
+            '--reverse'.pastel(:green),
+            '  Reverse all results',
+            '  Ex: --reverse'
+
+          ],
+
+          combine: [
+            '--combine'.pastel(:green),
+            '  Omit archive identifier dividers. Useful with sort or time filters',
+            '  Ex: --combine'
+
+          ],
+
+          case: [
+            '--case'.pastel(:green),
+            '  Exact case match. Defaults to case insensitive',
+            '  Ex: --case; --name=Jon, --name=jane --case'
+
+          ],
+
+          exact: [
+            '--exact'.pastel(:green),
+            '  Exact parameter/value match. Defaults to partial match',
+            '  Ex: --field=CommonPartial --exact'
+
+          ],
+
+          start: [
+            '--start'.pastel(:green),
+            '  Show events after specified time. Filtered by the `time` field',
+            '  Use with `--end` for between selections',
+            '  Ex: log filter --start="2021-06-22 14:44  UTC" --end="2021-06-22 14:45 UTC"'
+
+          ],
+
+          end: [
+            '--end'.pastel(:green),
+            '  Show events before specified time. Filtered by the `time` field',
+            '  Use with `--start` for between selections',
+            '  Ex: log filter --end="2021-06-22"'
+          ],
+
+          time_zone: [
+            '--time_zone'.pastel(:green),
+            '  Manipulate the `time` field into a specific timezone',
+            '  Ex: log filter --time_zone=EDT'
+
+          ],
+
+          text: [
+            '--text'.pastel(:green),
+            '  Full entry text searching (slow)',
+            '    --text="anything here"'
+          ],
+
+          table_style: [
+            '--table_style'.pastel(:green),
+            '  Renderer used for formatted output. basic, ascii, or unicode(default)',
+            '  Ex: log filter --table_style=base'
+          ],
+
+          truncate: [
+            '--truncate'.pastel(:green),
+            '  Truncate field length. On by default (4 rows). Performance issues!',
+            '  Disable with --truncate=0'.pastel(:bright_red),
+            '  Ex: --truncate=200, --truncate=2048"'
+          ],
+
+          field: [
+            'Field Searching'.pastel(:blue),
+            '  --[key]=[value]',
+            '  Search in key for value',
+            '  Example: --path=mirror/pull'
+          ],
+
+          ls: [
+            'Search specific logs'.pastel(:blue),
+            '  Any non dash parameters will be the log list to search from',
+            "  Ex: log filter --path=api sidekiq/current (hint: use  `#{'ls'.pastel(:yellow)}` for log names"
+          ],
+
+          examples: [
+            'Example Queries'.pastel(:blue),
+            "  Also see #{'examples'.pastel(:bright_blue)} for even more examples",
+            '  log filter --class=BuildFinishedWorker sidekiq/current --slice=time,message',
+            '  log filter gitlab-rails/api_json.log --slice=ua --uniq=ua --ua=gitlab-runner'
+          ]
+
+        }
+      end
+      # rubocop:enable Metrics/MethodLength,Metrics/ModuleLength
     end
   end
 end

data/lib/greenhat/shell/log.rb

@@ -3,6 +3,41 @@ module GreenHat
   module Shell
     # Logs
     module Log
+      def self.auto_complete(list, word)
+        # Argument Parsing
+        files, flags, _args = Args.parse(list)
+
+        # Don't try to autocomplete anything else
+        return nil unless word =~ /^-/
+
+        # Clean Up
+        word.delete!('-')
+        matches = FieldHelper.filter_flags(word)
+
+        if matches.count == 1
+          "--#{matches.first}"
+        elsif matches.count > 1
+          puts "#{'Filter Options:'.pastel(:bright_blue)} #{matches.join(' ').pastel(:bright_green)}"
+          "--#{Cli.common_substr(matches)}"
+        # -----------------------------------
+        # TODO: Fix Icky Double Nesting
+        elsif files.count.nonzero?
+          matches = FieldHelper.fields_find(files, word, flags)
+
+          return nil if matches.nil?
+
+          if matches.count == 1
+            "--#{matches.first}"
+          elsif matches.count > 1
+            puts "#{'Field Options:'.pastel(:bright_blue)} #{matches.join(' ').pastel(:bright_green)}"
+            "--#{Cli.common_substr(matches.map(&:to_s))}"
+          elsif FieldHelper.field_auto_complete?(word)
+            FieldHelper.field_auto_complete(word, files, flags)
+          end
+          # -----------------------------------
+        end
+      end
+
       def self.help
         puts "\u2500".pastel(:cyan) * 20
         puts "#{'Logs'.pastel(:yellow)} find stuff"
@@ -12,6 +47,7 @@ module GreenHat
         puts '  filter'.pastel(:green)
         puts "    Primary way for log searching within greenhat. See #{'filter_help'.pastel(:blue)}"
         puts '    Time, round, slice/except, and/or, stats, uniq, sort'
+        puts "    #{'filter_help'.pastel(:blue)} supports filtering Ex: #{'filter_help stats'.pastel(:blue)}"
         puts
 
         puts '  show'.pastel(:green)
@@ -27,8 +63,16 @@ module GreenHat
         puts "See #{'examples'.pastel(:bright_blue)} for query examples"
       end
 
-      def self.filter_help
-        ShellHelper::Filter.help
+      def self.filter_help(args = {})
+        if args.empty?
+          ShellHelper::Filter.help
+        else
+          list = ShellHelper::Filter.help_index.select do |k, _v|
+            k.to_s.include? args.first
+          end
+
+          puts list.values.map { |x| x.join("\n") }.join("\n\n")
+        end
       end
 
       def self.ls(args = [])
@@ -73,6 +117,12 @@ module GreenHat
           return true
         end
 
+        # Skip and Print Total if set
+        if flags[:fields]
+          ShellHelper.fields_print(results)
+          return true
+        end
+
         # Check Search Results
         if results.instance_of?(Hash) && results.values.flatten.empty?
           puts 'No results'.pastel(:red)