greenhat 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfa1c48eaba3ee835bbb027b9e7314fa8e64d17629d481c7c3aa73d7e00b83a4
-  data.tar.gz: '0175799c24f2d5c43fda1d50e103446a73ee12600dca511d4d52327128a66767'
+  metadata.gz: e7caec2b171d012ac284044e1064b665f42aeddf026a56267d4e8fe6ae44c394
+  data.tar.gz: 24ec9744a8d27b56a6576d1f49edf22d1365349f86f6470f5f3c53cfac53bafc
 SHA512:
-  metadata.gz: 95e6819b6e8f333c8537752d863ebc03fb3197e90be7ce92488bd68018c534be2d0db7593056cfa7c716ae43dae1ccf16d9f89ec84c72d4ef3b39fdb65734710
-  data.tar.gz: db52e83d2c456cd5d217310223ad62ea380e4e27f72ccc2819fa63b4e7734460b121153aaaa318743f3700f9e63eafbe71cda38caac94361cc659b88618edd20
+  metadata.gz: 978d6fc74f1adb0fbab249a41d26efc01d0e0b9c1c1cccf4e5ef143c0405db02ad285c3ed20c6bcfd36432a1d3ecfc31b93325990a333123ea4ec271be4f8e6e
+  data.tar.gz: 72e3417a4011b35c0c3a4a9552d0ccf4321334ca901e74b4c7ae33b21d649644739bb08845cea1a9c5621e96aa40e641ff8a566f3d18d735fd4461d083651927

data/README.md

@@ -12,6 +12,8 @@ Experimental SOS and Log Parser for GitLab
 
 `apt-get install libarchive-tools`
 
+Ruby 3.0 or later, including the headers (such as package `ruby-dev`)
+
 ## Installation
 
 ```
@@ -27,6 +29,8 @@ greenhat production_json.log
 >> help # the program is self-documented through the builtin help command
 ```
 
+[Watch an introductory tutorial](https://www.youtube.com/watch?v=xyVQiKFgeP4) (recorded March 5, 2024, with Green Hat v0.7.3) 
+
 ## Testing
 
 ```

data/lib/greenhat/archive.rb

@@ -50,23 +50,29 @@ module GreenHat
 
     # Handle Different Types of Archives
     def self.unpack(archive_path, path)
+      decompressed_successfully = false
+
       case File.extname archive_path
-      when '.tgz'
-        base_path = archive_path.gsub(File.basename(archive_path), '')
-        `bsdtar -xzf "#{archive_path}" -C #{base_path}`
-        FileUtils.rm(archive_path)
-      when '.tar'
+      when '.tgz', '.tar'
         base_path = archive_path.gsub(File.basename(archive_path), '')
         `bsdtar -xf "#{archive_path}" -C #{base_path}`
-        FileUtils.rm(archive_path)
+
+        decompressed_successfully = $CHILD_STATUS.success?
+        FileUtils.rm(archive_path) if decompressed_successfully
       when '.gz'
         `gzip -d "#{archive_path}"`
+
+        decompressed_successfully = $CHILD_STATUS.success?
       when '.zip'
         base_path = archive_path.gsub(File.basename(archive_path), '')
         `unzip -o -d "#{base_path}" #{archive_path}`
-        FileUtils.rm(archive_path)
+
+        decompressed_successfully = $CHILD_STATUS.success?
+        FileUtils.rm(archive_path) if decompressed_successfully
       when '.bz2'
         `bzip2 -d #{archive_path}`
+
+        decompressed_successfully = $CHILD_STATUS.success?
       when '.s'
         # Find Original Directory, Split Path, Rename to .gz
         base_path = archive_path.gsub(File.basename(archive_path), '')
@@ -74,6 +80,15 @@ module GreenHat
       else
         FileUtils.cp(archive_path, "#{path}/#{archive_path}")
       end
+
+      # if the archive is corrupt and doesn't uncompress properly, greenhat will keep looping on it endlessly,
+      #  trying to decompress it. let's rename it on failure so it stops trying, but the SE can still try and
+      #  extract it themselves.
+      return if decompressed_successfully
+
+      puts "#{'Decompress failed'.pastel(:red)}: #{archive_path.pastel(:green)}"
+      puts 'Renaming file so we can continue.'.pastel(:yellow)
+      FileUtils.mv(archive_path, "#{archive_path}.broken")
     end
 
     def self.archive?(file_name)

data/lib/greenhat/reports/reports/errors.rb

@@ -27,7 +27,8 @@ entries = [
   { header: 'Gitaly', base: 'gitaly/current --level=error --truncate=99', stats: 'error' },
   { header: 'Praefect', base: 'praefect/current --level=error --truncate=99', stats: 'error' },
   { header: 'Pages', base: 'gitlab-pages/current --level=error', stats: 'error' },
-  { header: 'Geo', base: 'gitlab-rails/geo.log --severity=error', stats: 'message' }
+  { header: 'Geo', base: 'gitlab-rails/geo.log --severity=error', stats: 'message' },
+  { header: 'Elasticsearch', base: 'gitlab-rails/elasticsearch.log --severity=error', stats: 'message' }
 ]
 
 # Filter Logic

data/lib/greenhat/reports/reports/full.rb

@@ -164,3 +164,8 @@ query_if_exists 'gitlab-rails/geo.log --severity=error' do |data|
   color = data.count.zero? ? :green : :red
   indent("#{ljust('Geo:', 14, :magenta)} #{data.count.to_s.pastel(color)}", 4)
 end
+
+query_if_exists 'gitlab-rails/elasticsearch.log --severity=error' do |data|
+  color = data.count.zero? ? :green : :red
+  indent("#{ljust('Elasticsearch:', 14, :magenta)} #{data.count.to_s.pastel(color)}", 4)
+end

data/lib/greenhat/reports/shell_helper.rb

@@ -5,7 +5,18 @@ module GreenHat
       # Make Running more consistent
       def self.run(file:, args:, flags:, raw_args:)
         report = GreenHat::Reports::Builder.new(file:, args:, flags:, raw_args:)
-        output = Archive.all.map do |archive|
+
+        # Fuzzy Match Archive Names
+        archives = Archive.all
+        if flags[:archive] && !flags[:archive].empty?
+          archives.select! do |a|
+            flags[:archive].any? do |x|
+              a.name.include? x.to_s
+            end
+          end
+        end
+
+        output = archives.map do |archive|
           runner = GreenHat::Reports::Runner.new(
             archive:,
             store: report.store.clone,

data/lib/greenhat/shell/field_helper.rb

@@ -21,7 +21,7 @@ module GreenHat
     def self.filter_flags(word)
       if word.blank?
         puts 'Filter Options:'.pastel(:bright_blue)
-        puts ShellHelper.field_table(filter_opts, 6)
+        puts ShellHelper.field_table(filter_opts)
         puts
 
         return []

data/lib/greenhat/shell/log.rb

@@ -218,7 +218,7 @@ module GreenHat
 
         # Skip and Print Total if set
         if flags[:fields]
-          ShellHelper.fields_print(results)
+          ShellHelper.fields_print(files)
           return true
         end
 

data/lib/greenhat/shell/query.rb

@@ -191,7 +191,7 @@ module GreenHat
       results = filter_except(results, flags[:except]) if flags.key?(:except)
 
       # Remove Blank from either slice or except
-      results.reject!(&:empty?)
+      results.reject!(&:blank?)
 
       # Sort / Reverse by default
       if flags.key?(:sort)

data/lib/greenhat/shell/shell_helper.rb

@@ -244,50 +244,31 @@ module GreenHat
       [output]
     end
 
-    # TODO: Clean up -- Verify these aren't needed
-    # Hash Iteration
-    # def self.total_count_hash(results, flags)
-    #   results.flat_map do |k, values|
-    #     [k, total_count_array(values, flags)]
-    #   end
-    # end
+    # Table Printer Helper
+    def self.fields_print(files)
+      fields = ShellHelper.find_things(files).map(&:fields).flatten.uniq
 
-    # List Calculation
-    # def self.total_count_array(results, flags)
-    #   # Option to only return the count
-    #   return results.count if flags[:total] == 'simple'
+      # truncate = (TTY::Screen.width - columns) / columns
+      # fields.map! { |f| f[0..truncate] }
+      puts ShellHelper.field_table(fields)
 
-    #   output = {}
-    #   output[:total] = results.count
-    #   output[:duration] = Query.calculate_duration(results)
+      # ShellHelper.fields_print(files)
+    end
 
-    #   # Sort / Get first and Last
-    #   list = results.select(&:time).map(&:time)
-    #   unless list.blank?
-    #     output[:start] = list.first
-    #     output[:end] = list.last
-    #   end
+    # 5 Columns cause issues with resizing
+    def self.field_table(list, columns: 4)
+      return nil if list.empty?
 
-    #   # Hide empty results
-    #   output.reject! { |_k, v| v.blank? }
+      # Split list into groups based on columns
+      groups = list.each_slice((list.size / columns.to_f).ceil).to_a
 
-    #   render_table(output, flags)
-    # end
+      # Max Width for Table
+      truncate = (TTY::Screen.width - groups.count) / groups.count
 
-    # Table Printer Helper
-    def self.fields_print(results)
-      results.each do |k, v|
-        puts k
-        puts field_table(v.map(&:keys).flatten.uniq.sort)
-        puts
+      # Process Truncation
+      groups.each do |group|
+        group.map! { |f| f[0..truncate]&.to_sym }
       end
-    end
-
-    def self.field_table(list, columns = 4)
-      return nil if list.empty?
-
-      # Keep Alphabetical Sort
-      groups = list.each_slice((list.size / columns.to_f).round).to_a
 
       table = TTY::Table.new do |t|
         loop do
@@ -297,7 +278,7 @@ module GreenHat
         end
       end
 
-      table.render(:unicode, padding: [0, 1, 0, 1])
+      table.render(:unicode, padding: [0, 1, 0, 1], resize: false)
     end
 
     # Unified Files Interface

data/lib/greenhat/thing/file_types.rb

@@ -968,6 +968,12 @@ module GreenHat
             /rpm_verify/
           ]
         },
+        'gitlab_system_status' => {
+          format: :raw,
+          pattern: [
+            /gitlab_system_status/
+          ]
+        },
         'gitlab-rails/application.log' => {
           format: :raw,
           pattern: [

data/lib/greenhat/thing/formatters/json.rb

@@ -14,6 +14,9 @@ module GreenHat
           { message: row }
         end
 
+        # Skip bad results
+        next if result.nil?
+
         # Parsing Time / Recusrive is really slow
         format_time(result)
 

data/lib/greenhat/version.rb

@@ -1,3 +1,3 @@
 module GreenHat
-  VERSION = '0.7.3'.freeze
+  VERSION = '0.8.0'.freeze
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: greenhat
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Davin Walker
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-14 00:00:00.000000000 Z
+date: 2025-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -66,20 +65,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: did_you_mean
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -531,7 +544,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -546,8 +558,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: GitLab SOS Tool
 test_files: []