net-ntp-check 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a134604cce5077583f9fb2236aa9c143f79fadb
+  data.tar.gz: 3fc6e593c44f164704a71795a80f40d3adbff86d
+SHA512:
+  metadata.gz: 6d354cff2e572c728fbbcdcb03a2ff41c6276a2a971ec31daaa8e272175f1f0e0144b3de8b500d99dea1a2c6e5352b16ffbee1e0da8ec9193a2223db1a9e30d6
+  data.tar.gz: 2c0f30bbc3df48b6ddded118c433863d620a5c8c85d5b5033498666ae6a0b1cda170e526b1a842884378c655eba2687cc25cce2730e28b1d99ea1a660322c15d

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,15 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-23 03:38:36 -0800 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 19

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+net-ntp-check gem CHANGELOG
+======================
+This file is used to list changes made in each version of the net-ntp-check gem.
+
+v0.0.1 (2015-01-23)
+-------------------
+- Initial gem publish

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 PagerDuty, Inc.
+
+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,59 @@
+# Net::Ntp::Check
+
+[![Build Status](https://travis-ci.org/PagerDuty/net-ntp-check.svg?branch=master)](https://travis-ci.org/PagerDuty/net-ntp-check)
+[![Gem Version](http://img.shields.io/gem/v/net-ntp-check.svg)](https://rubygems.org/gems/net-ntp-check)
+[![Coverage Status](https://img.shields.io/coveralls/PagerDuty/net-ntp-check/master.svg)](https://coveralls.io/r/PagerDuty/net-ntp-check?branch=master)
+[![Code Climate](https://codeclimate.com/github/PagerDuty/net-ntp-check/badges/gpa.svg)](https://codeclimate.com/github/PagerDuty/net-ntp-check)
+
+Checks NTP offset against several NTP servers and allows pushing of offset stats via statsd
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'net-ntp-check'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install net-ntp-check
+
+## Usage
+
+### Get NTP offsets based on several servers
+```ruby
+require 'net/ntp/check'
+offsets = Net::NTP::Check.get_offsets
+```
+
+### Get NTP offset based on several servers with a 200ms bandpass filter applied
+```ruby
+require 'net/ntp/check'
+offsets = Net::NTP::Check.get_offsets_filtered
+```
+
+### Send NTP offset to statsd
+```ruby
+require 'net/ntp/check'
+client = Net::NTP::Check::StatsdClient.new
+client.send_offset_stats
+```
+
+#### Statsd Error Codes
+- 0 - Success
+- 1 - Unknown Error
+- 2 - Timeout Error
+- 3 - Socket Error (failed DNS resolution)
+
+## Contributing
+
+1. Fork it ( https://github.com/pagerduty/net-ntp-check/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run all linters on the codebase'
+task :linters do
+  Rake::Task['rubocop'].invoke
+end
+
+desc 'rubocop compliancy checks'
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.patterns = %w( lib/**/*.rb lib/*.rb spec/*.rb )
+end
+
+task default: [:linters, :spec]

data/lib/net/ntp/check.rb

@@ -0,0 +1,21 @@
+require 'logger'
+
+require 'net/ntp/check/version'
+require 'net/ntp/check/offset'
+require 'net/ntp/check/statsd'
+
+module Net
+  module NTP
+    ###
+    # = Overview
+    #
+    # Net::NTP::Check checks NTP offset against several NTP servers
+    module Check
+      def self.logger
+        @logger ||= Logger.new(STDOUT).tap do |l|
+          l.level = Logger::INFO
+        end
+      end
+    end
+  end
+end

data/lib/net/ntp/check/offset.rb

@@ -0,0 +1,110 @@
+require 'net/ntp'
+
+module Net
+  module NTP
+    ###
+    # = Overview
+    #
+    # Contains Net::NTP::Check offset checks
+    module Check
+      # Default servers to check against
+      DEFAULT_SERVERS = [
+        '0.pool.ntp.org',
+        '1.pool.ntp.org',
+        '2.pool.ntp.org',
+        '3.pool.ntp.org'
+      ]
+
+      # Default timeout for the NTP requests
+      TIMEOUT = Net::NTP::TIMEOUT
+
+      # Get the time offsets against the given host list with a
+      # bandpass filter applied
+      def self.get_offsets_filtered(hosts = DEFAULT_SERVERS, timeout = TIMEOUT)
+        offsets = []
+        hosts_multiplier = (9.0 / hosts.length).ceil
+        Net::NTP::Check.logger.debug("Hosts given: #{hosts}")
+        Net::NTP::Check.logger.debug("Hosts multiplier: #{hosts_multiplier}")
+        hosts_multiplier.times do
+          offsets.push(get_offsets(hosts, timeout))
+          sleep(0.01) # sleep to keep from getting rate limted
+        end
+        AutoBandPass.filter(offsets.flatten.shuffle[0...9])
+      end
+
+      # Get the time offsets against the given host list
+      def self.get_offsets(hosts = DEFAULT_SERVERS, timeout = TIMEOUT)
+        offsets = []
+
+        Net::NTP::Check.logger.debug("Host list: #{hosts}")
+
+        hosts.each do |host|
+          offsets.push(get_offset(host, timeout))
+        end
+        offsets
+      end
+
+      # Get the time offset against the given host
+      def self.get_offset(host = DEFAULT_SERVERS[0], timeout = TIMEOUT)
+        get_host_data(host, timeout)[0].offset
+      end
+
+      private
+
+      # Do the NTP request and catch exceptions
+      def self.get_host_data(host, timeout = TIMEOUT)
+        t = Net::NTP.get(host, 'ntp', timeout)
+        delay = (t.client_time_receive - t.originate_timestamp) -
+                (t.transmit_timestamp - t.receive_timestamp)
+        msg = "Received NTP data for #{host} with ntp delay of #{delay}"
+        Net::NTP::Check.logger.debug(msg)
+        return t, delay
+      rescue SocketError
+        err_msg = "Unable to resolve #{host}"
+        Net::NTP::Check.logger.debug(err_msg)
+        raise SocketError, err_msg
+      rescue NoMethodError, Timeout::Error
+        # need to catch NoMethodError pending bug fix
+        # https://github.com/zencoder/net-ntp/pull/9
+        err_msg = "Connection timed out to #{host}"
+        Net::NTP::Check.logger.debug(err_msg)
+        raise Timeout::Error, err_msg
+      end
+
+      # The filtering works like this:
+      # This assumes you are passing in a 9 length Array. Other lengths
+      # may work, but YMMV. This then gets the average of the middle three
+      # of the sorted Array. Using this average, and an arbitrary range
+      # (+/- 200ms), we delete any values outside of that range. This
+      # effectively is a lazy-man's band-pass filter.
+      class AutoBandPass
+        FILTER_RANGE = 0.2
+
+        def self.filter(values)
+          v = values.sort
+          Net::NTP::Check.logger.debug("AutoBandPass values: #{v}")
+          middle = values.length / 2.0
+          middle.ceil unless values.length % 2
+          avg = average(v[(middle - 1).floor..(middle + 1).floor])
+          Net::NTP::Check.logger.debug("AutoBandPass mid values avg: #{avg}")
+          v = apply_band(v, avg)
+          Net::NTP::Check.logger.debug("AutoBandPass values with filter: #{v}")
+          average(v)
+        end
+
+        def self.apply_band(values, average)
+          values.dup.each do |o|
+            upper_bound = (average + FILTER_RANGE)
+            lower_bound = (average - FILTER_RANGE)
+            values.delete(o) if o < lower_bound || o > upper_bound
+          end
+          values
+        end
+
+        def self.average(values)
+          values.reduce { |a, e| a + e } / values.length.to_f
+        end
+      end
+    end
+  end
+end

data/lib/net/ntp/check/statsd.rb

@@ -0,0 +1,68 @@
+require 'statsd'
+require 'net/ntp/check/offset'
+
+module Net
+  module NTP
+    module Check
+      ###
+      # = Overview
+      #
+      # Sends Net::NTP::Check offset data to statsd
+      class StatsdClient
+        DEFAULT_STATSD_HOST = 'localhost'
+        DEFAULT_STATSD_PORT = 8125
+        DEFAULT_STATSD_GAUGE_BASE = 'net.ntp.check'
+        DEFAULT_TIMEOUT = 5
+
+        def initialize(opts = {})
+          @stats = {}
+          @statsd_host = opts.fetch(:statsd_host, DEFAULT_STATSD_HOST)
+          @statsd_port = opts.fetch(:statsd_port, DEFAULT_STATSD_PORT)
+          @statsd_gauge_base = opts.fetch(:statsd_gauge_base,
+                                          DEFAULT_STATSD_GAUGE_BASE)
+          @ntp_timeout = opts.fetch(:ntp_timeout, DEFAULT_TIMEOUT)
+          @ntp_hosts = opts.fetch(:ntp_hosts,
+                                  Net::NTP::Check::DEFAULT_SERVERS)
+          @statsd = Statsd.new(@statsd_host, @statsd_port)
+        end
+
+        def send_offset_stats
+          err_code = 0
+          offset_stats!
+          @statsd.gauge("#{@statsd_gauge_base}.offset_s",
+                        @stats[:offset])
+          @statsd.gauge("#{@statsd_gauge_base}.offset_ms",
+                        @stats[:offset_in_ms])
+
+          rescue SocketError => e
+            err_code = 3
+
+          rescue Timeout::Error => e
+            err_code = 2
+
+          rescue StandardError => e
+            err_code = 1
+          ensure
+            @statsd.gauge("#{@statsd_gauge_base}.err", err_code)
+            warn 'Problem running Net::NTP::Check::StatsdClient stats '\
+              "gathering: #{e.message} (error code #{err_code})" unless
+              err_code == 0
+            warn e.backtrace.join("\n") if err_code == 1
+            exit err_code unless err_code == 0
+        end
+
+        private
+
+        def offset_stats!
+          stats_data_filtered = Net::NTP::Check.get_offsets_filtered(
+            @ntp_hosts, @ntp_timeout)
+          msg = "stats_data_filtered: #{stats_data_filtered}"
+          Net::NTP::Check.logger.debug(msg)
+          @stats[:offset] = stats_data_filtered
+          @stats[:offset_in_ms] = @stats[:offset] * 1000
+          Net::NTP::Check.logger.debug("stats: #{@stats}")
+        end
+      end
+    end
+  end
+end

data/lib/net/ntp/check/version.rb

@@ -0,0 +1,11 @@
+module Net
+  module NTP
+    ###
+    # = Overview
+    #
+    # Contains Net::NTP::Check version number
+    module Check
+      VERSION = '0.0.1'
+    end
+  end
+end

data/net-ntp-check.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'net/ntp/check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'net-ntp-check'
+  spec.version       = Net::NTP::Check::VERSION
+  spec.authors       = ['Grant Ridder']
+  spec.email         = ['shortdudey123@gmail.com']
+  spec.summary       = 'NTP offset check'
+  spec.description   = 'Checks NTP offset against several NTP servers and allows pushing of offset stats via statsd'
+  spec.license       = 'MIT'
+  spec.homepage      = ''
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'net-ntp'
+  spec.add_dependency 'statsd-ruby'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'coveralls'
+end

data/spec/offset_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'Net::NTP::Check' do
+  let(:result) { Net::NTP::Check.get_offsets_filtered }
+
+  it 'should throw an exception if the connection times out' do
+    expect { Net::NTP::Check.get_offset('www.google.com', 1) }.to raise_error
+  end
+
+  it 'should throw an exception if the hostname can not be resolved' do
+    expect { Net::NTP::Check.get_offset('nosuchhost') }.to raise_error
+  end
+
+  it 'should get_offsets_filtered to return a float' do
+    expect(result).to be_a Float
+  end
+
+  context 'AutoBandPass' do
+    it 'should return the correct values with an even number of values' do
+      values = (1..9).to_a
+      filter_results = Net::NTP::Check::AutoBandPass.filter(values)
+      expect(filter_results).to eq(5.0)
+    end
+    it 'should return the correct values with an odd number of values' do
+      values = (1..10).to_a
+      filter_results = Net::NTP::Check::AutoBandPass.filter(values)
+      expect(filter_results).to eq(6.0)
+    end
+
+    it 'should return the correct values with unevenly spaced input' do
+      values = [0.15, 0.2, 0.3, 0.4, 0.49, 0.6, 0.7, 0.8, 0.95]
+      filter_results = Net::NTP::Check::AutoBandPass.filter(values)
+      expect(filter_results).to eq(0.4475)
+    end
+
+    it 'should not return the middle value for unevenly spaced numbers' do
+      values = [0.15, 0.2, 0.3, 0.4, 0.49, 0.6, 0.7, 0.8, 0.95]
+      filter_results = Net::NTP::Check::AutoBandPass.filter(values)
+      expect(filter_results).to_not eq(0.49)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'net/ntp/check'

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: net-ntp-check
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Grant Ridder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ntp
+  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: statsd-ruby
+  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: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rubocop
+  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: pry
+  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: coveralls
+  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: Checks NTP offset against several NTP servers and allows pushing of offset
+  stats via statsd
+email:
+- shortdudey123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/net/ntp/check.rb
+- lib/net/ntp/check/offset.rb
+- lib/net/ntp/check/statsd.rb
+- lib/net/ntp/check/version.rb
+- net-ntp-check.gemspec
+- spec/offset_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: NTP offset check
+test_files:
+- spec/offset_spec.rb
+- spec/spec_helper.rb