greenhat 0.3.3 → 0.4.0

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
@@ -47,6 +48,7 @@ module GreenHat
         puts '  filter'.pastel(:green)
         puts "    Primary way for log searching within greenhat. See #{'filter_help'.pastel(:blue)}"
         puts '    Time, round, slice/except, and/or, stats, uniq, sort'
+        puts "    #{'filter_help'.pastel(:blue)} supports filtering Ex: #{'filter_help stats'.pastel(:blue)}"
         puts
 
         puts '  show'.pastel(:green)
@@ -57,13 +59,33 @@ 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"
       end
 
-      def self.filter_help
-        ShellHelper::Filter.help
+      def self.filter_help(args = {})
+        if args.empty?
+          ShellHelper::Filter.help
+        else
+          list = ShellHelper::Filter.help_index.select do |k, _v|
+            k.to_s.include? args.first
+          end
+
+          puts list.values.map { |x| x.join("\n") }.join("\n\n")
+        end
       end
 
       def self.ls(args = [])
@@ -80,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)
       # ========================================================================
@@ -94,6 +205,8 @@ module GreenHat
           return true
         end
 
+        ShellHelper::Log.last = raw
+
         # Argument Parsing
         files, flags, args = Args.parse(raw)
 
@@ -104,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
 
@@ -117,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
@@ -152,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)
       # ========================================================================
@@ -169,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)
@@ -240,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
@@ -251,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

@@ -0,0 +1,352 @@
+module GreenHat
+  # Root Level Shell / Report Helper
+  module Shell
+    def self.markdown_report(raw)
+      _files, flags, _args = Args.parse(raw)
+
+      archives = if flags.archive
+                   Archive.all.select do |archive|
+                     flags.archive.any? { |x| archive.name.include? x.to_s }
+                   end
+                 else
+                   Archive.all
+                 end
+
+      ShellHelper.show(archives.map(&:report_markdown).map(&:show).flatten, flags)
+    end
+  end
+end
+
+module GreenHat
+  # Report Generator Helper
+  # rubocop:disable Metrics/ClassLength
+  class ReportMarkdown
+    include ActionView::Helpers::NumberHelper
+
+    attr_accessor :archive, :host, :os_release, :selinux_status, :cpu, :uname,
+                  :timedatectl, :uptime, :meminfo, :gitlab_manifest, :gitlab_status,
+                  :production_log, :api_log, :application_log, :sidekiq_log,
+                  :exceptions_log, :gitaly_log, :free_m, :disk_free
+
+    # Find Needed Files for Report
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def initialize(archive)
+      self.archive = archive
+      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' }
+      self.cpu = archive.things.find { |x| x.name == 'lscpu' }
+      self.uname = archive.things.find { |x| x.name == 'uname' }
+      self.timedatectl = archive.things.find { |x| x.name == 'timedatectl' }
+      self.uptime = archive.things.find { |x| x.name == 'uptime' }
+      self.meminfo = archive.things.find { |x| x.name == 'meminfo' }
+      self.free_m = archive.things.find { |x| x.name == 'free_m' }
+      self.gitlab_manifest = archive.things.find { |x| x.name == 'gitlab/version-manifest.json' }
+      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' }
+      self.disk_free = archive.things.find { |x| x.name == 'df_h' }
+    end
+
+    def show
+      output = [
+        archive.friendly_name,
+        ''
+      ]
+
+      # GitLab Version
+      output << "**GitLab #{gitlab_version}**\n" if gitlab_manifest || gitlab_status
+
+      # OS
+      output << "**OS**\n"
+
+      output << collect_host
+      output << ''
+
+      # Memory
+      if meminfo || free_m
+        output << "**Memory**\n"
+        # output << memory_perc if meminfo
+        output << memory_free if free_m
+        output << ''
+      end
+
+      # Disk
+      if disk_free
+        output << disks
+        output << ''
+      end
+
+      # Gitlab
+      output << gitlab_services if gitlab_status
+
+      output << ''
+
+      output << "**Errors**\n" if production_log || api_log || application_log || sidekiq_log
+      output << collect_errors
+
+      # Final Space / Return
+      output << ''
+      output
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    def collect_host
+      output = []
+      output << hostname if host
+      output << distro if os_release
+      output << selinux if selinux_status
+      # output << arch if cpu
+      output << kernel if uname
+      output << sys_time if timedatectl
+      output << sys_uptime if uptime
+      output << load_average if uptime && cpu
+
+      groups = output.each_slice((output.size / 2.to_f).round).to_a
+
+      table = TTY::Table.new do |t|
+        loop do
+          break if groups.all?(&:empty?)
+
+          t << groups.map(&:shift)
+        end
+      end
+
+      "```\n#{table.render(:basic, padding: [0, 2, 0, 0])}\n```"
+    end
+
+    def collect_errors
+      output = []
+      output << production_errors if production_log
+      output << application_errors if application_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
+
+      # Keep Alphabetical Sort / Allow for only one
+      slice_size = (output.size / 3.to_f).round
+      slice_size = 1 unless slice_size.positive?
+
+      groups = output.each_slice(slice_size).to_a
+
+      table = TTY::Table.new do |t|
+        loop do
+          break if groups.all?(&:empty?)
+
+          t << groups.map(&:shift)
+        end
+      end
+
+      "```\n#{table.render(:basic, padding: [0, 2, 0, 0])}\n```"
+    end
+
+    def exception_errors
+      count = exceptions_log.data.count
+
+      "Exception: #{count}"
+    end
+
+    def gitaly_errors
+      count = gitaly_log.data.count { |x| x.level == 'error' }
+
+      "Gitaly: #{count}"
+    end
+
+    def production_errors
+      count = production_log.data.count { |x| x.status == 500 }
+
+      "Production: #{count}"
+    end
+
+    def api_errors
+      count = api_log.data.count { |x| x.status == 500 }
+
+      "API: #{count}"
+    end
+
+    def application_errors
+      results = ShellHelper.filter_internal([
+        'gitlab-rails/application_json.log',
+        '--message!="Cannot obtain an exclusive lease"',
+        '--severity=error',
+        "--archive=#{archive.name}"
+      ].join(' '))
+
+      "Application: #{results.count}"
+    end
+
+    def sidekiq_errors
+      count = sidekiq_log.data.count { |x| x&.severity == 'ERROR' }
+
+      "Sidekiq: #{count}"
+    end
+
+    def gitlab_services
+      [
+        "**Services**\n",
+        "\n",
+        GreenHat::GitLab.services_markdown(archive)
+      ].join
+    rescue StandardError => e
+      LogBot.fatal('GitLab Services', message: e.message, backtrace: e.backtrace.first)
+    end
+
+    def gitlab_version
+      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
+      "Hostname: #{host.data.first}"
+    end
+
+    def distro
+      [
+        "Distro: [#{os_release.data.ID}] ",
+        os_release.data.PRETTY_NAME
+      ].join
+    end
+
+    def selinux
+      status = selinux_status.data['SELinux status']
+
+      [
+        'SeLinux: ',
+        status,
+        ' (',
+        selinux_status.data['Current mode'],
+        ')'
+      ].join
+    end
+
+    def arch
+      [
+        'Arch: ',
+        cpu.data.Architecture
+      ].join
+    end
+
+    def kernel
+      # TODO: Better way to consistently get uname info?
+      value, build = uname.data.first.split[2].split('-')
+      [
+        'Kernel: ',
+        value,
+        " (#{build})"
+      ].join
+    end
+
+    # Helper for finding if NTP is enabled
+    def ntp_keys
+      [
+        'Network time on', 'NTP enabled', 'NTP service', 'System clock synchronized'
+      ]
+    end
+
+    def sys_time
+      # Ignore if Empty
+      return false if timedatectl.data.nil?
+
+      ntp_statuses = timedatectl.data.slice(*ntp_keys).values.compact
+
+      ntp_status = ntp_statuses.first
+
+      # Fall Back
+      ntp_status ||= 'unknown'
+
+      [
+        'Sys Time: ',
+        timedatectl.data['Local time'],
+        "(ntp: #{ntp_status})"
+      ].join
+    end
+
+    # Strip/Simplify Uptime
+    def sys_uptime
+      init = uptime.data.first.split(',  load average').first.strip
+
+      "Uptime: #{init.split('up ', 2).last}"
+    end
+
+    def load_average
+      cpu_count = cpu.data['CPU(s)'].to_i
+      intervals = uptime.data.first.split('load average: ', 2).last.split(', ').map(&:to_f)
+
+      # Generate Colorized Text for Output
+      intervals_text = intervals.map do |interval|
+        value = percent(interval, cpu_count)
+
+        "#{interval} (#{value}%)"
+      end
+
+      [
+        'LoadAvg: ',
+        "[CPU #{cpu_count}] ",
+        intervals_text.join(', ')
+      ].join
+    end
+
+    def memory_free
+      free = free_m.data.find { |x| x.kind == 'Mem' }
+
+      return unless free
+
+      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))}"
+      ]
+
+      # Keep Alphabetical Sort
+      groups = list.each_slice((list.size / 2.to_f).round).to_a
+
+      table = TTY::Table.new do |t|
+        loop do
+          break if groups.all?(&:empty?)
+
+          t << groups.map(&:shift)
+        end
+      end
+
+      "```\n#{table.render(:basic, padding: [0, 2, 0, 0])}\n```"
+    end
+
+    def disks
+      # GreenHat::Disk.df({archive: []})
+      file = GreenHat::Disk.df({ archive: [archive.name] })
+
+      disk_list = GreenHat::Disk.markdown_format(file.first, false, 3)
+
+      # Preapre / Indent List
+      [
+        '**Disks**',
+        "\n\n```\n#{disk_list.join("\n")}\n```"
+      ].join
+    end
+
+    # ----------------------------
+    # Helpers
+    # ----------------------------
+    def percent(value, total)
+      ((value / total.to_f) * 100).round
+    end
+
+    # Helper to Make Cyan Titles
+    def title(name, ljust = 16)
+      "#{name}:".ljust(ljust)
+    end
+  end
+  # rubocop:enable Metrics/ClassLength
+end

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