greenhat 0.3.4 → 0.5.0

data/lib/greenhat/shell/filter_help.rb

@@ -2,169 +2,205 @@ module GreenHat
   # CLI Helper
   module ShellHelper
     # Unify Filter / Filter Help
-    # rubocop:disable Metrics/MethodLength,Metrics/ModuleLength
+    # rubocop:disable Metrics/MethodLength,Layout/LineLength
     module Filter
-      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 '  Disable formatting and page/less'
-        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 '--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'
-        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. Combine with `truncate` for key names'
-        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 '--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)
-        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
+      def self.help(args = '')
+        if args.blank?
+          help_index.values.map { |x| x.push '' }
+        else
+          list = help_index.select do |k, _v|
+            k.to_s.include? args
+          end
+
+          list.values
+        end
+
+        # .map { |x| x.join("\n") }.join("\n\n")
       end
 
+      # TODO: Confirm Remove
+      # def self.legacy
+      #   puts "\u2500".pastel(:cyan) * 20
+      #   puts 'Filter'.pastel(:yellow)
+      #   puts "\u2500".pastel(:cyan) * 20
+
+      #   puts 'Options'.pastel(:blue)
+      #   puts '--raw'.pastel(:green)
+      #   puts '  Disable formatting and page/less'
+      #   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 '  Show total count, duration, start/end time for 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'
+      #   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. Combine with `truncate` for key names'
+      #   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 '--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)
+      #   puts '  Ex: --truncate=200, --truncate=2048"'
+      #   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'
+      #   puts '  log filter gitlab-rails/api_json.log --slice=ua --uniq=ua --ua=gitlab-runner'
+
+      #   puts
+      # end
+
       def self.help_index
         {
           title: [
             "\u2500".pastel(:cyan) * 20,
             'Filter'.pastel(:yellow),
-            "\u2500".pastel(:cyan) * 20
-          ],
-          options: [
+            "\u2500".pastel(:cyan) * 20,
+            '',
             'Options'.pastel(:blue)
           ],
 
@@ -202,7 +238,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: [
@@ -335,11 +371,30 @@ module GreenHat
             '  Ex: --truncate=200, --truncate=2048"'
           ],
 
-          field: [
-            'Field Searching'.pastel(:blue),
-            '  --[key]=[value]',
-            '  Search in key for value',
-            '  Example: --path=mirror/pull'
+          field_search: [
+            'General (Field) Searching'.pastel(:blue),
+            "  There are different ways filter within specific keys/fields within log. The baseline is #{'--[key]=[value]'.pastel(:green)}",
+            '  This will, by default, select any entries with any partial match (case insensitive) of [value] in the entry [key]',
+            '  Example: --path=mirror/pull',
+            '',
+            "  You can modify logic with params like: #{'case'.pastel(:green)}, #{'exact'.pastel(:green)}",
+            '  Ex Case turn on case sensitivity, exact will change from the inclusive to only exact matching.',
+            '',
+            "  You can also use multiple #{'--[key]=[value]'.pastel(:green)} to narrow down, or combine it with #{'or'.pastel(:green)} to be more inclusive",
+            '  Ex nginx/gitlab_access.log --http_user_agent=gitlab-runner --path=/api/v4/jobs/request',
+            '  This will look through the access logs for anything that is a runner (user agent) and hitting the request endpoint',
+            '',
+            " You can also modify whether a field search excluded or a integer (and technically string) comparison by changing the operator:  #{'(!= >= <=)'.pastel(:green)}",
+            ' 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',
+            ' Ex "sidekiq/current --duration_s>=5 --class!=LdapSyncWorker" Duration over 5 that is not an ldap job'
+          ],
+
+          pipe_to_shell: [
+            'Pipe to Shell'.pastel(:blue),
+            '  This is very experimental! The idea is to take all the output from the search and allow a pipe into a traditional shell command.',
+            '  Due to the arg parsing its not a straight send to the terminal. You may need to escape quotes.',
+            '  Order is relevant, no arguments after the pipe',
+            '  <files> <params> | grep path'
           ],
 
           ls: [
@@ -357,7 +412,7 @@ module GreenHat
 
         }
       end
-      # rubocop:enable Metrics/MethodLength,Metrics/ModuleLength
+      # rubocop:enable Metrics/MethodLength,Layout/LineLength
     end
   end
 end

data/lib/greenhat/shell/gitlab.rb

@@ -99,6 +99,7 @@ module GreenHat
         end
       end
     end
+
     # -----
   end
 end