greenhat 0.1.4 → 0.3.1

data/lib/greenhat/shell/disk.rb

@@ -8,60 +8,48 @@ module GreenHat
         Cli.help
       end
 
-      # Easy Show All
-      def self.df
-        ShellHelper.file_output GreenHat::Disk.df
+      def self.help
+        puts "\u2500".pastel(:cyan) * 22
+        puts "#{'Disk'.pastel(:yellow)} -  Storage Helper"
+        puts "\u2500".pastel(:cyan) * 22
+
+        ShellHelper.common_opts
+
+        puts 'Command Summary'.pastel(:blue)
+        puts '  df'.pastel(:green)
+        puts "    Raw #{'df'.pastel(:cyan)} output"
+        puts
+        puts '  free'.pastel(:green)
+        puts '    Formatted / Bar Output'
+        puts
       end
 
-      # rubocop:disable Metrics/MethodLength,Metrics/BlockLength
-      def self.free
-        GreenHat::Disk.df.each do |file|
-          # Reject TMPFS
-          puts file.friendly_name
-          disks = file.data.sort_by { |x| x.use.to_i }.reverse.reject { |x| x.filesystem.include? 'tmpfs' }
+      # Easy Show All
+      def self.df(raw = {})
+        # Extract Args
+        files_list, flags, _args = Args.parse(raw)
 
-          # pad_mount = GreenHat::Disk.max_padding(disks, :mounted_on)
-          # pad_size = GreenHat::Disk.max_padding(disks, :size)
-          # pad_used = GreenHat::Disk.max_padding(disks, :used)
-          # pad_avail = GreenHat::Disk.max_padding(disks, :avail)
+        # Collect Files
+        files = ShellHelper.files(files_list, GreenHat::Disk.df, flags)
 
-          pad_mount, pad_size, pad_used, pad_avail = GreenHat::Disk.padding(disks)
+        # Output
+        ShellHelper.file_output(files, flags)
+      end
 
-          # Headers
-          puts [
-            'Mount'.ljust(pad_mount).colorize(:blue),
-            'Size'.ljust(pad_size).colorize(:magenta),
-            'Used'.ljust(pad_used).colorize(:cyan),
-            'Avail'.ljust(pad_avail).colorize(:white),
-            '% Use'.ljust(pad_avail).colorize(:green)
-          ].join
+      def self.free(raw = {})
+        # Extract Args
+        files_list, flags, _args = Args.parse(raw)
 
-          # Table Summary
-          disks.map do |disk|
-            # Pretty Disk Use
-            use = [
-              disk.use.rjust(5).ljust(5).colorize(:green),
-              '  ['.colorize(:blue),
-              ('=' * (disk.use.to_i / 2)).colorize(:green),
-              ' ' * (50 - disk.use.to_i / 2),
-              ']'.colorize(:blue)
-            ].join
+        # Collect Files
+        files = ShellHelper.files(files_list, GreenHat::Disk.df, flags)
 
-            # Whole Thing
-            puts [
-              disk.mounted_on.ljust(pad_mount).colorize(:blue),
-              disk[:size].to_s.ljust(pad_size).colorize(:magenta),
-              disk.used.to_s.ljust(pad_used).colorize(:cyan),
-              disk.avail.to_s.ljust(pad_avail).colorize(:white),
-              use
-            ].join
-          end
+        files.each do |file|
+          puts GreenHat::Disk.format_output(file, true)
 
           # File End Loop / Break
           puts
         end
       end
-      # rubocop:enable Metrics/MethodLength,Metrics/BlockLength
       # ------------------------------------------------------------------------
     end
   end

data/lib/greenhat/shell/faststats.rb

@@ -5,47 +5,65 @@ module GreenHat
     module Faststats
       # rubocop:disable Metrics/MethodLength)
       def self.help
-        puts "\u2500".colorize(:cyan) * 25
-        puts "Gimme #{'Performance Stats'.colorize(:yellow)}"
-        puts "\u2500".colorize(:cyan) * 25
+        puts "\u2500".pastel(:cyan) * 25
+        puts "Gimme #{'Performance Stats'.pastel(:yellow)}"
+        puts "\u2500".pastel(:cyan) * 25
 
-        puts 'General'.colorize(:blue)
-        puts "  Any double dash arguments (e.g. #{'--color-output'.colorize(:green)}) are passed directly to fast-stats"
-        puts "  See #{'`fast-stats --help`'.colorize(:light_black)} for all available options"
+        puts 'General'.pastel(:blue)
+        puts "  Any double dash arguments (e.g. #{'--color-output'.pastel(:green)}) are passed directly to fast-stats"
+        puts "  See #{'`fast-stats --help`'.pastel(:bright_black)} for all available options"
         puts
 
-        puts 'Common Options'.colorize(:blue)
-        puts '  --raw'.colorize(:green)
+        puts 'Common Options'.pastel(:blue)
+        puts '  --raw'.pastel(:green)
         puts '    Do not use less/paging'
-        puts '  --display'.colorize(:green)
-        puts '     Show percentage of totals and/or actual durations (value, perc, both, default: both)'
-        puts '  --sort'.colorize(:green)
+        puts '  --search'.pastel(:green)
+        puts '     Case-insensitive search of controller/method/worker field'
+        puts '  --sort'.pastel(:green)
         puts '     count,fail,max,median,min,p95,p99,rps,score'
-        puts '  --limit'.colorize(:green)
+        puts '  --limit'.pastel(:green)
         puts '     The number of rows to print'
-        puts '  --verbose'.colorize(:green)
+        puts '  --verbose'.pastel(:green)
         puts '     Prints the component details of the maximum, P99, P95, and median events by total duration for each'
         puts
 
-        puts 'Commands'.colorize(:blue)
-        puts 'ls'.colorize(:green)
+        puts 'Commands'.pastel(:blue)
+        puts 'ls'.pastel(:green)
         puts '  List available files'
         puts '  Options'
         puts '    -a, --all, show all files including source'
         puts
 
-        puts '<file names+>'.colorize(:green)
+        puts '<file names+>'.pastel(:green)
         puts '  Print any file names'
         puts '  Ex: `gitaly/current`'
         puts '  Ex: `gitlab-rails/api_json.log gitlab-rails/production_json.log --raw`'
         puts
 
-        puts 'top'.colorize(:green)
+        puts 'top'.pastel(:green)
         puts '  Print a summary of top items in a category'
         puts
 
-        puts 'errors'.colorize(:green)
+        puts 'errors'.pastel(:green)
         puts '  Show summary of errors captured in log'
+        puts
+
+        puts 'Examples'.pastel(:blue)
+        puts '  Default'.pastel(:bright_white)
+        puts '    gitaly/current'
+        puts '    --raw gitlab-rails/production_json.log'
+        puts '    gitlab-rails/api_json.log --sort=count'
+        puts '    --search=pipeline sidekiq/current'
+        puts
+
+        puts '  Top'.pastel(:bright_white)
+        puts '    top gitaly/current'
+        puts '    top --limit=5 sidekiq/current'
+        puts
+
+        puts '  Errors'.pastel(:bright_white)
+        puts '    errors gitaly/current'
+        puts '    errors gitaly/current --no-border'
       end
       # rubocop:enable Metrics/MethodLength)
 
@@ -67,7 +85,7 @@ module GreenHat
           if all
             puts "- #{log.friendly_name}"
           else
-            puts "- #{log.name.colorize(:yellow)}"
+            puts "- #{log.name.pastel(:yellow)}"
           end
         end
       end
@@ -77,18 +95,10 @@ module GreenHat
       end
 
       # Vanilla Fast Stats
-      def self.default(file_list, _other = nil)
-        # Extract Args
-        file_list, opts, args = ShellHelper.param_parse(file_list)
-
-        cmd = opts.map { |opt| "--#{opt.field}=#{opt.value}" }.join(' ')
-        cmd += args.keys.map { |arg| "--#{arg}" }.join(' ')
+      def self.default(raw, _other = nil)
+        files, flags, cmd = ShellHelper::Faststats.parse(raw)
 
-        # Prepare List
-        file_list = ShellHelper.prepare_list(file_list, ShellHelper::Faststats.things)
-
-        # Convert to Things
-        files = ShellHelper.find_things(file_list)
+        LogBot.debug('FastStats CMD', cmd) if ENV['DEBUG']
 
         results = ShellHelper.file_process(files) do |file|
           [
@@ -98,7 +108,7 @@ module GreenHat
           ]
         end
 
-        ShellHelper.show(results.flatten, args)
+        ShellHelper.show(results.flatten, flags)
       end
 
       # ========================================================================
@@ -110,21 +120,10 @@ module GreenHat
       # --limit=X
       # --sort=count,fail,max,median,min,p95,p99,rps,score
       # ========================================================================
-      def self.top(log_list)
-        # Extract Args
-        log_list, opts, args = ShellHelper.param_parse(log_list)
-
-        # Default to color output
-        args['color-output'] ||= true
-
-        cmd = opts.map { |opt| "--#{opt.field}=#{opt.value}" }.join(' ')
-        cmd += args.keys.map { |arg| "--#{arg}" }.join(' ')
-
-        # Prepare Log List
-        log_list = ShellHelper.prepare_list(log_list, ShellHelper::Faststats.things)
+      def self.top(raw)
+        files, flags, cmd = ShellHelper::Faststats.parse(raw)
 
-        # Convert to Things
-        files = ShellHelper.find_things(log_list)
+        LogBot.debug('FastStats CMD', cmd) if ENV['DEBUG']
 
         results = ShellHelper.file_process(files) do |file|
           [
@@ -134,28 +133,19 @@ module GreenHat
           ]
         end
 
-        ShellHelper.show(results.flatten, args)
+        ShellHelper.show(results.flatten, flags)
       end
       # ========================================================================
 
       # ========================================================================
       # ===== [ Fast Stats - Errors ] ====================
       # ========================================================================
-      def self.errors(log_list)
-        # Extract Args
-        log_list, opts, args = ShellHelper.param_parse(log_list)
+      def self.errors(raw)
+        # Add Color Output
+        raw.push '--color-output'
+        files, flags, cmd = ShellHelper::Faststats.parse(raw)
 
-        # Default to color output
-        args['color-output'] ||= true
-
-        cmd = opts.map { |opt| "--#{opt.field}=#{opt.value}" }.join(' ')
-        cmd += args.keys.map { |arg| "--#{arg}" }.join(' ')
-
-        # Prepare Log List
-        log_list = ShellHelper.prepare_list(log_list, ShellHelper::Faststats.things)
-
-        # Convert to Things
-        files = ShellHelper.find_things(log_list)
+        LogBot.debug('FastStats CMD', cmd) if ENV['DEBUG']
 
         results = ShellHelper.file_process(files) do |file|
           [
@@ -165,7 +155,7 @@ module GreenHat
           ]
         end
 
-        ShellHelper.show(results.flatten, args)
+        ShellHelper.show(results.flatten, flags)
       end
       # ========================================================================
     end
@@ -176,6 +166,35 @@ module GreenHat
   module ShellHelper
     # Hide from Commands
     module Faststats
+      # Default Settings from arg parse that won't work
+      def self.invalid_settings
+        %i[page round truncate logic fuzzy_file_match]
+      end
+
+      def self.parse(raw)
+        file_list, flags, args = Args.parse(raw, invalid_settings)
+        cmd = args.map { |opt| "--#{opt.field}=#{opt.value}" }.join(' ')
+        cmd += flags.map do |flag, value|
+          # Don't Include Raw
+          next if flag == :raw
+
+          case value
+          when true then "--#{flag}"
+          when Array then "--#{flag}=#{value.join}"
+          else
+            "--#{flag}=#{value}"
+          end
+        end.join(' ')
+
+        # Prepare Log List
+        file_list = ShellHelper.prepare_list(file_list, ShellHelper::Faststats.things, flags)
+
+        # Convert to Things
+        files = ShellHelper.find_things(file_list)
+
+        [files, flags, cmd]
+      end
+
       def self.files
         %w[
           production_json

data/lib/greenhat/shell/filter_help.rb

@@ -0,0 +1,143 @@
+module GreenHat
+  # CLI Helper
+  module ShellHelper
+    # Unify Filter / Filter Help
+    module Filter
+      # rubocop:disable Metrics/MethodLength
+      def self.help
+        puts "\u2500".pastel(:cyan) * 20
+        puts 'Filter'.pastel(:yellow)
+        puts "\u2500".pastel(:cyan) * 20
+
+        puts 'Options'.pastel(:blue)
+        puts '--raw'.pastel(:green)
+        puts '  Do not use less/paging'
+        puts
+
+        puts '--page'.pastel(:green)
+        puts '  Specifically enable or disable paging'
+        puts '  E.g. --page (default to true), --page=true, --page=false'
+        puts
+
+        puts '--round'.pastel(:green)
+        puts '  Attempt to round all integers. Default: 2.'
+        puts '  E.g. --round, --round=3, --round=0'
+        puts
+
+        puts '--limit'.pastel(:green)
+        puts '  Limit total output lines. Disabled by default. Default without value is based on screen height'
+        puts '  E.g. --limit, --limit=5'
+        puts
+
+        puts '--json'.pastel(:green)
+        puts '  Print output back into JSON'
+        puts
+
+        puts '--or'.pastel(:green)
+        puts '  Filters will use OR instead of AND (all match vs any match)'
+        puts
+
+        puts '--total'.pastel(:green)
+        puts '  Print only total count of matching entries'
+        puts
+
+        puts '--slice'.pastel(:green)
+        puts '  Extract specific fields from entries (slice multiple with comma)'
+        puts '  Ex: --slice=path or --slice=path,params'
+        puts
+
+        puts '--except'.pastel(:green)
+        puts '  Exclude specific fields (except multiple with comma)'
+        puts '  Ex: --except=params --except=params,path'
+        puts
+
+        puts '--exists'.pastel(:green)
+        puts '  Ensure field exists regardless of contents'
+        puts '  Ex: --exists=params --exists=params,path'
+        puts
+
+        puts '--stats'.pastel(:green)
+        puts '  Order/Count occurrances by field'
+        puts '  Ex: --stats=params --except=params,path'
+        puts
+
+        puts '--uniq'.pastel(:green)
+        puts '  Show unique values only'
+        puts '  Ex: --uniq=params --uniq=params,path'
+        puts
+
+        puts '--pluck'.pastel(:green)
+        puts '  Extract values from entries'
+        puts '  Ex: --pluck=params --pluck=params,path'
+        puts
+
+        puts '--archive'.pastel(:green)
+        puts '  Limit to specific archvie name (partial matching /inclusive). Matching SOS tar.gz name'
+        puts '  Ex: --archive=dev-gitlab_20210622154626, --archive=202106,202107'
+        puts
+
+        puts '--sort'.pastel(:green)
+        puts '  Sort by multiple fields'
+        puts '  Ex: --sort=duration_s,db_duration_s'
+        puts
+
+        puts '--reverse'.pastel(:green)
+        puts '  Reverse all results'
+        puts '  Ex: --reverse'
+        puts
+
+        puts '--combine'.pastel(:green)
+        puts '  Omit archive identifier dividers. Useful with sort or time filters'
+        puts '  Ex: --combine'
+        puts
+
+        puts '--case'.pastel(:green)
+        puts '  Exact case match. Defaults to case insensitive'
+        puts '  Ex: --case; --name=Jon, --name=jane --case'
+        puts
+
+        puts '--exact'.pastel(:green)
+        puts '  Exact parameter/value match. Defaults to partial match'
+        puts '  Ex: --field=CommonPartial --exact'
+        puts
+
+        puts '--start'.pastel(:green)
+        puts '  Show events after specified time. Filtered by the `time` field'
+        puts '  Use with `--end` for between selections'
+        puts '  Ex: log filter --start="2021-06-22 14:44 UTC" --end="2021-06-22 14:45 UTC"'
+        puts
+
+        puts '--end'.pastel(:green)
+        puts '  Show events before specified time. Filtered by the `time` field'
+        puts '  Use with `--start` for between selections'
+        puts '  Ex: log filter --end="2021-06-22"'
+        puts
+
+        puts '--truncate'.pastel(:green)
+        puts '  Truncate field length. On by default (4 rows). Performance issues!'
+        puts '  Disable with --truncate=0'.pastel(:bright_red)
+        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 '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'
+        puts '  log filter gitlab-rails/api_json.log --slice=ua --uniq=ua --ua=gitlab-runner'
+
+        puts
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+  end
+end