greenhat 0.3.2 → 0.3.6

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

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,14 +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, :free_m, :disk_free
+                  :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' }
@@ -44,7 +50,8 @@ 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' }
       self.disk_free = archive.things.find { |x| x.name == 'df_h' }
     end
@@ -84,11 +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 << api_errors if api_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 << ''
@@ -96,6 +108,52 @@ 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
+
+      [
+        title('  Exception', :bright_red, 18),
+        count.to_s.pastel(color)
+      ].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
+
+      [
+        title('  Gitaly', :bright_red, 18),
+        count.to_s.pastel(color)
+      ].join
+    end
+
     def production_errors
       count = production_log.data.count { |x| x.status == 500 }
       color = count.zero? ? :green : :red
@@ -117,7 +175,14 @@ module GreenHat
     end
 
     def application_errors
-      count = application_log.data.count { |x| x&.severity == 'ERROR' }
+      results = ShellHelper.filter_internal([
+        'gitlab-rails/application_json.log',
+        '--message!="Cannot obtain an exclusive lease"',
+        '--severity=error',
+        "--archive=#{archive.name}"
+      ].join(' '))
+
+      count = results.count { |x| x&.severity == 'ERROR' }
       color = count.zero? ? :green : :red
 
       [
@@ -269,7 +334,7 @@ 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
@@ -282,21 +347,37 @@ module GreenHat
 
       formatted_mem = free_m.data.map { |x| GreenHat::Memory.memory_row x }
 
-      [
-        title('Total', :cyan, 14),
-        number_to_human_size(free.total.to_i * 1024**2),
-        "\n",
-        title('Used', :yellow, 14),
-        number_to_human_size(free.used.to_i * 1024**2),
-        "\n",
-        title('Free', :blue, 14),
-        number_to_human_size(free.free.to_i * 1024**2),
-        "\n",
-        title('Available', :green, 14),
-        number_to_human_size(free.available.to_i * 1024**2),
-        "\n\n",
-        formatted_mem.map { |x| x.prepend ' ' * 2 }.join("\n")
-      ].join
+      output = []
+      unless free.total.blank?
+        output << title('Total', :cyan, 14)
+        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 << "\n"
+      end
+
+      unless free.total.blank?
+        output << title('Free', :blue, 14)
+        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 << "\n"
+      end
+
+      output << "\n"
+      output << formatted_mem.map { |x| x.prepend ' ' * 2 }.join("\n")
+
+      output.join
+    rescue StandardError => e
+      LogBot.fatal('Memory', message: e.message, backtrace: e.backtrace.first)
     end
 
     def disks