greenhat 0.3.5 → 0.3.6

data/lib/greenhat/shell/log.rb

@@ -2,6 +2,7 @@ module GreenHat
   # CLI Helper
   module Shell
     # Logs
+    # rubocop:disable Metrics/ModuleLength
     module Log
       def self.auto_complete(list, word)
         # Argument Parsing
@@ -58,6 +59,18 @@ module GreenHat
         puts "    General full text by file searching. See #{'search_help'.pastel(:blue)}"
         puts
 
+        puts '  save'.pastel(:green)
+        puts '    Save the last query result into a new searchable object'
+        puts
+
+        puts '  write'.pastel(:green)
+        puts '    Write the last query result into a local file'
+        puts
+
+        puts '  visualize'.pastel(:green)
+        puts '    Load web services and formulate last query for the UI'
+        puts
+
         puts ShellHelper::List.help
 
         puts "See #{'examples'.pastel(:bright_blue)} for query examples"
@@ -89,6 +102,95 @@ module GreenHat
         ShellHelper.show files.map(&:data).flatten
       end
 
+      def self.save(raw = [])
+        if ShellHelper::Log.last.nil?
+          puts 'No previous query found'.pastel(:red)
+          puts 'Run a query first then save to store as a new log'
+          puts
+          puts "Try #{'nginx/gitlab_access.log --status!=200'.pastel(:green)} then #{'save'.pastel(:green)}"
+          true
+        end
+
+        name = if raw.empty?
+                 Cli.prompt.ask('Log/name to save the results to? '.pastel(:yellow))
+               else
+                 raw.first
+               end
+
+        if name.blank?
+          puts 'Name required'.pastel(:red)
+          return true
+        end
+
+        results = ShellHelper.filter_internal ShellHelper::Log.last
+
+        # Don't save empty results
+        if results.empty?
+          puts 'No results'.pastel(:red)
+          ShellHelper::Log.no_files_warning(files) if ShellHelper.find_things(files, flags).count.zero?
+          return false
+        end
+
+        Thing.new.query_save(results, name)
+        puts "#{name.pastel(:green)} Saved!"
+      end
+
+      def self.write(raw = [])
+        if ShellHelper::Log.last.nil?
+          puts 'No previous query found'.pastel(:red)
+          puts 'Run a query first then write'
+          puts
+          puts "Try #{'nginx/gitlab_access.log --status!=200'.pastel(:green)} then #{'save'.pastel(:green)}"
+          true
+        end
+
+        name = if raw.empty?
+                 Cli.prompt.ask('Log/name to save the results to? '.pastel(:yellow))
+               else
+                 raw.first
+               end
+
+        if name.blank?
+          puts 'Name required'.pastel(:red)
+          return true
+        end
+
+        results = ShellHelper.filter_internal ShellHelper::Log.last
+
+        # Don't save empty results
+        if results.empty?
+          puts 'No results'.pastel(:red)
+          ShellHelper::Log.no_files_warning(files) if ShellHelper.find_things(files, flags).count.zero?
+          return false
+        end
+
+        all = results.map { |row| Oj.dump(row) }
+        File.write(name, all.join("\n"))
+        puts "#{name.pastel(:green)} File Written!"
+      end
+
+      def self.visualize
+        if ShellHelper::Log.last.nil?
+          puts 'No previous query found'.pastel(:red)
+          puts 'Run a query first then visualize to load it in the chart web page'
+          puts
+          puts "Try #{'nginx/gitlab_access.log --status!=200'.pastel(:green)} then #{'visualize'.pastel(:green)}"
+          return true
+        end
+
+        # Load Required Files
+        require 'greenhat/web'
+
+        unless GreenHat::Web.alive?
+          GreenHat::Web.start
+          sleep 0.2
+        end
+
+        url = "http://localhost:4567/chart/time?query=#{CGI.escape(ShellHelper::Log.last)}"
+
+        GreenHat::Platform.open url
+      end
+
       # ========================================================================
       # Filter (See Filter Help)
       # ========================================================================
@@ -103,6 +205,8 @@ module GreenHat
           return true
         end
 
+        ShellHelper::Log.last = raw
+
         # Argument Parsing
         files, flags, args = Args.parse(raw)
 
@@ -113,7 +217,7 @@ module GreenHat
 
         # Skip and Print Total if set
         if flags[:total]
-          ShellHelper.total_count(results)
+          ShellHelper.total_count(results, flags)
           return true
         end
 
@@ -126,13 +230,13 @@ module GreenHat
         # Check Search Results
         if results.instance_of?(Hash) && results.values.flatten.empty?
           puts 'No results'.pastel(:red)
+          ShellHelper::Log.no_files_warning(files) if ShellHelper.find_things(files, flags).count.zero?
+        elsif flags[:pipe]
+          Pipe.show(results, flags[:pipe])
         else
           # This causes the key 'colorized' output to also be included
           ShellHelper.show(results.to_a.compact.flatten, flags)
         end
-
-        # log filter --path='cloud/gitlab-automation' --path='/pull' --all
-        # log filter --project=thingy --other_filter=asdf *
       rescue StandardError => e
         LogBot.fatal('Filter', message: e.message)
         ap e.backtrace
@@ -161,9 +265,25 @@ module GreenHat
         puts 'Count/% occurences for both user and remote ip fields'.pastel(:bright_green)
         puts 'gitlab-rails/api_json.log --stats=meta.user,meta.remote_ip --exists=meta.user'
         puts
-      end
 
+        puts 'Sidekiq jobs that took over 5 seconds excluding LdapSyncWorker jobs'.pastel(:bright_green)
+        puts 'sidekiq/current --duration_s>=5 --class!=LdapSyncWorker'
+        puts
+
+        puts 'Search access logs for runner requests, exclude specific runner version'.pastel(:bright_green)
+        puts 'nginx/gitlab_access.log --http_user_agent=gitlab-runner  --http_user_agent!=13.12.0'
+        puts
+
+        puts 'Get a list of unique Gitaly error messages for a specific project'.pastel(:bright_green)
+        puts 'filter --level=error --grpc.request.glProjectPath=path/to/project  gitaly/current --slice=error --uniq=error'
+        puts
+
+        puts 'Show workhorse duration/URI. Filter by duration bounds'.pastel(:bright_green)
+        puts 'gitlab-workhorse/current --duration_ms>=30000 --duration_ms<=45000 --slice=duration_ms,uri'
+        puts
+      end
       # rubocop:enable Layout/LineLength
+
       # ========================================================================
       # Search (Full Text / String Search)
       # ========================================================================
@@ -178,13 +298,15 @@ module GreenHat
 
         # Skip and Print Total if set
         if flags[:total]
-          ShellHelper.total_count(results)
+          ShellHelper.total_count(results, flags)
           return true
         end
 
         # Check Search Results
         if results.values.flatten.empty?
           puts 'No results'.pastel(:red)
+          ShellHelper::Log.no_files_warning(files) if ShellHelper.find_things(files, flags).count.zero?
+
         else
           # This causes the key 'colorized' output to also be included
           ShellHelper.show(results.to_a.compact.flatten, flags)
@@ -249,7 +371,7 @@ module GreenHat
         puts 'log search --text=BuildHooksWorker --text!=start --slice=enqueued_at sidekiq/current'
         puts
       end
-      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength,Metrics/ModuleLength
 
       # ------------------------------------------------------------------------
     end
@@ -260,9 +382,22 @@ module GreenHat
   module ShellHelper
     # Log Helpers
     module Log
+      def self.last=(value)
+        @last = value.join(' ')
+      end
+
+      def self.last
+        @last
+      end
+
       def self.list
         Thing.all.select(&:log)
       end
+
+      def self.no_files_warning(files)
+        puts "No matching files found for pattern #{files.to_s.pastel(:yellow)}"
+        puts "See #{'ls'.pastel(:blue)} for available files"
+      end
     end
     # --------
   end

data/lib/greenhat/shell/markdown.rb

@@ -58,6 +58,9 @@ module GreenHat
         ''
       ]
 
+      # GitLab Version
+      output << "**GitLab #{gitlab_version}**\n" if gitlab_manifest || gitlab_status
+
       # OS
       output << "**OS**\n"
 
@@ -79,8 +82,6 @@ module GreenHat
       end
 
       # Gitlab
-      output << "**GitLab**\n" if gitlab_manifest || gitlab_status
-      output << gitlab_version if gitlab_manifest
       output << gitlab_services if gitlab_status
 
       output << ''
@@ -172,7 +173,8 @@ module GreenHat
       results = ShellHelper.filter_internal([
         'gitlab-rails/application_json.log',
         '--message!="Cannot obtain an exclusive lease"',
-        '--severity=error'
+        '--severity=error',
+        "--archive=#{archive.name}"
       ].join(' '))
 
       "Application: #{results.count}"
@@ -195,7 +197,13 @@ module GreenHat
     end
 
     def gitlab_version
-      "Version: #{gitlab_manifest.data.build_version}\n"
+      txt = gitlab_manifest.data.dig(:software, :'gitlab-rails', :display_version) || gitlab_manifest.data.build_version
+
+      if txt.include? '-ce'
+        txt += ' - [😱 CE](https://about.gitlab.com/support/statement-of-support.html#free-and-community-edition-users)!'
+      end
+
+      "Version: #{txt}"
     end
 
     def hostname
@@ -295,10 +303,10 @@ module GreenHat
 
       pad = 6
       list = [
-        "#{title('Total', pad)} #{number_to_human_size(free.total.to_i * 1024**2)}",
-        "#{title('Used', pad)} #{number_to_human_size(free.used.to_i * 1024**2)}",
-        "#{title('Free', pad)} #{number_to_human_size(free.free.to_i * 1024**2)}",
-        "#{title('Avail', pad)} #{number_to_human_size(free.available.to_i * 1024**2)}"
+        "#{title('Total', pad)} #{number_to_human_size(free.total.to_i * (1024**2))}",
+        "#{title('Used', pad)} #{number_to_human_size(free.used.to_i * (1024**2))}",
+        "#{title('Free', pad)} #{number_to_human_size(free.free.to_i * (1024**2))}",
+        "#{title('Avail', pad)} #{number_to_human_size(free.available.to_i * (1024**2))}"
       ]
 
       # Keep Alphabetical Sort

data/lib/greenhat/shell/old_search_helper.rb

@@ -0,0 +1,54 @@
+module GreenHat
+  # Deprecating search stuff
+  module ShellHelper
+    # Main Entry Point for Searching
+    # def self.search_start(log_list, filter_type, args, opts)
+    def self.search_start(files, flags, args)
+      # Convert to Things
+      logs = ShellHelper.find_things(files, flags)
+
+      logs.each_with_object({}) do |log, obj|
+        # Ignore Empty Results / No Thing
+        next if log&.data.blank?
+
+        obj[log.friendly_name] = ShellHelper.search(log.data, flags, args)
+
+        obj
+      end
+    end
+
+    # Generic Search Helper / String/Regex
+    def self.search(data, flags = {}, args = {})
+      results = data.clone.flatten.compact
+      results.select! do |row|
+        args.send(flags.logic) do |arg|
+          search_row(row, arg, flags)
+        end
+      end
+
+      # Strip Results if Slice is defined
+      results.map! { |row| row.slice(*flags[:slice]) } if flags[:slice]
+
+      # Strip Results if Except is defined
+      results.map! { |row| row.except(*flags[:except]) } if flags[:except]
+
+      # Remove Blank from either slice or except
+      results.reject!(&:empty?)
+
+      results
+    end
+
+    # Break out filter row logic into separate method
+    def self.search_row(row, arg, flags)
+      # Sensitivity Check / Check for Match
+      included = filter_row_entry(row.to_s, arg, flags)
+
+      # Pivot of off include vs exclude
+      if arg.bang
+        !included
+      else
+        included
+      end
+    end
+  end
+end

data/lib/greenhat/shell/page.rb

@@ -8,7 +8,7 @@ module GreenHat
         # Pass if Explicitly Set / Inverse for skip
         return !flags[:page] if flags.key? :page
 
-        LogBot.debug('Page', count_rows(data, flags)) if ENV['DEBUG']
+        LogBot.debug('Page Skip', count_rows(data, flags)) if ENV['DEBUG']
 
         count_rows(data, flags)
       end

data/lib/greenhat/shell/pipe.rb

@@ -0,0 +1,31 @@
+module GreenHat
+  # Helper for piping arguments
+  module Pipe
+    def self.show(results, arg)
+      uuid = SecureRandom.uuid # File Placeholder
+      write(results, uuid)
+      command(uuid, arg)
+      delete(uuid)
+    end
+
+    # Final execution into pipe
+    def self.command(uuid, arg)
+      puts `cat "#{file(uuid)}" | #{arg}`
+    end
+
+    # File path helper
+    def self.file(uuid)
+      "#{$TMP}/#{uuid}.txt"
+    end
+
+    # Helper to write all into split lines for pipe
+    def self.write(results, uuid)
+      File.write(file(uuid), results.map(&:flatten).flatten.join("\n"))
+    end
+
+    # Clean up created file
+    def self.delete(uuid)
+      File.delete file(uuid)
+    end
+  end
+end

data/lib/greenhat/shell/platform.rb

@@ -0,0 +1,28 @@
+module GreenHat
+  # Common Helpers
+  module Platform
+    def self.platform
+      if @platform
+        @platform
+      else
+        require 'tty-platform'
+        @platform ||= TTY::Platform.new
+
+      end
+    end
+
+    def self.open(url = 'http://localhost:4567/chart/time')
+      cmd = if platform.linux? || platform.unix?
+              'xdg-open'
+            elsif platform.mac?
+              'open'
+            end
+
+      # platform.windows?  # => false
+      # platform.unix?     # => true
+      # platform.linux?    # => false
+      # platform.mac?      # => true
+      system("#{cmd} '#{url}'")
+    end
+  end
+end

data/lib/greenhat/shell/report.rb

@@ -12,7 +12,11 @@ module GreenHat
                    Archive.all
                  end
 
-      ShellHelper.show(archives.map(&:report).map(&:show).flatten, flags)
+      output = archives.map { |x| x.report(flags) }.map(&:show).flatten
+
+      flags[:page] = true if flags.full && !flags.raw
+
+      ShellHelper.show(output, flags)
     end
   end
 end
@@ -23,15 +27,16 @@ module GreenHat
   class Report
     include ActionView::Helpers::NumberHelper
 
-    attr_accessor :archive, :host, :os_release, :selinux_status, :cpu, :uname,
+    attr_accessor :archive, :flags, :host, :os_release, :selinux_status, :cpu, :uname,
                   :timedatectl, :uptime, :meminfo, :gitlab_manifest, :gitlab_status,
-                  :production_log, :api_log, :application_log, :sidekiq_log,
+                  :production_log, :api_log, :sidekiq_log,
                   :exceptions_log, :gitaly_log, :free_m, :disk_free
 
     # Find Needed Files for Report
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
-    def initialize(archive)
+    def initialize(archive, flags)
       self.archive = archive
+      self.flags = flags
       self.host = archive.things.find { |x| x.name == 'hostname' }
       self.os_release = archive.things.find { |x| x.name == 'etc/os-release' }
       self.selinux_status = archive.things.find { |x| x.name == 'sestatus' }
@@ -45,7 +50,6 @@ module GreenHat
       self.gitlab_status = archive.things.find { |x| x.name == 'gitlab_status' }
       self.production_log = archive.things.find { |x| x.name == 'gitlab-rails/production_json.log' }
       self.api_log = archive.things.find { |x| x.name == 'gitlab-rails/api_json.log' }
-      self.application_log = archive.things.find { |x| x.name == 'gitlab-rails/application_json.log' }
       self.exceptions_log = archive.things.find { |x| x.name == 'gitlab-rails/exceptions_json.log' }
       self.gitaly_log = archive.things.find { |x| x.name == 'gitaly/current' }
       self.sidekiq_log = archive.things.find { |x| x.name == 'sidekiq/current' }
@@ -87,13 +91,16 @@ module GreenHat
       output << 'GitLab'.pastel(:bright_yellow) if gitlab_manifest
       output << gitlab_version if gitlab_manifest
       output << gitlab_services if gitlab_status
-      output << title('Errors') if production_log || api_log || application_log || sidekiq_log
+      output << title('Errors') if production_log || api_log || sidekiq_log
       output << production_errors if production_log
-      output << application_errors if application_log
+      output << application_errors if archive.thing?('gitlab-rails/application_json.log')
       output << sidekiq_errors if sidekiq_log
       output << api_errors if api_log
       output << exception_errors if exceptions_log
       output << gitaly_errors if gitaly_log
+      output << workhorse_errors if archive.thing?('gitlab-workhorse/current')
+
+      full(output) if flags.full
 
       # Final Space / Return
       output << ''
@@ -101,6 +108,17 @@ module GreenHat
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
 
+    def full(output)
+      output << ''
+      output << 'FastStats Top'
+      Shell::Faststats.top(['--raw'], true).each { |x| output << x } # Page Row Helper
+      output << ''
+
+      output << 'FastStats Errors'
+      Shell::Faststats.errors(['--raw'], true).each { |x| output << x } # Page Row Helper
+      output << ''
+    end
+
     def exception_errors
       count = exceptions_log.data.count
       color = count.zero? ? :green : :red
@@ -111,6 +129,21 @@ module GreenHat
       ].join
     end
 
+    def workhorse_errors
+      results = ShellHelper.filter_internal([
+        'gitlab-workhorse/current',
+        '--level=error',
+        "--archive=#{archive.name}"
+      ].join(' '))
+
+      color = results.count.zero? ? :green : :red
+
+      [
+        title('  Workhorse', :bright_red, 18),
+        results.count.to_s.pastel(color)
+      ].join
+    end
+
     def gitaly_errors
       count = gitaly_log.data.count { |x| x.level == 'error' }
       color = count.zero? ? :green : :red
@@ -145,7 +178,8 @@ module GreenHat
       results = ShellHelper.filter_internal([
         'gitlab-rails/application_json.log',
         '--message!="Cannot obtain an exclusive lease"',
-        '--severity=error'
+        '--severity=error',
+        "--archive=#{archive.name}"
       ].join(' '))
 
       count = results.count { |x| x&.severity == 'ERROR' }
@@ -300,13 +334,12 @@ module GreenHat
         title('Usage'),
         '  ['.pastel(:bright_black),
         '='.pastel(:green) * (used / 2),
-        ' ' * (50 - used / 2),
+        ' ' * (50 - (used / 2)),
         ']'.pastel(:bright_black),
         " #{100 - percent(free, total)}%".pastel(:green) # Inverse
       ].join
     end
 
-    # rubocop:disable Metrics/MethodLength
     def memory_free
       free = free_m.data.find { |x| x.kind == 'Mem' }
 
@@ -317,25 +350,25 @@ module GreenHat
       output = []
       unless free.total.blank?
         output << title('Total', :cyan, 14)
-        output << number_to_human_size(free.total.to_i * 1024**2)
+        output << number_to_human_size(free.total.to_i * (1024**2))
         output << "\n"
       end
 
       unless free.total.blank?
         output << title('Used', :yellow, 14)
-        output << number_to_human_size(free.used.to_i * 1024**2)
+        output << number_to_human_size(free.used.to_i * (1024**2))
         output << "\n"
       end
 
       unless free.total.blank?
         output << title('Free', :blue, 14)
-        output << number_to_human_size(free.free.to_i * 1024**2)
+        output << number_to_human_size(free.free.to_i * (1024**2))
         output << "\n"
       end
 
       unless free.total.blank?
         output << title('Available', :green, 14)
-        output << number_to_human_size(free.available.to_i * 1024**2)
+        output << number_to_human_size(free.available.to_i * (1024**2))
         output << "\n"
       end
 
@@ -346,7 +379,6 @@ module GreenHat
     rescue StandardError => e
       LogBot.fatal('Memory', message: e.message, backtrace: e.backtrace.first)
     end
-    # rubocop:enable Metrics/MethodLength
 
     def disks
       # GreenHat::Disk.df({archive: []})