host_status 0.1.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.5.1
+  - 2.4.3
+  - 2.3.7
+  - 2.2.9
+before_install: gem install bundler

data/.yardopts

@@ -0,0 +1,4 @@
+--protected
+--no-private
+--embed-mixin ClassMethods
+--embed-mixin Sym::Extensions::InstanceMethods

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Konstantin Gredeskoul
+
+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,61 @@
+[![Build Status](https://travis-ci.org/kigster/host_status.svg?branch=master)](https://travis-ci.org/kigster/host_status)
+
+# HostStatus — Work In Progress...
+
+This gem provides a consistent interface for a concept of a host or a container running a particular application. It expresses application throughput, error rate, response time, and host cpu/ram/disk metrics in a consistent way, while allowing various pluggable adapters to aquire the data.
+
+For instance, a NewRelic adapter would query the run-time status of a given host using a REST API call. 
+
+An HAProxy adapter may attempt to connect to the haproxy stats port and fetch the data from there.
+
+Once configured, the client of this gem should be able to reliably fetch various metrics about the host. 
+
+> **MOTIVATION**: This gem is motivated by a concept of a Canary Deployment, where it's important to be able to compare metrics of a "canary" host with new application code to that of the rest of the running servers.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'host_status'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install host_status
+
+## Usage
+
+```ruby
+    HostStatus.configure do |c|
+      c.adapters << :newrelic
+    end
+    
+    HostStatus::NewRelic.configure do |c|
+      c.api_key = '092358902850934580'
+    end
+        
+```   
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec host_status` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, 
+update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kigster/host_status.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+

data/Rakefile

@@ -0,0 +1,38 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'timeout'
+
+def shell(*args)
+  puts "running: #{args.join(' ')}"
+  system(args.join(' '))
+end
+
+task :clean do
+  shell('rm -rf pkg/ tmp/ coverage/ doc/ ' )
+end
+
+task :gem => [:build] do
+  shell('gem install pkg/*')
+end
+
+task :permissions => [ :clean ] do
+  shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
+  shell("find . -type d -exec chmod o+x,g+x {} \\;")
+end
+
+task :build => :permissions
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE)
+  t.options.unshift('--title','Host Status')
+  t.after = ->() { exec('open doc/index.html') }
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+
+
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "host_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/host_status

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "host_status"

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/host_status.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'host_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'host_status'
+  spec.version       = HostStatus::VERSION
+  spec.authors       = ['Konstantin Gredeskoul']
+  spec.email         = %w(kigster@gmail.com)
+
+  spec.summary       = %q{A generalized interface for obtaining a status of an application running on a given host, intended to be used in Canary Deploys. Supports any number of backend adapters such as NewRelic.}
+  spec.description   = %q{A generalized facade that aggregates metrics for a given host running a particular application using any number of adapters and plugins including third-party APIs.}
+  spec.homepage      = 'https://github.com/kigster/host_status'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dry-configurable'
+  spec.add_dependency 'dry-types'
+  spec.add_dependency 'dry-struct'
+  spec.add_dependency 'activesupport', '> 3'
+
+  spec.add_dependency 'hashie'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'awesome_print'
+end

data/lib/host_status.rb

@@ -0,0 +1,29 @@
+require 'dry-configurable'
+require 'logger'
+
+module HostStatus
+  class << self
+    attr_accessor :debug
+    attr_writer :logger, :adapters
+
+    alias debug? debug
+
+    def log(lvl = :info, *messages)
+      messages.each { |m| logger.send(lvl, m) }
+    end
+
+    private
+
+    def logger
+      @logger ||= :Logger.new(STDOUT)
+    end
+  end
+
+  extend ::Dry::Configurable
+  setting :adapters, []
+end
+
+require_relative 'host_status/version'
+require_relative 'host_status/types'
+require_relative 'host_status/host'
+

data/lib/host_status/application.rb

@@ -0,0 +1,44 @@
+require 'dry-struct'
+require 'host_status/types'
+
+module HostStatus
+  class Application < Dry::Struct
+    transform_keys(&:to_sym)
+
+    attribute :name, HostStatus::Types::Strict::String
+    attribute :id, Types::Optional
+    attribute :url, Types::Url
+    attribute :api_url, Types::Url
+    attribute :language, Types::Optional
+    attribute :process_count, Types::Count
+    attribute :online, Types::IsUp
+
+    # all numbers are per minute
+    attribute :errors, Types::RatePerMinute
+    attribute :throughput, Types::RatePerMinute
+    attribute :latency_p50, Types::RatePerMinute
+    attribute :latency_p90, Types::RatePerMinute
+
+    class Proxy
+      attr_accessor :app
+
+      def initialize(**opts, &block)
+        options  = transform_arguments(**opts)
+        self.app = Application.new(**options, &block)
+      end
+
+      def method_missing(method, *args, &block)
+        if app&.respond_to?(method)
+          app&.send(method, *args, &block)
+        else
+          super(method, *args, &block)
+        end
+      end
+
+      def transform_arguments(**opts)
+        opts
+      end
+    end
+  end
+end
+

data/lib/host_status/host.rb

@@ -0,0 +1,29 @@
+require 'dry-struct'
+require 'dry-types'
+require 'host_status/types'
+require 'host_status/application'
+require 'host_status/resources'
+
+module HostStatus
+  # {
+  #   "id":                  90952626,
+  #   "application_name":    "G3 Homebase Production",
+  #   "host":                "crn001-a.prod.homebase.systems",
+  #   "language":            "ruby",
+  #   "health_status":       "green",
+  #   "application_summary": {
+  #       "response_time":  0,
+  #       "throughput":     0,
+  #       "error_rate":     0,
+  #       "apdex_score":    null,
+  #       "instance_count": 3
+  #   },
+  #
+  class Host < ::Dry::Struct
+    attribute :name, HostStatus::Types::Strict::String
+    attribute :id, HostStatus::Types::Strict::String.optional
+    attribute :resources, HostStatus::Resources
+    attribute :applications, Types::Strict::Array.of(HostStatus::Application).default([])
+  end
+end
+

data/lib/host_status/new_relic.rb

@@ -0,0 +1,8 @@
+require 'dry-configurable'
+
+module HostStatus
+  module NewRelic
+    extend Dry::Configurable
+    setting :api_key, ENV['NEWRELIC_API_KEY'], required: true
+  end
+end

data/lib/host_status/new_relic/apm.rb

@@ -0,0 +1,26 @@
+require 'hashie'
+require 'dry-struct'
+require 'host_status/types'
+require 'host_status/application'
+
+module HostStatus
+  module NewRelic
+    class APM < ::HostStatus::Application::Proxy
+      DEFAULTS = {
+          response_time:  nil,
+          error_rate:     nil,
+          instance_count: nil,
+          apdex_score:    nil,
+      }.freeze
+
+      def transform_arguments(**opts)
+        Hashie::Extensions::SymbolizeKeys.symbolize_keys!(opts)
+        options                 = DEFAULTS.merge(opts)
+        options[:latency_p50]   = options.delete(:response_time)
+        options[:errors]        = options.delete(:error_rate)
+        options[:process_count] = options.delete(:instance_count)
+        options
+      end
+    end
+  end
+end

data/lib/host_status/resources.rb

@@ -0,0 +1,18 @@
+require 'dry-struct'
+require 'host_status/types'
+require 'host_status/application'
+
+module HostStatus
+  class Resources < ::Dry::Struct
+    attribute :pct_cpu_free, HostStatus::Types::Percent.optional
+    attribute :pct_ram_free, HostStatus::Types::Percent.optional
+    attribute :pct_disk_free, HostStatus::Types::Percent.optional
+
+    # all sizes are in Megabytes
+    attribute :mb_ram_free, HostStatus::Types::Megabyte.optional
+    attribute :mb_ram_total, HostStatus::Types::Megabyte.optional
+    attribute :mb_disk_free, HostStatus::Types::Megabyte.optional
+    attribute :mb_disk_total, HostStatus::Types::Megabyte.optional
+  end
+end
+

data/lib/host_status/types.rb

@@ -0,0 +1,14 @@
+require 'dry-types'
+module HostStatus
+  module Types
+    include ::Dry::Types.module
+
+    Optional = String.optional.default(nil)
+    Url = String.optional.default(nil).constrained format: URI::regexp(%w(http https))
+    Percent = Coercible::Float.optional.constrained gteq: 0.0, lteq: 100.0
+    Megabyte = Coercible::Float.optional
+    RatePerMinute = Coercible::Float.optional.default(nil).constrained gteq: 0.0
+    IsUp = Bool.optional.default(nil)
+    Count = Coercible::Integer.optional.default(nil).constrained gteq: 0
+  end
+end

data/lib/host_status/version.rb

@@ -0,0 +1,3 @@
+module HostStatus
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: host_status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Konstantin Gredeskoul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A generalized facade that aggregates metrics for a given host running
+  a particular application using any number of adapters and plugins including third-party
+  APIs.
+email:
+- kigster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/host_status
+- bin/setup
+- host_status.gemspec
+- lib/host_status.rb
+- lib/host_status/application.rb
+- lib/host_status/host.rb
+- lib/host_status/new_relic.rb
+- lib/host_status/new_relic/apm.rb
+- lib/host_status/resources.rb
+- lib/host_status/types.rb
+- lib/host_status/version.rb
+homepage: https://github.com/kigster/host_status
+licenses:
+- MIT
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A generalized interface for obtaining a status of an application running
+  on a given host, intended to be used in Canary Deploys. Supports any number of backend
+  adapters such as NewRelic.
+test_files: []