server-status 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af20ee25a465ed5e45e9a0018dcacb9afc3f94e4
+  data.tar.gz: 3110214e2c5ce45799d213a9e97505b5ce82dd6a
+SHA512:
+  metadata.gz: c7c22c4d49b1c6fee75812769db130051a98406729dcc39e96c508e535e06c35bc93a4a64dd2821be07790a47e32ce722f41ea964d8fcbce4d99d30b411547c9
+  data.tar.gz: be97a5537f8c72f8d570fbdab9c8d945baa5aef74f96a85616ba48a58448bdc6899452f8e105579d4f0683e71f3273d1adaa4257f6bc55c7cbedc910a85e8421

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in server-status.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 James Brooks
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Server Status
+
+[![Code Climate](https://codeclimate.com/github/jamesbrooks/server-status.png)](https://codeclimate.com/github/JamesBrooks/git-runner)
+[![Gem Version](https://badge.fury.io/rb/server-status.png)](http://badge.fury.io/rb/git-runner)
+[![Dependency Status](https://gemnasium.com/jamesbrooks/server-status.png)](https://gemnasium.com/JamesBrooks/git-runner)
+
+Command line tool for quickly fetching and displaying vital host metrics.
+
+## Installation
+
+`gem install server-status`
+
+## Usage
+
+### Add a host
+
+```sh
+# Track a host (uses the host name as the friendly name)
+server-status add ubuntu@server.net
+
+# Track a host using a friendly name
+server-status add ubuntu@server.net personal-server
+```
+
+### Remove a host
+
+```sh
+server-status remove personal-server
+```
+
+### List all hosts
+
+```sh
+server-status list
+```
+
+### Fetch statuses of all tracked hosts
+
+```sh
+server-status
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "server/status"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/server-status

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'server-status'
+ServerStatus::Application.new.run

data/lib/server-status/application.rb

@@ -0,0 +1,88 @@
+module ServerStatus
+  class Application
+    include Commander::Methods
+
+    attr_accessor :configuration
+
+
+    def initialize
+      @config = ServerStatus::Configuration.new
+    end
+
+    def run
+      never_trace!
+
+      program :name, 'Server Status'
+      program :version, ServerStatus::VERSION
+      program :description, 'Fast remote host statuses'
+
+      default_command :run
+
+      command :run do |c|
+        c.description = 'Fetch statuses of all tracked hosts (default)'
+
+        c.option '--[no-]os'
+        c.option '--[no-]uptime'
+        c.option '--[no-]load'
+        c.option '--[no-]disk-usage'
+        c.option '--[no-]inode-usage'
+        c.option '--[no-]memory-usage'
+        c.option '--[no-]package-updates'
+        c.option '--[no-]reboot-required'
+
+        c.action do |args, options|
+          options.default({
+            os:              false,
+            uptime:          true,
+            load:            true,
+            disk_usage:      true,
+            inode_usage:     true,
+            memory_usage:    true,
+            package_updates: true,
+            reboot_required: true
+          }.merge(@config.options))
+
+          ServerStatus::Commands::Run.new(@config, options).perform
+        end
+      end
+
+      command :list do |c|
+        c.description = 'List all currently tracked hosts'
+
+        c.action do
+          ServerStatus::Commands::List.new(@config).perform
+        end
+      end
+
+      command :add do |c|
+        c.syntax = 'add <host> [name]'
+        c.description = 'Add a remote host'
+
+        c.action do |args, options|
+          if args.size < 1 || args.size > 2
+            puts "requires either 1 or 2 arguments\n\n\tadd <host> [friendly-name]\n\n"
+            exit(1)
+          end
+
+          ServerStatus::Commands::Add.new(@config, *args).perform
+        end
+      end
+
+      command :remove do |c|
+        c.syntax = 'remove <name>'
+        c.description = 'Remove a remote host'
+
+        c.action do |args, options|
+          unless args.size == 1
+            puts "requires 1 argument\n\n\tremove <name>\n\n"
+            exit(1)
+          end
+
+          ServerStatus::Commands::Remove.new(@config, *args).perform
+        end
+      end
+
+      run!
+    end
+  end
+end

data/lib/server-status/commands/add.rb

@@ -0,0 +1,29 @@
+module ServerStatus
+  module Commands
+    class Add < BaseCommand
+      def initialize(config, host, name=nil)
+        super(config)
+
+        @host = host
+        @name = name || host
+      end
+
+      def perform
+        settings['hosts'] ||= {}
+
+        # Check to see if we're already tracking
+        settings['hosts'].each do |name, host|
+          if name == @name
+            puts "#{name} already exists"
+            exit(1)
+          end
+        end
+
+        settings['hosts'][@name] = @host
+        config.save
+
+        puts "Added #{@name}"
+      end
+    end
+  end
+end

data/lib/server-status/commands/base.rb

@@ -0,0 +1,16 @@
+module ServerStatus
+  module Commands
+    class BaseCommand
+      attr_accessor :config
+
+
+      def initialize(config)
+        @config = config
+      end
+
+      def settings
+        config.settings
+      end
+    end
+  end
+end

data/lib/server-status/commands/list.rb

@@ -0,0 +1,15 @@
+module ServerStatus
+  module Commands
+    class List < BaseCommand
+      def perform
+        if settings['hosts'].any?
+          longest_name = settings['hosts'].map { |n, h| n.size }.max
+
+          settings['hosts'].each do |name, host|
+            puts "#{name.ljust(longest_name)}  #{host}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/server-status/commands/remove.rb

@@ -0,0 +1,24 @@
+module ServerStatus
+  module Commands
+    class Remove < BaseCommand
+      def initialize(config, name)
+        super(config)
+        @name = name
+      end
+
+      def perform
+        if settings['hosts'] && settings['hosts'][@name]
+          settings['hosts'].delete(@name)
+          config.save
+
+          puts "Removed #{@name}"
+
+          return
+        end
+
+        puts "#{@name} does not exist"
+        exit(1)
+      end
+    end
+  end
+end

data/lib/server-status/commands/run.rb

@@ -0,0 +1,24 @@
+module ServerStatus
+  module Commands
+    class Run < BaseCommand
+      def initialize(config, options)
+        super(config)
+
+        @options = options
+      end
+
+      def perform
+        unless settings['hosts']
+          puts "No hosts tracked. To add hosts: server-status add <host> [name]"
+          exit(1)
+        end
+
+        host_set = ServerStatus::HostSet.new(config, @options, settings['hosts'])
+        host_set.fetch_statuses
+
+        report = ServerStatus::Report.new(config, @options, host_set)
+        puts report.generate_table
+      end
+    end
+  end
+end

data/lib/server-status/configuration.rb

@@ -0,0 +1,31 @@
+require 'json'
+
+module ServerStatus
+  class Configuration
+    CONFIG_PATH = File.join(Dir.home, '.server-status.json')
+
+    attr_accessor :settings
+
+
+    def initialize
+      if File.exist?(CONFIG_PATH)
+        @settings = JSON.parse(File.open(CONFIG_PATH).read)
+      else
+        @settings = {}
+      end
+    end
+
+    def save
+      File.open(CONFIG_PATH, 'w') do |file|
+        file.write JSON.pretty_generate(@settings)
+      end
+    end
+
+    def options
+      # symbolize keys
+      (settings['options'] || {}).each_with_object({}) do |(key, value), hash|
+        hash[key.to_sym] = value
+      end
+    end
+  end
+end

data/lib/server-status/host.rb

@@ -0,0 +1,50 @@
+module ServerStatus
+  class Host
+    class RemoteCommandFailure < StandardError ; end
+
+    attr_accessor :name, :status
+
+
+    def initialize(config, name, host)
+      @config = config
+      @name   = name
+      @host   = host
+
+      @feteched_status = false
+    end
+
+    def feteched_status?
+      @feteched_status
+    end
+
+    def fetch_status(status_command)
+      # Fetch statuses
+      raw_statuses = execute_command(status_command)
+
+      # Hashed statuses
+      raw_statuses = raw_statuses.split(ServerStatus::StatusCommand::SEPARATOR)
+      raw_statuses = raw_statuses.map(&:strip)
+      raw_statuses = status_command.requested_options.zip(raw_statuses).to_h
+
+      @feteched_status = true
+
+      @status = raw_statuses
+
+
+    rescue RemoteCommandFailure => ex
+      @status = { error: ex.message }
+    end
+
+
+  private
+    def execute_command(status_command)
+      stdin, stdout, stderr, wait_thread = Open3.popen3("ssh #{@host} \"bash -s\" << EOF\n#{status_command.to_script}\nEOF")
+
+      if wait_thread.value.success?
+        stdout.read
+      else
+        raise RemoteCommandFailure, stderr.read
+      end
+    end
+  end
+end

data/lib/server-status/host_set.rb

@@ -0,0 +1,28 @@
+module ServerStatus
+  class HostSet
+    attr_accessor :config, :options, :hosts
+
+
+    def initialize(config, options, hosts)
+      @config  = config
+      @options = options
+      @hosts   = hosts.map { |host, name| Host.new(config, host, name) }
+    end
+
+    def fetch_statuses
+      threads = @hosts.map do |host|
+        Thread.new do
+          host.fetch_status(status_command)
+        end
+      end
+
+      threads.each(&:join)
+    end
+
+
+  private
+    def status_command
+      @status_command ||= ServerStatus::StatusCommand.new(@options)
+    end
+  end
+end

data/lib/server-status/report.rb

@@ -0,0 +1,132 @@
+module ServerStatus
+  class Report
+    COLUMN_SPACING = 5
+
+
+    def initialize(config, options, host_set)
+      @config   = config
+      @options  = options
+      @host_set = host_set
+    end
+
+    def generate_table
+      str = "\n"
+
+      # Report any failures
+      if (failed_hosts = @host_set.hosts.reject(&:feteched_status?)).any?
+        failed_hosts.each do |host|
+          str << "Failure #{host.name} - #{host.status[:error]}\n".colorize(:red)
+        end
+
+        str << "\n"
+      end
+
+      columns = [ :host ] + @host_set.hosts.detect(&:feteched_status?).status.keys
+
+      # Process status values
+      statuses = @host_set.hosts.select(&:feteched_status?).map do |host|
+        host.status.each_with_object({ host: host.name }) do |(k, v), hash|
+          hash[k] = send("format_#{k}", v)
+        end
+      end
+
+      # Determine column widths
+      column_widths = columns.each_with_object({}) do |col, hash|
+        sizes  = statuses.map { |s| s[col].uncolorize.size }
+        sizes << col.to_s.size
+
+        hash[col] = sizes.max
+      end
+
+
+      # Render headings
+      column_widths.each do |col, col_width|
+        str << col.to_s.upcase.colorize(:blue)
+        str << ' ' * (COLUMN_SPACING + col_width - col.size)
+      end
+
+      str << "\n"
+
+
+      # Render table
+      statuses.sort { |x,y| x[:host] <=> y[:host] }.each do |status|
+        column_widths.each do |col, col_width|
+          str << status[col]
+          str << ' ' * (COLUMN_SPACING + col_width - status[col].uncolorize.size)
+        end
+
+        str << "\n"
+      end
+
+      str << "\n"
+      str
+    end
+
+
+  private
+    # Formatters
+    def format_os(val)
+      val
+    end
+
+    def format_uptime(val)
+      "#{val.to_i / 86400} days"
+    end
+
+    def format_load(val)
+      val
+    end
+
+    def format_disk_usage(val)
+      format_percentage(val)
+    end
+
+    def format_inode_usage(val)
+      format_percentage(val)
+    end
+
+    def format_memory_usage(val)
+      used, available = val.split(' ').map(&:to_f)
+      format_percentage(used / (used + available))
+    end
+
+    def format_package_updates(val)
+      str = ''
+
+      if val =~ /(\d+) packages can be updated/
+        str << $1 if $1.to_i != 0
+      end
+
+      if val =~ /(\d+) (updates are|update is a) security update(s)?/
+        str << " (#{$1} security)".colorize(:red) if $1.to_i != 0
+      end
+
+      str
+    end
+
+    def format_reboot_required(val)
+      if val.to_i == 1
+        'YES'.colorize(:yellow)
+      else
+        'NO'
+      end
+    end
+
+    def format_percentage(val)
+      if val.is_a?(String)
+        # Convert from string % to float
+        val = val.to_f / 100
+      end
+
+      color = if val > 0.85
+        :red
+      elsif val > 0.7
+        :yellow
+      else
+        :normal
+      end
+
+      "#{(val * 100).round(0)}%".colorize(color)
+    end
+  end
+end

data/lib/server-status/status_command.rb

@@ -0,0 +1,51 @@
+module ServerStatus
+  class StatusCommand
+    SEPARATOR = '###'
+
+
+    def initialize(options)
+      @options = options
+      @parts   = []
+    end
+
+    def requested_options
+      @requested_options ||= @options.__hash__.select { |k,v| k if v }.keys
+    end
+
+    def to_script
+      if @options.os
+        @parts << "lsb_release -d | cut -f2"
+      end
+
+      if @options.uptime
+        @parts << "cat /proc/uptime | cut -d\" \" -f1"
+      end
+
+      if @options.load
+        @parts << "cat /proc/loadavg | cut -d\" \" -f -3"
+      end
+
+      if @options.disk_usage
+        @parts << "df -h | awk '/\\/$/' | sed 's/ \\+/ /g' | cut -d\" \" -f5"
+      end
+
+      if @options.inode_usage
+        @parts << "df -hi | awk '/\\/$/' | sed 's/ \\+/ /g' | cut -d\" \" -f5"
+      end
+
+      if @options.memory_usage
+        @parts << "free -m | sed -n 3p | sed 's/ \\+/ /g' | cut -d\" \" -f 3-"
+      end
+
+      if @options.package_updates
+        @parts << "cat /var/lib/update-notifier/updates-available 2>/dev/null"
+      end
+
+      if @options.reboot_required
+        @parts << "if [ -f /var/run/reboot-required ]; then echo 1 ; fi"
+      end
+
+      @parts.join("\necho '#{SEPARATOR}'\n")
+    end
+  end
+end

data/lib/server-status/version.rb

@@ -0,0 +1,3 @@
+module ServerStatus
+  VERSION = '1.0'
+end

data/lib/server-status.rb

@@ -0,0 +1,18 @@
+require 'open3'
+require 'commander'
+require 'colorize'
+
+require 'server-status/version'
+require 'server-status/application'
+require 'server-status/configuration'
+
+require 'server-status/host_set'
+require 'server-status/host'
+require 'server-status/status_command'
+require 'server-status/report'
+
+require 'server-status/commands/base'
+require 'server-status/commands/add'
+require 'server-status/commands/list'
+require 'server-status/commands/remove'
+require 'server-status/commands/run'

data/server-status.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'server-status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "server-status"
+  spec.version       = ServerStatus::VERSION
+  spec.authors       = ["James Brooks"]
+  spec.email         = ["james@jamesbrooks.net"]
+
+  spec.summary       = "Command line tool for quickly fetching and displaying vital host metrics"
+  spec.description   = "Command line tool for quickly fetching and displaying vital host metrics"
+  spec.homepage      = "https://github.com/jamesbrooks/server-status"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ["server-status"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "commander", "~> 4.3"
+  spec.add_dependency "colorize", "~> 0.7.7"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: server-status
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- James Brooks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Command line tool for quickly fetching and displaying vital host metrics
+email:
+- james@jamesbrooks.net
+executables:
+- server-status
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/server-status
+- lib/server-status.rb
+- lib/server-status/application.rb
+- lib/server-status/commands/add.rb
+- lib/server-status/commands/base.rb
+- lib/server-status/commands/list.rb
+- lib/server-status/commands/remove.rb
+- lib/server-status/commands/run.rb
+- lib/server-status/configuration.rb
+- lib/server-status/host.rb
+- lib/server-status/host_set.rb
+- lib/server-status/report.rb
+- lib/server-status/status_command.rb
+- lib/server-status/version.rb
+- server-status.gemspec
+homepage: https://github.com/jamesbrooks/server-status
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Command line tool for quickly fetching and displaying vital host metrics
+test_files: []