greenhat 0.1.4

data/lib/greenhat/shell/log.rb

@@ -0,0 +1,344 @@
+module GreenHat
+  # CLI Helper
+  module Shell
+    # Logs
+    # rubocop:disable Metrics/ModuleLength
+    module Log
+      def self.help
+        puts "\u2500".colorize(:cyan) * 20
+        puts "#{'Logs'.colorize(:yellow)} find stuff"
+        puts "\u2500".colorize(:cyan) * 20
+
+        puts 'Command Summary'.colorize(:blue)
+        puts '  show'.colorize(:green)
+        puts '    Just print selected logs'
+        puts '  filter'.colorize(:green)
+        puts '    Key/Field Filtering'
+        puts '  search'.colorize(:green)
+        puts '    General text by entry searching'
+        puts '  ls'.colorize(:green)
+        puts '    List available files'
+        puts
+
+        filter_help
+
+        puts
+        search_help
+      end
+
+      # List Files Helpers
+      def self.list(args = [])
+        all = false
+        all = true if args.include?('-a') || args.include?('--all')
+
+        files = ShellHelper::Log.list
+
+        # Sort
+        files.sort_by!(&:name)
+
+        # Short & Uniq
+        files.uniq!(&:name) unless all
+
+        # Print
+        files.each do |log|
+          if all
+            puts "- #{log.friendly_name}"
+          else
+            puts "- #{log.name.colorize(:yellow)}"
+          end
+        end
+      end
+
+      def self.ls(args = [])
+        list(args)
+      end
+
+      def self.show(log_list)
+        # Prepare Log List
+        log_list = ShellHelper.prepare_list(log_list)
+
+        # Convert to Things
+        logs = ShellHelper.find_things(log_list)
+
+        logs.map!(&:data)
+
+        ShellHelper.show logs.flatten
+      end
+
+      # ========================================================================
+      # Filter
+      # ========================================================================
+      # Supported Params
+      # --or (Filter OR instead of AND)
+      # --total Total Count Entries Only
+      # --project=thingy --exclude_this!=asdf *
+      # --slice:  only grab specific fields --slice=path (slice multiple with comma)
+      # --slice=time,path (E.g. log filter  --path='mirror/pull' --slice=path,time )
+      # --except: Exclude specific fields (except multiple with comma)
+      # Example: log filter  --path='mirror/pull' --except=params
+      def self.default(raw_list)
+        filter(raw_list)
+      end
+
+      def self.filter(raw_list)
+        # Print Helper
+        if raw_list == ['help']
+          filter_help
+          return true
+        end
+
+        # Extract Args
+        log_list, opts, args = ShellHelper.param_parse(raw_list)
+
+        # Prepare Log List
+        log_list = ShellHelper.prepare_list(log_list)
+
+        # AND / OR Filtering
+        filter_type = args.or ? :any? : :all?
+
+        results = ShellHelper.filter_start(log_list, filter_type, args, opts)
+
+        # Skipo and Print Total if set
+        if args.total
+          ShellHelper.total_count(results)
+          return true
+        end
+
+        # Check Search Results
+        if results.instance_of?(Hash) && results.values.flatten.empty?
+          puts 'No results'.colorize(:red)
+        else
+          # This causes the key 'colorized' output to also be included
+          ShellHelper.show(results.to_a.compact.flatten, args)
+        end
+
+        # log filter --path='cloud/gitlab-automation' --path='/pull' --all
+        # cloud/gitlab-automation
+        # log filter --project=thingy --other_filter=asdf *
+      rescue StandardError => e
+        binding.pry
+        LogBot.fatal('Filter', message: e.message, backtrace: e.backtrace.first)
+      end
+      # ========================================================================
+
+      # rubocop:disable Metrics/MethodLength
+      def self.filter_help
+        puts "\u2500".colorize(:cyan) * 20
+        puts 'Log Filter'.colorize(:yellow)
+        puts "\u2500".colorize(:cyan) * 20
+
+        puts 'Options'.colorize(:blue)
+        puts '--raw'.colorize(:green)
+        puts '  Do not use less/paging'
+        puts
+
+        puts '--round'.colorize(:green)
+        puts '  Attempt to round all integers. Default: 2.'
+        puts '  E.g. --round, --round=3, --round=0'
+        puts
+
+        puts '--json'.colorize(:green)
+        puts '  Print output back into JSON'
+        puts
+
+        puts '--or'.colorize(:green)
+        puts '  Filters will use OR instead of AND'
+        puts
+
+        puts '--total'.colorize(:green)
+        puts '  Print only total count of matching entries'
+        puts
+
+        puts '--slice'.colorize(:green)
+        puts '  Extract specific fields from entries (slice multiple with comma)'
+        puts '  Ex: --slice=path or --slice=path,params'
+        puts
+
+        puts '--except'.colorize(:green)
+        puts '  Exclude specific fields (except multiple with comma)'
+        puts '  Ex: --except=params --except=params,path'
+        puts
+
+        puts '--stats'.colorize(:green)
+        puts '  Order/Count occurrances by field'
+        puts '  Ex: --stats=params --except=params,path'
+        puts
+
+        puts '--uniq'.colorize(:green)
+        puts '  Show unique values only'
+        puts '  Ex: --uniq=params --uniq=params,path'
+        puts
+
+        puts '--pluck'.colorize(:green)
+        puts '  Extract values from entries'
+        puts '  Ex: --pluck=params --pluck=params,path'
+        puts
+
+        puts '--archive'.colorize(:green)
+        puts '  Limit to specific archvie name (inclusive). Matching SOS tar.gz name'
+        puts '  Ex: --archive=dev-gitlab_20210622154626, --archive=202106,202107'
+        puts
+
+        puts '--sort'.colorize(:green)
+        puts '  Sort by multiple fields'
+        puts '  Ex: --sort=duration_s,db_duration_s'
+        puts
+
+        puts '--reverse'.colorize(:green)
+        puts '  Reverse all results'
+        puts '  Ex: --reverse'
+        puts
+
+        puts '--combine'.colorize(:green)
+        puts '  Omit archive identifier dividers. Useful with sort or time filters'
+        puts '  Ex: --combine'
+        puts
+
+        puts '--start'.colorize(:green)
+        puts '  Show events after specified time. Filtered by the `time` field'
+        puts '  Use with `--end` for between selections'
+        puts '  Ex: log filter --start="2021-06-22 14:44 UTC" --end="2021-06-22 14:45 UTC"'
+        puts
+
+        puts '--end'.colorize(:green)
+        puts '  Show events before specified time. Filtered by the `time` field'
+        puts '  Use with `--start` for between selections'
+        puts '  Ex: log filter --end="2021-06-22"'
+        puts
+
+        puts 'Field Searching'.colorize(:blue)
+        puts '  --[key]=[value]'
+        puts '  Search in key for value'
+        puts '  Example: --path=mirror/pull'
+        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"
+        puts
+
+        puts 'Example Queries'.colorize(:blue)
+        puts "  Also see #{'filter_examples'.colorize(:light_blue)} for even more examples"
+        puts 'log filter --class=BuildFinishedWorker sidekiq/current --slice=time,message'
+        puts 'log filter gitlab-rails/api_json.log --slice=ua --uniq=ua --ua=gitlab-runner'
+
+        puts
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # 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'
+      end
+      # rubocop:enable Layout/LineLength
+
+      # ========================================================================
+      # Search (Full Text / String Search)
+      # ========================================================================
+      # Supported Params
+      # --text='asdf'
+      # --text!='asdf'
+      # --regex='' # TODO?
+      # --slice=time,path (E.g. log filter  --path='mirror/pull' --slice=path,time )
+      # --except: Exclude specific fields (except multiple with comma)
+
+      # --total Total Count Entries Only
+      def self.search(initial_param)
+        # Extract Args
+        log_list, opts, args = ShellHelper.param_parse(initial_param)
+
+        # Prepare Log List
+        log_list = ShellHelper.prepare_list(log_list)
+
+        # AND / OR Filtering
+        filter_type = args.or ? :any? : :all?
+
+        results = ShellHelper.search_start(log_list, filter_type, args, opts)
+
+        # Skipo and Print Total if set
+        if args.total
+          ShellHelper.total_count(results)
+          return true
+        end
+
+        # Check Search Results
+        if results.values.flatten.empty?
+          puts 'No results'.colorize(:red)
+        else
+          # This causes the key 'colorized' output to also be included
+          ShellHelper.show(results.to_a.compact.flatten, args)
+        end
+      rescue StandardError => e
+        LogBot.fatal('Filter', message: e.message, backtrace: e.backtrace.first)
+      end
+      # ========================================================================
+
+      # Supported Params
+      # --text='asdf'
+      # --text!='asdf'
+      # --slice=time,path (E.g. log filter  --path='mirror/pull' --slice=path,time )
+      # --except: Exclude specific fields (except multiple with comma)
+
+      # rubocop:disable Metrics/MethodLength
+      def self.search_help
+        puts "\u2500".colorize(:cyan) * 20
+        puts 'Log Search'.colorize(:yellow)
+        puts "\u2500".colorize(:cyan) * 20
+
+        puts 'Search will do a full line include or exclude text search'
+
+        puts 'Options'.colorize(:blue)
+        puts '--text'.colorize(:green)
+        puts '  Primary parameter for searching. Include or ! to exclude'
+        puts '  Ex: --text=BuildHooksWorker --text!=start sidekiq/current'
+        puts
+
+        puts '--total'.colorize(:green)
+        puts '  Print only total count of matching entries'
+        puts
+
+        puts '--slice'.colorize(:green)
+        puts '  Extract specific fields from entries (slice multiple with comma)'
+        puts '  Ex: --slice=path or --slice=path,params'
+        puts
+
+        puts '--except'.colorize(:green)
+        puts '  Exclude specific fields (except multiple with comma)'
+        puts '  Ex: --except=params --except=params,path'
+        puts
+
+        puts '--archive'.colorize(:green)
+        puts '  Limit to specific archvie name (inclusive). Matching SOS tar.gz name'
+        puts '  Ex: --archive=dev-gitlab_20210622154626, --archive=202106,202107'
+        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"
+        puts
+
+        puts 'Example Queries'.colorize(:blue)
+        puts 'log search --text=BuildHooksWorker --text!=start sidekiq/current --total'
+        puts 'log search --text=BuildHooksWorker --text!=start --slice=enqueued_at sidekiq/current'
+        puts
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # ------------------------------------------------------------------------
+    end
+    # rubocop:enable Metrics/ModuleLength
+  end
+end
+
+module GreenHat
+  module ShellHelper
+    # Log Helpers
+    module Log
+      def self.list
+        Thing.all.select(&:log)
+      end
+    end
+    # --------
+  end
+end

data/lib/greenhat/shell/memory.rb

@@ -0,0 +1,31 @@
+module GreenHat
+  # CLI Helper
+  module Shell
+    # Logs
+    module Memory
+      # Easy Show All
+      def self.free
+        ShellHelper.file_output GreenHat::Memory.free
+      end
+
+      # Pretty Show
+      def self.show
+        results = ShellHelper.file_process(GreenHat::Memory.free) do |file|
+          list = [
+            file.friendly_name
+          ]
+
+          file.data.each do |mem|
+            list.push GreenHat::Memory.memory_row mem
+          end
+
+          list.push "\n"
+
+          list
+        end
+
+        ShellHelper.show(results.flatten)
+      end
+    end
+  end
+end

data/lib/greenhat/shell/network.rb

@@ -0,0 +1,12 @@
+module GreenHat
+  # CLI Helper
+  module Shell
+    # Logs
+    module Network
+      # Easy Show All
+      def self.netstat
+        ShellHelper.file_output GreenHat::Network.netstat
+      end
+    end
+  end
+end

data/lib/greenhat/shell/process.rb

@@ -0,0 +1,12 @@
+module GreenHat
+  # CLI Helper
+  module Shell
+    # Logs
+    module Process
+      # Easy Show All
+      def self.ps
+        ShellHelper.file_output GreenHat::Ps.ps
+      end
+    end
+  end
+end

data/lib/greenhat/shell/report.rb

@@ -0,0 +1,319 @@
+module GreenHat
+  # Root Level Shell / Report Helper
+  module Shell
+    def self.report(raw)
+      args = {
+        raw: raw.include?('--raw')
+      }
+
+      ShellHelper.show(Archive.all.map(&:report).map(&:show).flatten, args)
+    end
+  end
+end
+
+module GreenHat
+  # Report Generator Helper
+  # rubocop:disable Metrics/ClassLength
+  class Report
+    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, :free_m
+
+    # Find Needed Files for Report
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+    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.sidekiq_log = archive.things.find { |x| x.name == 'sidekiq/current' }
+    end
+
+    def show
+      output = [
+        archive.friendly_name.colorize(:blue)
+      ]
+
+      # OS
+      output << 'OS'.colorize(:light_yellow)
+      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
+      output << ''
+
+      # Memory
+      if meminfo || free_m
+        output << 'Memory'.colorize(:light_yellow)
+        output << memory if meminfo
+        output << memory_free if free_m
+        output << ''
+      end
+
+      # Gitlab
+      output << 'GitLab'.colorize(:light_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 << production_errors if production_log
+      output << api_errors if api_log
+      output << application_errors if application_log
+      output << sidekiq_errors if sidekiq_log
+
+      # Final Space / Return
+      output << ''
+      output
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+
+    def production_errors
+      count = production_log.data.count { |x| x.status == 500 }
+      color = count.zero? ? :green : :red
+
+      [
+        title('  Production', :light_red, 18),
+        count.to_s.colorize(color)
+      ].join
+    end
+
+    def api_errors
+      count = api_log.data.count { |x| x.status == 500 }
+      color = count.zero? ? :green : :red
+
+      [
+        title('  API', :light_red, 18),
+        count.to_s.colorize(color)
+      ].join
+    end
+
+    def application_errors
+      count = application_log.data.count { |x| x&.severity == 'ERROR' }
+      color = count.zero? ? :green : :red
+
+      [
+        title('  Application', :light_red, 18),
+        count.to_s.colorize(color)
+      ].join
+    end
+
+    def sidekiq_errors
+      count = sidekiq_log.data.count { |x| x&.severity == 'ERROR' }
+      color = count.zero? ? :green : :red
+
+      [
+        title('  Sidekiq', :light_red, 18),
+        count.to_s.colorize(color)
+      ].join
+    end
+
+    def gitlab_services
+      list = gitlab_status.data.keys.sort.map do |service|
+        color = gitlab_status.data.dig(service, 0, :status) == 'run' ? :green : :red
+        service.colorize(color)
+      end
+
+      # Keep Alphabetical Sort
+      groups = list.each_slice((list.size / 3.to_f).round).to_a
+
+      table = TTY::Table.new do |t|
+        loop do
+          break if groups.all?(&:empty?)
+
+          t << groups.map(&:shift)
+        end
+      end
+
+      [
+        title('Services'),
+        "\n   ",
+        table.render(:unicode, padding: [0, 1, 0, 1], indent: 3)
+      ].join
+    rescue StandardError => e
+      LogBot.fatal('GitLab Services', message: e.message, backtrace: e.backtrace.first)
+    end
+
+    def gitlab_version
+      [
+        title('Version'),
+        gitlab_manifest.data.build_version
+      ].join
+    end
+
+    def hostname
+      [
+        title('Hostname'),
+        host.data.first
+      ].join
+    end
+
+    def distro
+      [
+        title('Distro'),
+        "[#{os_release.data.ID}] ".colorize(:light_black),
+        os_release.data.PRETTY_NAME
+      ].join
+    end
+
+    def selinux
+      status = selinux_status.data['SELinux status']
+      status_color = status == 'enabled' ?  :green : :red
+
+      [
+        title('SeLinux'),
+        status.colorize(status_color),
+        ' (',
+        selinux_status.data['Current mode'],
+        ')'
+      ].join
+    end
+
+    def arch
+      [
+        title('Arch'),
+        cpu.data.Architecture
+      ].join
+    end
+
+    def kernel
+      # TODO: Better way to consistently get uname info?
+      value, build = uname.data.first.split[2].split('-')
+      [
+        title('Kernel'),
+        value,
+        " (#{build})".colorize(:light_black)
+      ].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
+      ntp_statuses = timedatectl.data.slice(*ntp_keys).values.compact
+
+      enabled = %w[active yes] & ntp_statuses
+      ntp_status = ntp_statuses.first
+      ntp_color = enabled.empty? ? :red : :green
+
+      # Fall Back
+      ntp_status ||= 'unknown'
+
+      [
+        title('Sys Time'),
+        timedatectl.data['Local time'],
+        ' (ntp: '.colorize(:light_black),
+        ntp_status.colorize(ntp_color),
+        ')'.colorize(:light_black)
+      ].join
+    end
+
+    # Strip/Simplify Uptime
+    def sys_uptime
+      init = uptime.data.first.split(',  load average').first.strip
+
+      [
+        title('Uptime'),
+        init.split('up ', 2).last
+      ].join
+    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)
+        color = value > 100 ? :red : :green
+        [
+          interval,
+          ' (',
+          "#{value}%".colorize(color),
+          ')'
+        ].join
+      end
+
+      [
+        title('LoadAvg'),
+        "[CPU #{cpu_count}] ".colorize(:light_white),
+        intervals_text.join(', ')
+      ].join
+    end
+
+    def memory
+      total = ShellHelper.human_size_to_number(meminfo.data['MemTotal'])
+      free = ShellHelper.human_size_to_number(meminfo.data['MemFree'])
+      used = percent((total - free), total)
+      [
+        title('MemUsed'),
+        '['.colorize(:light_black),
+        '='.colorize(:green) * (used / 2),
+        ' ' * (50 - used / 2),
+        ']'.colorize(:light_black),
+        " #{100 - percent(free, total)}%".colorize(:green), # Inverse
+        "\n",
+        title('Total'),
+        number_to_human_size(total).colorize(:light_white),
+        "\n",
+        title('Used'),
+        number_to_human_size(total - free),
+        "\n",
+        title('Free'),
+        number_to_human_size(free)
+      ].join
+    end
+
+    def memory_free
+      free = free_m.data.find { |x| x.kind == 'Mem' }
+
+      return unless free
+
+      [
+        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)
+      ].join
+    end
+
+    # ----------------------------
+    # Helpers
+    # ----------------------------
+    def percent(value, total)
+      ((value / total.to_f) * 100).round
+    end
+
+    # Helper to Make Cyan Titles
+    def title(name, color = :cyan, ljust = 12)
+      "  #{name}:".ljust(ljust).colorize(color)
+    end
+  end
+  # rubocop:enable Metrics/ClassLength
+end