greenhat 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbb51c051ab366c7bb7a172c4a917d7646bd5bdbc00c894217403655130bb2f3
-  data.tar.gz: b4e997388954091b257df23a1f67093490b8c1996635c860b3e462fa3f44213c
+  metadata.gz: c6b9e87957f5dfc919379519552041ce83b8daa5923b0e89fc64424e050d8981
+  data.tar.gz: 412b2c4db6613c707c8aad3e39e41a3fb018d1834f5ef17000b11b3af582c639
 SHA512:
-  metadata.gz: 965baad78deb383ed1c1cb569a219439daa4c73adf7fd8b3f2852ee1b9703e758e91b0784ac1c1ac999045dd8a0d871927680d2718829ebcc3740dcc4c334a00
-  data.tar.gz: 17111df14082319b62bca88224ccf4b0b433ac9bcda5d1fe9c922e08477632a6c0831f61dc8615f633f0d8c4b70c58d54fe765c63172c4f4573b6812fc61aee1
+  metadata.gz: da4b45b6433d2c4c786bca4b46dc0cfad9b879796e6040b9efceb5ba5181f329c7d3792aef458fde54698791f03830168aad17b9b7d31191aa2e717407444662
+  data.tar.gz: 3d53ed5c45398acc3a317cc41a5573b82ab1c263e947c94cc419f235efd5bc527905f4484867968535f12aed15c3fbb79abe1d63093402f845c572557b7e288d

data/README.md

@@ -14,20 +14,15 @@ Experimental SOS and Log Parser for GitLab
 
 ## Installation
 
-While potentially so in the future, this is currently not a published gem. To install:
-
 ```
-git clone https://gitlab.com/gitlab-com/support/toolbox/greenhat
-cd greenhat
-bundle install
-bundle exec rake install
+gem install greenhat
 ```
 
 ## Usage
 
 ```
 greenhat sos-archive.tar.gz
-greenhat production_log.json
+greenhat production_json.log
 # launches a console
 >> help # the program is self-documented through the builtin help command
 ```

data/lib/greenhat/shell/helper.rb

@@ -56,7 +56,9 @@ module GreenHat
     # --round=2
 
     def self.param_special_opts
-      %i[slice except stats uniq pluck round archive start end sort]
+      %i[
+        slice except stats uniq pluck round archive start end sort limit
+      ]
     end
 
     # Parameter Extraction
@@ -73,8 +75,9 @@ module GreenHat
     # Arg Defaults
     def self.param_arg_defaults(field)
       case field
-      when *param_special_opts then []
       when :round then 2
+      when :limit then [TTY::Screen.height / 2]
+      when *param_special_opts then []
       else
         true
       end
@@ -125,7 +128,7 @@ module GreenHat
       end
 
       # Check if content needs to paged, or if auto_height is off
-      if !args.page && (data.sum(&:size) < TTY::Screen.height)
+      if !args.page && count_rows(data)
         puts data.map { |x| entry_show(x, args) }.compact.join("\n")
         return true
       end
@@ -142,6 +145,25 @@ module GreenHat
       end
     end
 
+    # Array/Hash and String pagination check. Don't unncessarily loop through everything
+    def self.count_rows(data)
+      height = TTY::Screen.height
+      size = 0
+
+      data.each do |entry|
+        size += case entry
+                when Hash then entry.keys.count
+                when Array then entry.count
+                else
+                  1
+                end
+
+        break if size > height
+      end
+
+      height > size
+    end
+
     # Entry Shower
     def self.entry_show(entry, args)
       case entry
@@ -251,7 +273,12 @@ module GreenHat
       # Pluck
       results = filter_pluck(results, args[:pluck]) if args.key?(:pluck)
 
-      results
+      # Limit
+      if args[:limit]
+        results[0..args[:limit].map(&:to_s).join.to_i]
+      else
+        results
+      end
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 

data/lib/greenhat/shell/log.rb

@@ -229,7 +229,12 @@ module GreenHat
       # rubocop:disable Layout/LineLength
       # TODO: Add a lot more examples
       def self.filter_examples
-        puts 'log filter sidekiq/current --sort=db_duration_s --job_status=done --sort=duration_s,db_duration_s --slice=duration_s,db_duration_s --reverse'
+        puts 'Find `done` job for sidekiq, sort by duration, only duration, and show longest first'.colorize(:light_green)
+        puts 'log filter sidekiq/current --job_status=done --sort=duration_s,db_duration_s --slice=duration_s,db_duration_s --reverse'
+        puts
+        puts 'Find 500s only show exceptions'.colorize(:light_green)
+        puts 'log filter --status=500 --slice=exception.message gitlab-rails/production_json.log'
+        puts
       end
       # rubocop:enable Layout/LineLength
 
@@ -313,6 +318,11 @@ module GreenHat
         puts '  Ex: --archive=dev-gitlab_20210622154626, --archive=202106,202107'
         puts
 
+        puts '--limit'.colorize(:green)
+        puts '  Limit total number of results. Default to half total screen size'
+        puts '  Ex: --limit; --limit=10'
+        puts
+
         puts 'Search specific logs'.colorize(: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'.colorize(:yellow)}` for log names"

data/lib/greenhat/thing/file_types.rb

@@ -1,5 +1,19 @@
 module GreenHat
-  # Overall Type Parsing
+  # -------------------------------------
+  # File Types - Overall Type Parsing!
+  # -------------------------------------
+  # --- Adding a new File ----
+  # Duplicate one of the blocks and then update the name and pattern/regex to identify it
+  #
+  # The 'key' or 'name' is used to generically identify a type of file to be used in other collection tools.
+  #   - Looking for errors in `gitlab-workhorse/current` will also include any rotated files via `gitlab-workhorse/@.*`
+  #
+  # Formatters: See `thing/formmaters` for the different kinds of formatters
+  #   - `json` for plain json
+  #   - `raw` to ignore/just read (e.g. for cat)
+  #
+  # log true/false to be included in the log/filter fields
+
   # rubocop:disable Metrics/MethodLength, Metrics/ModuleLength
   module FileTypes
     def types
@@ -109,6 +123,13 @@ module GreenHat
             %r{gitaly/gitaly_ruby_json.log}
           ]
         },
+        'gitaly/gitaly_lfs_smudge.log' => {
+          format: :json,
+          log: true,
+          pattern: [
+            %r{gitaly/gitaly_lfs_smudge.log}
+          ]
+        },
         'gitlab_status' => {
           format: :gitlab_status,
           pattern: [

data/lib/greenhat/thing/kind.rb

@@ -67,7 +67,7 @@ module GreenHat
       end
 
       puts "Unable to determine file type for #{name.colorize(:yellow)}"
-      puts "Use '#{'json'.colorize(:cyan)}' and '#{'raw'.colorize(:cyan)}' if you cannot find any matches"
+      puts "Use '#{'json'.colorize(:cyan)}' or '#{'raw'.colorize(:cyan)}' if there are no matches (see file_types.rb)"
 
       option = prompt.select('Wat is this?', prompt_list.keys.sort_by(&:length), filter: true)
 

data/lib/greenhat/version.rb

@@ -1,3 +1,3 @@
 module GreenHat
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.1.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: greenhat
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Davin Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-06 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.14'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement