dashing-contrib 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eab4a59c857c67b6d79aefc2502baec1ab80ca73
-  data.tar.gz: ee8b277d23c16dcddd73f4ddd6106b50b519aa0b
+  metadata.gz: 3f910eb445f25ea5ea1ba28bc77a4197224879a0
+  data.tar.gz: c90b294dcf58caa1b61a40dd9a497f2dc584891c
 SHA512:
-  metadata.gz: 509bfdaa5f9f6b4d57ab77c98709fd5a74c8cb20662f3a001aea8cc5f58185191d818128e48539920ee39d1e222310d26e0f0d8bd1566f9b711bca31a8be402f
-  data.tar.gz: 4b5f89720b9a04f3423b1054a2219515baf748e59ac48d0ae0f83e9fd8b2ccbcd239d45c1e054f09062bfec3b960c340bdbdb408e6a90dd5eb74ebb584bda39b
+  metadata.gz: c9512cfb5954f4cc079e9df977d776544b4cb8af78043eb8860f51bc4183ff6495b4704a627934ea4d173bd5bf182881012b376b201fbe2dddbc7fd5b91b37e6
+  data.tar.gz: 7739802b0ac7fb6adaf9e23bfd0a50ff127ef418e02d391cc7c89b029a0fef212eae1f9096a04dbb9f7c7097975a7dbed7518787e67a9af52e07906bd0b119ca

data/.gitignore

@@ -17,4 +17,5 @@ test/version_tmp
 tmp
 .DS_Store
 .rakeTasks
-*.iml
+*.iml
+history.yml

data/README.md

@@ -3,21 +3,23 @@
 [![Build Status](https://travis-ci.org/QubitProducts/dashing-contrib.svg?branch=master)](https://travis-ci.org/QubitProducts/dashing-contrib)
 
 
-This project is an extension to Shopify's Dashing. It aims to solve a couple of problems:
-
- * Extend the Dashing's widgets functionality in a healthy pattern
- * Embrace sharing, reusing, testing common jobs data manipulation functionality
- * A common way to load external configuration via dotenv
- * Central place keeping track of extension updates, commits and contributions from multiple sources
+This project is an extension to Shopify's Dashing. Including this rubygem you will be able to:
+
+ * Use all the built-in widgets
+ * Extend `DashingContrib::RunnableJob` module to define, test jobs
+ * Built-in jobs are only a couple of lines implementation, no repetitive copy and paste
+ * Existing secret parameters is automatically loaded from `.env` file
+ * All jobs have a final state (ok, warning, critical)
+ * Additional Rest API to get overall state summary
  
-Read each individual widget documentation to use dashing-contrib built-in widgets in this project after the installation steps.
+Read each individual widget documentation to use dashing-contrib built-in widgets after the installation steps.
 
 ## Installation
 Add this line to your Dashing's dashboard Gemfile:
 
-    gem 'dashing-contrib', '~> 0.0.4'
+    gem 'dashing-contrib', '~> 0.1.0'
 
-And then execute:
+Update dependencies:
 
     $ bundle
 
@@ -28,19 +30,28 @@ Add the following on top of the `config.ru`
     require 'dashing'
     DashingContrib.configure
     
-Add these lines to `assets/javascripts/application.coffee`
+Include built-in CoffeeScript to `assets/javascripts/application.coffee`
 
     #=require dashing-contrib/assets/widgets
 
-Add these lines to `assets/stylesheets/application.scss`
+Include built-in SCSS to `assets/stylesheets/application.scss`
 
     //=require dashing-contrib/assets/widgets
 
-## Job Parameters
+Now you will be able to use the following widgets, click to see individual documentation:
+
+ * [Rickshawgraph](https://github.com/QubitProducts/dashing-contrib/tree/master/lib/dashing-contrib/assets/widgets/rickshawgraph)
+ * [Sidekiq](https://github.com/QubitProducts/dashing-contrib/tree/master/lib/dashing-contrib/assets/widgets/sidekiq)
+ * [Pingdom Uptime](https://github.com/QubitProducts/dashing-contrib/tree/master/lib/dashing-contrib/assets/widgets/pingdom_uptime)
+ * [Kue Status](https://github.com/QubitProducts/dashing-contrib/tree/master/lib/dashing-contrib/assets/widgets/kue_status)
+ * [Nagios List](https://github.com/QubitProducts/dashing-contrib/tree/master/lib/dashing-contrib/assets/widgets/nagios_list)
+ * Dashing State
+
+## dotenv
 
 Shared job parameters are managed by `dotenv` gem. Add a `.env` file in your dashing project root. dashing-contrib will load your configuration from `.env` file automatically. An example `.env` file:
 
-````
+```ruby
 NAGIOS_ENDPOINT: http://example.com/nagios3/cgi-bin
 NAGIOS_USERNAME: dasher
 NAGIOS_PASSWORD: readonly
@@ -48,34 +59,79 @@ NAGIOS_PASSWORD: readonly
 PINGDOM_USERNAME: ping
 PINGDOM_PASSWORD: pong
 PINGDOM_API_KEY: pingpongpingpong
-````
+```
 
 These values can be accessed in jobs `ENV['NAGIOS_ENDPOINT']`
 
-## Widgets Doc
 
- * [Rickshawgraph](https://github.com/QubitProducts/dashing-contrib/tree/master/lib/dashing-contrib/assets/widgets/rickshawgraph) made by [jwalton](https://github.com/jwalton)
- * [Sidekiq](https://github.com/QubitProducts/dashing-contrib/tree/master/lib/dashing-contrib/assets/widgets/sidekiq) made by [pallan](https://github.com/pallan)
- * [Pingdom Uptime](https://github.com/QubitProducts/dashing-contrib/tree/master/lib/dashing-contrib/assets/widgets/pingdom_uptime) inspired by [Edools](https://github.com/Edools/dashing-pingdom)
- * [Kue Status](https://github.com/QubitProducts/dashing-contrib/tree/master/lib/dashing-contrib/assets/widgets/kue_status)
-
-## Job Helpers Doc
+## Job Definition
 
- TODO:
-
-## How to contribute
+dashing-contrib gem provides a standard job definition wrapper. This replaces the 'SCHEDULE.every' call:
 
-There are a couple of ways to contribute. Brining those widgets scattered in github, in multiple format into this repository. They usually falling into the following categories:
-
-#### Widgets
+ * defines common data processing and testable/reusable modules
+ * in addition to dashing's default 'updatedAt', introduced an optional `state` information used across all widgets
+ 
 
-Common widgets should be generic solution to a common requirements. e.g. line graph, better clock with common functionalities. Documentation should be written as a README.md file under widget's own directory, include a preview.png file in the widget folder.
+A custom job declaration example:
+
+```ruby
+module MyCustomJob
+  # provides some dashing hooks 
+  extend DashingContrib::RunnableJob
+  
+  # Overrides to extract some data for display
+  # generated hash will be available for widget to access
+  def self.metrics(options)
+    { metrics: { failed: 500, ok: 123013 } }
+  end
+  
+  # By default this always returns OK state
+  # You can customize the state return value by lookup generated metrics and user provided options 
+  def self.validate_state(metrics, options = {})
+    # `metrics` parameter is the value return by `metrics` method
+    failed_value = metrics[:metrics][:failed]
+    
+    return DashingContrib::RunnableJob::OK if failed_value == 0
+    return DashingContrib::RunnableJob::WARNING if failed_value <= 100
+    DashingContrib::RunnableJob::CRITICAL
+  end
+end
+```
+
+When using job:
+```ruby
+# make sure MyCustomJob module is required
+# default interval is every 30s and job is executed once at start
+MyCustomJob.run(event: 'custom-job-event', every: '20s')
+
+# Custom job also has a block syntax if you are setting up some global settings
+MyCustomJob.run(event: 'custom-job-event') do
+  # setup redis client etc
+end
+
+# metrics and validate_state method will be able to use `my_custom_param` and `custom_threshold`
+# to make configurable metrics fetch and state validation
+MyCustomJob.run(event: 'custom-job-event', my_custom_param: 123, custom_threshold: 3)
+```
+
+
+Take a look some build-in jobs as example:
+
+ * [dashing-contrib/jobs/sidekiq.rb](https://github.com/QubitProducts/dashing-contrib/blob/master/lib/dashing-contrib/jobs/sidekiq.rb)
+ * [dashing-contrib/jobs/kue.rb](https://github.com/QubitProducts/dashing-contrib/blob/master/lib/dashing-contrib/jobs/kue.rb)
+ * [dashing-contrib/jobs/nagios_list.rb](https://github.com/QubitProducts/dashing-contrib/blob/master/lib/dashing-contrib/jobs/nagios_list.rb)
+ * [dashing-contrib/jobs/pingdom_uptime.rb](https://github.com/QubitProducts/dashing-contrib/blob/master/lib/dashing-contrib/jobs/pingdom_uptime.rb)
+ * [dashing-contrib/jobs/dashing-state.rb](https://github.com/QubitProducts/dashing-contrib/blob/master/lib/dashing-contrib/jobs/dashing-state.rb)
+ 
+This is nice that backend data fetching can be now unit tested and reused. Dashing widget view layer can reuse the same job processor and present data in multiple forms. 
 
-#### Jobs utils
 
-Common Job data processing for graphing purpose.
 
-#### Fix and add test
+## How to contribute
 
-Test data processing Ruby modules.
+There are a couple of ways to contribute. Brining those widgets scattered in github, in multiple format into this repository. They usually falling into the following categories:
 
+ * Widgets, common widgets should be generic solution to a common requirements. e.g. line graph, better clock with common functionalities. Documentation should be written as a README.md file under widget's own directory, include a preview.png file in the widget folder.
+ * Jobs utils, common Job data processing for graphing purpose 
+ * Fix and add test
+ * Improve documentation

data/dashing-contrib.gemspec

@@ -25,7 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'time_diff', '~> 0.3.0'
   spec.add_dependency 'sidekiq', '~> 3.0.0'
   spec.add_dependency 'activesupport', '~> 4.1.1'
-  spec.add_dependency 'sinatra'
+  spec.add_dependency 'sinatra', '~> 1.4.4'
+  spec.add_dependency 'dashing', '~> 1.3.4'
+  spec.add_dependency 'nagiosharder'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

data/lib/dashing-contrib.rb

@@ -1,9 +1,19 @@
 require 'active_support/all'
 require 'dashing-contrib/version'
+
+# configuration helpers
 require 'dashing-contrib/configuration'
+
+# history module and overall states management
 require 'dashing-contrib/history'
-require 'dashing-contrib/routes'
+require 'dashing-contrib/bottles/dashing'
 require 'dashing-contrib/bottles/time'
+
+# additional routes
+require 'dashing-contrib/routes'
+
+# contrib job extension
+require 'dashing-contrib/runnable_job'
 require 'dotenv'
 
 

data/lib/dashing-contrib/assets/widgets.scss

@@ -1,3 +1,33 @@
 //=require_tree ./javascripts
 //=require_tree ./widgets
-//=require      ./stylesheets/font-awesome/scss/font-awesome
+//=require      ./stylesheets/font-awesome/scss/font-awesome
+
+
+.dashing-contrib {
+  height: 100%;
+  width: 100%;
+  background-color: #2a2a2a;
+  font-size: 20px;
+  color: white;
+
+  .title {
+    font-size: 25px;
+    padding: 5px 10px;
+    color: white;
+  }
+  &.state-ok {
+    .title {
+      background-color: #272727;
+    }
+  }
+  &.state-warning {
+    .title {
+      background-color: #F7CE1B;
+    }
+  }
+  &.state-critical {
+    .title {
+      background-color: #C32026;
+    }
+  }
+}

data/lib/dashing-contrib/assets/widgets/dashing_state/dashing_state.coffee

@@ -0,0 +1,11 @@
+class Dashing.DashingState extends Dashing.Widget
+  @accessor 'items', ->
+    items = []
+    for key, item of @detailed_status
+      items = items.concat(item)
+
+    return items
+
+
+
+

data/lib/dashing-contrib/assets/widgets/dashing_state/dashing_state.html

@@ -0,0 +1,24 @@
+<div data-bind-class="state | prepend 'dashing-contrib state-'">
+    <div class="basic-stats">
+        <div class="stats-item ok">
+            <div data-bind="ok"></div>
+            <div class="stats-title">OK</div>
+        </div>
+
+        <div class="stats-item warning">
+            <div data-bind="warning"></div>
+            <div class="stats-title">WARNING</div>
+        </div>
+
+        <div class="stats-item critical">
+            <div data-bind="critical"></div>
+            <div class="stats-title">CRITICAL</div>
+        </div>
+
+    </div>
+    <ul>
+        <li data-foreach-item="items" data-bind-class="item.state | prepend 'item-state-'">
+            <span data-bind="item.title"></span>
+        </li>
+    </ul>
+</div>

data/lib/dashing-contrib/assets/widgets/dashing_state/dashing_state.scss

@@ -0,0 +1,48 @@
+.widget.widget-dashing-state {
+
+  .dashing-contrib {
+    &.state-warning {
+      background: rgba(247,206,27,0.5);
+    }
+    &.state-ok {
+      background: rgba(154,202,60,0.7);
+    }
+    &.state-critical {
+      background: rgba(195,32,38, 0.6);
+    }
+  }
+  .basic-stats {
+
+    font-size: 160px;
+    text-align: center;
+
+    .stats-item {
+      padding: 50px;
+      display: inline-block;
+    }
+    .stats-title {
+      font-size: 40px;
+    }
+  }
+
+  ul {
+    padding: 10px 200px;
+    li {
+      display: inline-block;
+      padding: 10px 10px;
+      margin: 10px;
+      font-size: 25px;
+      &.item-state-ok {
+        background: rgba(154,202,60,1);
+      }
+      &.item-state-warning {
+        background: rgba(247,206,27,1);
+      }
+      &.item-state-critical {
+        background: rgba(195,32,38, 1);
+      }
+      border-radius: 10px;
+    }
+  }
+
+}

data/lib/dashing-contrib/assets/widgets/kue_status/kue_status.html

@@ -1,10 +1,12 @@
-<h1 class="title" data-bind="title"></h1>
+<div data-bind-class="state | prepend 'dashing-contrib state-'">
+    <h1 class="title" data-bind="title"></h1>
 
-<ul>
-    <li data-foreach-metric="metrics">
-        <span class="label" data-bind="metric.label"></span>
-        <span class="value" data-bind="metric.value"></span>
-    </li>
-</ul>
+    <ul>
+        <li data-foreach-metric="metrics">
+            <span data-bind-class="metric.label | prepend 'label '" class="label" data-bind="metric.label"></span>
+            <span class="value" data-bind="metric.value"></span>
+        </li>
+    </ul>
 
-<p class="updated-at" data-bind="updatedAtMessage"></p>
+    <p class="updated-at" data-bind="updatedAtMessage"></p>
+</div>

data/lib/dashing-contrib/assets/widgets/kue_status/kue_status.scss

@@ -2,17 +2,19 @@
   &.widget-kue-status {
     background: #f0f0f0;
     color: #636466;
-  }
 
-  ul {
-    margin: 0 15px;
-    text-align: left;
-    font-size: 22px;
+    ul {
+      margin: 0 15px;
+      text-align: left;
+      font-size: 22px;
 
-    li {
-      .value {
-        float: right;
+      li {
+        padding: 6px 0px;
+        .value {
+          float: right;
+        }
       }
     }
+
   }
 }

data/lib/dashing-contrib/assets/widgets/nagios_list/nagios_list.coffee

@@ -0,0 +1,49 @@
+class Dashing.NagiosList extends Dashing.Widget
+  @accessor 'hasCritical', ->
+    if (@get('critical').length > 0) then true else false
+  @accessor 'hasWarning', ->
+    if (@get('warning').length > 0) then true else false
+
+  @accessor 'criticalMap', ->
+    @_groupBy(@get('critical'))
+
+  @accessor 'warningMap', ->
+    @_groupBy(@get('warning'))
+
+  @accessor 'okMap', ->
+    @_groupBy(@get('ok'))
+
+  ready: ->
+    node = $(@node)
+    style = 'overflow': 'hidden'
+    node.parent().css(style)
+
+  clear: ->
+
+
+  _groupBy: (items) ->
+    maps = {}
+    for item, index in items
+      item.last_check = @_parseTime(item.last_check)
+      if !maps[item.host]
+        maps[item.host] = [item]
+      else
+        maps[item.host] = maps[item.host].concat item
+
+    results = []
+    for key, item of maps
+      node = host: key, checks: item
+      results = results.concat node
+
+    return results
+
+  _parseTime: (timestamp) ->
+    time = new Date(timestamp)
+    return "#{@_toTwoDigits(time.getHours())}:#{@_toTwoDigits(time.getMinutes())}"
+
+  _toTwoDigits: (val) ->
+    val = val + ''
+    if val.length == 1
+      return "0#{val}"
+
+    return val

data/lib/dashing-contrib/assets/widgets/nagios_list/nagios_list.html

@@ -0,0 +1,37 @@
+<h1 class="title" data-bind="title" data-showif="title"></h1>
+
+<ul class="critical-list" data-showif="hasCritical">
+    <li data-foreach-item="criticalMap">
+        <span class="host-title" data-bind="item.host"></span>
+        <div class="checks-list">
+            <div class="check-item" data-foreach-check="item.checks">
+                <span class="check-item-name" data-bind="check.service"></span>
+                <span class="check-item-timestamp" data-bind="check.last_check"></span>
+            </div>
+        </div>
+    </li>
+</ul>
+
+<ul class="warning-list" data-showif="hasWarning">
+    <li data-foreach-item="warningMap">
+        <span class="host-title" data-bind="item.host"></span>
+        <div class="checks-list">
+            <div class="check-item" data-foreach-check="item.checks">
+                <span class="check-item-name" data-bind="check.service"></span>
+                <span class="check-item-timestamp" data-bind="check.last_check"></span>
+            </div>
+        </div>
+    </li>
+</ul>
+
+<ul class="ok-list" >
+    <li data-foreach-item="okMap">
+        <span class="host-title" data-bind="item.host"></span>
+        <div class="checks-list">
+            <div class="check-item" data-foreach-check="item.checks">
+                <span class="check-item-name" data-bind="check.service"></span>
+                <span class="check-item-timestamp" data-bind="check.last_check"></span>
+            </div>
+        </div>
+    </li>
+</ul>