greenhat 0.3.3 → 0.4.0

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/settings.rb

@@ -6,12 +6,14 @@ module GreenHat
       @settings ||= {
         history: [],
         assume_json: true,
+        assume_raw: false,
         fuzzy_file_match: true,
 
         # round: [2],
         # page: [:true] Automatic,
         truncate: TTY::Screen.width * 4,
         color: true
+
       }
     end
 
@@ -19,6 +21,10 @@ module GreenHat
       settings.assume_json
     end
 
+    def self.assume_raw?
+      settings.assume_raw
+    end
+
     # Allow for future disabling of color output
     def self.color?
       settings.color

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,8 +2,8 @@ module GreenHat
   # CLI Helper
   module ShellHelper
     # Unify Filter / Filter Help
+    # rubocop:disable Metrics/MethodLength,Metrics/ModuleLength,Layout/LineLength
     module Filter
-      # rubocop:disable Metrics/MethodLength
       def self.help
         puts "\u2500".pastel(:cyan) * 20
         puts 'Filter'.pastel(:yellow)
@@ -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'
@@ -156,7 +178,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),
+            '  Show total count, duration, start/end time for 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,Layout/LineLength
     end
   end
 end