dashing-contrib 0.0.5 → 0.1.0

data/lib/dashing-contrib/jobs/pingdom_uptime.rb

@@ -0,0 +1,58 @@
+require 'dashing-contrib/bottles/pingdom'
+
+module DashingContrib
+  module Jobs
+    module PingdomUptime
+      extend DashingContrib::RunnableJob
+
+      def self.metrics(options)
+        client = DashingContrib::Pingdom::Client.new(
+          username: options[:username],
+          password: options[:password],
+          api_key:  options[:api_key]
+        )
+
+        user_opt = self.default_date_ranges.merge(options)
+
+        id = user_opt[:check_id]
+        current_uptime = client.uptime(id, user_opt[:default_date_range], user_opt[:now])
+        first_uptime   = client.uptime(id, user_opt[:first_date_range], user_opt[:now])
+        second_uptime  = client.uptime(id, user_opt[:second_date_range], user_opt[:now])
+        status   = client.checks(id)
+
+        # returns this dataset
+        {
+          current: current_uptime.to_s,
+          first:  first_uptime.to_s,
+          first_title: user_opt[:first_title],
+          second: second_uptime.to_s,
+          second_title: user_opt[:second_title],
+          is_up: status[:check][:status] == 'up',
+          current_response_time: status[:check][:lastresponsetime],
+          last_downtime: ::DashingContrib::Time.readable_diff(::Time.at(status[:check][:lasterrortime]))
+        }
+      end
+
+      def self.validate_state(metrics, options = {})
+        return DashingContrib::RunnableJob::OK if metrics[:is_up]
+        DashingContrib::RunnableJob::CRITICAL
+      end
+
+      private
+      # a default date ranges to use for uptime metrics
+      def self.default_date_ranges
+        now_time = ::Time.now.to_i
+        t24_hours  = 86400
+        t1_month   = t24_hours * 4
+        {
+          now: now_time,
+          default_date_range: now_time - t24_hours,
+          first_title: '4 Months',
+          first_date_range: now_time - (t1_month * 4),
+          second_title: 'YTD',
+          second_date_range: now_time - (t1_month * 12)
+        }
+      end
+    end
+  end
+end

data/lib/dashing-contrib/jobs/sidekiq.rb

@@ -0,0 +1,32 @@
+require 'sidekiq/api'
+module DashingContrib
+  module Jobs
+    module Sidekiq
+      extend DashingContrib::RunnableJob
+
+      def self.metrics(options)
+        stats = ::Sidekiq::Stats.new
+        metrics = [
+            { label: 'Processed', value: stats.processed },
+            { label: 'Failed',    value: stats.failed },
+            { label: 'Retries',   value: stats.retry_size },
+            { label: 'Dead',      value: stats.dead_size },
+            { label: 'Enqueued',  value: stats.enqueued }
+        ]
+        { metrics: metrics }
+      end
+
+      def self.validate_state(metrics, options = {})
+        default = { failed_warning_at: 100, failed_critical_at: 1000 }
+        user_options = default.merge(options)
+
+        failed_stats = metrics[:metrics].select { |v| v[:label] == 'Failed' }.first
+
+        value = failed_stats[:value]
+        return DashingContrib::RunnableJob::OK if value < user_options[:failed_warning_at]
+        return DashingContrib::RunnableJob::WARNING if value >= user_options[:failed_warning_at] && value < user_options[:failed_critical_at]
+        DashingContrib::RunnableJob::CRITICAL
+      end
+    end
+  end
+end

data/lib/dashing-contrib/routes.rb

@@ -11,4 +11,11 @@ get '/views/:widget?.html' do
     contrib_file = File.join(__dir__, 'assets', 'widgets', widget_name, file_name)
     return engines.first.new(contrib_file).render if File.exist? contrib_file
   end
+end
+
+get '/api/states' do
+  protected!
+  content_type :json
+
+  DashingContrib::Dashing.states.to_json
 end

data/lib/dashing-contrib/runnable_job.rb

@@ -0,0 +1,88 @@
+# Creates a overall framework to define a reusable job.
+#
+# A custom job module can extend `RunnableJob` and overrides `metrics` and `validate_state`
+module DashingContrib
+  module RunnableJob
+
+    extend self
+    WARNING  = 'warning'.freeze
+    CRITICAL = 'critical'.freeze
+    OK       = 'ok'.freeze
+
+    class Context
+
+      def initialize(interval, rufus_opts, event_name, user_options, this_module)
+        @interval = interval
+        @rufus_opts = rufus_opts
+        @event_name = event_name
+        @user_options = user_options
+        @this_module = this_module
+      end
+
+      def schedule!
+        _scheduler.every @interval, @rufus_opts do
+          current_metrics = @this_module.metrics(@user_options)
+          current_state   = @this_module.validate_state(current_metrics, @user_options)
+          # including title and state
+          additional_info = { state: current_state }
+          additional_info[:title] = @user_options[:title] if @user_options[:title]
+          send_event(@event_name, current_metrics.merge(additional_info))
+        end
+      end
+
+      private
+      def _scheduler
+        SCHEDULER
+      end
+    end
+
+    def run(options = {}, &block)
+
+      user_options = _merge_options(options)
+      interval     = user_options.delete(:every)
+      rufus_opt = {
+        first_in: user_options[:first_in]
+      }
+
+      event_name   = user_options.delete(:event)
+      block.call if block_given?
+      Context.new(interval, rufus_opt, event_name, user_options, self).schedule!
+    end
+
+    # Overrides this method to fetch and generate metrics
+    # Return value should be the final metrics to be used in the user interface
+    # Arguments:
+    #   options :: options provided by caller in `run` method
+    def metrics(options)
+      {}
+    end
+
+    # Always return a common state, override this with your custom logic
+    # Common states are WARNING, CRITICAL, OK
+    # Arguments:
+    #   metrics :: calculated metrics provided `metrics` method
+    #   user_options :: hash provided by user options
+    def validate_state(metrics, user_options)
+      OK
+    end
+
+    private
+    def _merge_options(options)
+      raise ':event String is required to identify a job name' if options[:event].nil?
+      _default_scheduler_options.merge(options)
+    end
+
+    def _default_scheduler_options
+      {
+        every: '30s',
+        first_in: 0
+      }
+    end
+  end
+end
+
+# dotenv doesn't seem to be loaded in dashing job
+unless defined?(Dotenv)
+  require 'dotenv'
+  Dotenv.load
+end

data/lib/dashing-contrib/version.rb

@@ -1,3 +1,3 @@
 module DashingContrib
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/spec/jobs/sidekiq_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module DashingContrib
+  describe Jobs::Sidekiq do
+    describe '#validate_state' do
+      let(:metrics) { { metrics: [{ label: 'Failed', value: failed_value }] } }
+
+      context 'when failed is below warning' do
+        let(:failed_value) { 12 }
+        it { expect(Jobs::Sidekiq.validate_state(metrics, {})).to eq(DashingContrib::RunnableJob::OK) }
+      end
+
+      context 'when failed count is at warning level' do
+        let(:failed_value) { 133 }
+        it { expect(Jobs::Sidekiq.validate_state(metrics, {})).to eq(DashingContrib::RunnableJob::WARNING) }
+      end
+
+      context 'when failed count is above critical' do
+        let(:failed_value) { 20123 }
+        it { expect(Jobs::Sidekiq.validate_state(metrics, {})).to eq(DashingContrib::RunnableJob::CRITICAL) }
+      end
+    end
+  end
+end
+

data/spec/runnable_job_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe DashingContrib::RunnableJob do
+
+  describe 'Common States' do
+    it { expect(DashingContrib::RunnableJob::WARNING).to eq 'warning' }
+    it { expect(DashingContrib::RunnableJob::CRITICAL).to eq 'critical' }
+    it { expect(DashingContrib::RunnableJob::OK).to eq 'ok' }
+  end
+
+  describe '#run' do
+    context 'when event name is not provided' do
+      it { expect { DashingContrib::RunnableJob.run }.to raise_exception(':event String is required to identify a job name') }
+    end
+
+    context 'when event name is provided' do
+      let(:event_name) { 'test-event' }
+      after(:each) { DashingContrib::RunnableJob.run(event: event_name) }
+      it { expect(SCHEDULER).to receive(:every).with('30s', { first_in: 0 }) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'dashing-contrib'
+require 'dashing'
 
 RSpec.configure do |config|
   config.order = :random

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dashing-contrib
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Jing Dong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -110,6 +110,34 @@ dependencies:
         version: 4.1.1
 - !ruby/object:Gem::Dependency
   name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: dashing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+- !ruby/object:Gem::Dependency
+  name: nagiosharder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -183,11 +211,17 @@ files:
 - lib/dashing-contrib/assets/stylesheets/font-awesome/scss/font-awesome.scss
 - lib/dashing-contrib/assets/widgets.coffee
 - lib/dashing-contrib/assets/widgets.scss
+- lib/dashing-contrib/assets/widgets/dashing_state/dashing_state.coffee
+- lib/dashing-contrib/assets/widgets/dashing_state/dashing_state.html
+- lib/dashing-contrib/assets/widgets/dashing_state/dashing_state.scss
 - lib/dashing-contrib/assets/widgets/kue_status/README.md
 - lib/dashing-contrib/assets/widgets/kue_status/kue_status.coffee
 - lib/dashing-contrib/assets/widgets/kue_status/kue_status.html
 - lib/dashing-contrib/assets/widgets/kue_status/kue_status.scss
 - lib/dashing-contrib/assets/widgets/kue_status/preview.png
+- lib/dashing-contrib/assets/widgets/nagios_list/nagios_list.coffee
+- lib/dashing-contrib/assets/widgets/nagios_list/nagios_list.html
+- lib/dashing-contrib/assets/widgets/nagios_list/nagios_list.scss
 - lib/dashing-contrib/assets/widgets/pingdom_uptime/README.md
 - lib/dashing-contrib/assets/widgets/pingdom_uptime/pingdom_uptime.coffee
 - lib/dashing-contrib/assets/widgets/pingdom_uptime/pingdom_uptime.html
@@ -202,10 +236,12 @@ files:
 - lib/dashing-contrib/assets/widgets/sidekiq/sidekiq.coffee
 - lib/dashing-contrib/assets/widgets/sidekiq/sidekiq.html
 - lib/dashing-contrib/assets/widgets/sidekiq/sidekiq.scss
+- lib/dashing-contrib/bottles/dashing.rb
 - lib/dashing-contrib/bottles/kue.rb
 - lib/dashing-contrib/bottles/kue/client.rb
 - lib/dashing-contrib/bottles/nagios.rb
 - lib/dashing-contrib/bottles/nagios/client.rb
+- lib/dashing-contrib/bottles/nagios/status.rb
 - lib/dashing-contrib/bottles/pingdom.rb
 - lib/dashing-contrib/bottles/pingdom/checks.rb
 - lib/dashing-contrib/bottles/pingdom/client.rb
@@ -214,9 +250,17 @@ files:
 - lib/dashing-contrib/bottles/time.rb
 - lib/dashing-contrib/configuration.rb
 - lib/dashing-contrib/history.rb
+- lib/dashing-contrib/jobs/dashing-state.rb
+- lib/dashing-contrib/jobs/kue.rb
+- lib/dashing-contrib/jobs/nagios_list.rb
+- lib/dashing-contrib/jobs/pingdom_uptime.rb
+- lib/dashing-contrib/jobs/sidekiq.rb
 - lib/dashing-contrib/routes.rb
+- lib/dashing-contrib/runnable_job.rb
 - lib/dashing-contrib/version.rb
 - spec/bottles/kue/client_spec.rb
+- spec/jobs/sidekiq_spec.rb
+- spec/runnable_job_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/QubitProducts/dashing-contrib
 licenses:
@@ -245,4 +289,6 @@ summary: An extension to Dashing that makes easier to maintaining, sharing widge
   and test common tasks
 test_files:
 - spec/bottles/kue/client_spec.rb
+- spec/jobs/sidekiq_spec.rb
+- spec/runnable_job_spec.rb
 - spec/spec_helper.rb