dashing-contrib 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73fdff5ceab61ba270c4d3cd0a61ffd069456424
-  data.tar.gz: dd06b0ac3d5ba721f2449ac4f8443e4c62621dca
+  metadata.gz: eab4a59c857c67b6d79aefc2502baec1ab80ca73
+  data.tar.gz: ee8b277d23c16dcddd73f4ddd6106b50b519aa0b
 SHA512:
-  metadata.gz: 2405a4954f3f2514546555c3b1534f89333b808509df72c32253d742eaf6de80382716a9baebe8c68520f9762d2af7030e00557134de2e6ad3577173422a9498
-  data.tar.gz: 7ea49f93c30e524ef75710dddf2ec2486602cfc980efb92c52fee011603d80bf3b1584e4bad26b8c560053aee8af2106438288804fb886c5ba02a601656e4024
+  metadata.gz: 509bfdaa5f9f6b4d57ab77c98709fd5a74c8cb20662f3a001aea8cc5f58185191d818128e48539920ee39d1e222310d26e0f0d8bd1566f9b711bca31a8be402f
+  data.tar.gz: 4b5f89720b9a04f3423b1054a2219515baf748e59ac48d0ae0f83e9fd8b2ccbcd239d45c1e054f09062bfec3b960c340bdbdb408e6a90dd5eb74ebb584bda39b

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+script: "bundle exec rspec"

data/README.md

@@ -1,16 +1,21 @@
-# dashing-contrib
+# dashing-contrib 
 
-This projects is an extension to Shopify's Dashing. It aims to solve a couple of problems:
+[![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
  
+Read each individual widget documentation to use dashing-contrib built-in widgets in this project after the installation steps.
+
 ## Installation
 Add this line to your Dashing's dashboard Gemfile:
 
-    gem 'dashing-contrib', '~> 0.0.2'
+    gem 'dashing-contrib', '~> 0.0.4'
 
 And then execute:
 
@@ -31,9 +36,9 @@ Add these lines to `assets/stylesheets/application.scss`
 
     //=require dashing-contrib/assets/widgets
 
-## Job configurations
+## Job Parameters
 
-Job configurations are managed by `dotenv` gem. Add a `.env` file in your dashing project root. dashing-contrib will load your configuration from `.evn` file automatically. An example:
+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:
 
 ````
 NAGIOS_ENDPOINT: http://example.com/nagios3/cgi-bin
@@ -45,31 +50,32 @@ PINGDOM_PASSWORD: pong
 PINGDOM_API_KEY: pingpongpingpong
 ````
 
-These values can be accessed in jobs `ENV[NAGIOS_ENDPOINT]`
+These values can be accessed in jobs `ENV['NAGIOS_ENDPOINT']`
 
-## Included Widgets
+## Widgets Doc
 
- * [Rickshawgraph](https://gist.github.com/jwalton/7916168) made by [jwalton](https://gist.github.com/jwalton)
- * [Sidekiq](https://gist.github.com/pallan/57f778cace40fd56fb4d) made by [pallan](https://gist.github.com/pallan)
+ * [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)
 
-## Included Job helpers
+## Job Helpers Doc
 
  TODO:
 
 ## How to contribute
 
-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 two categories:
+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
+#### 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 file under widget's own directory.
+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
+#### Jobs utils
 
 Common Job data processing for graphing purpose.
 
+#### Fix and add test
 
-## Components/Widgets made by contributors
+Test data processing Ruby modules.
 
- * [jwalton](https://gist.github.com/jwalton)
- * [pallan](https://gist.github.com/pallan)

data/dashing-contrib.gemspec

@@ -24,5 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'multi_json', '~> 1.10.1'
   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_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

data/lib/dashing-contrib.rb

@@ -1,3 +1,4 @@
+require 'active_support/all'
 require 'dashing-contrib/version'
 require 'dashing-contrib/configuration'
 require 'dashing-contrib/history'
@@ -5,6 +6,7 @@ require 'dashing-contrib/routes'
 require 'dashing-contrib/bottles/time'
 require 'dotenv'
 
+
 module DashingContrib
   class << self
     attr_writer :configuration

data/lib/dashing-contrib/assets/stylesheets/font-awesome/scss/_variables.scss

@@ -1,8 +1,7 @@
 // Variables
 // --------------------------
 
-$fa-font-path:        "../fonts" !default;
-//$fa-font-path:        "//netdna.bootstrapcdn.com/font-awesome/4.1.0/fonts" !default; // for referencing Bootstrap CDN font files directly
+$fa-font-path:        "//netdna.bootstrapcdn.com/font-awesome/4.1.0/fonts" !default; // for referencing Bootstrap CDN font files directly
 $fa-css-prefix:       fa !default;
 $fa-version:          "4.1.0" !default;
 $fa-border-color:     #eee !default;

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

@@ -1,3 +1,3 @@
-//=require_tree ./widgets
 //=require_tree ./javascripts
+//=require_tree ./widgets
 //=require      ./stylesheets/font-awesome/scss/font-awesome

data/lib/dashing-contrib/assets/widgets/kue_status/README.md

@@ -0,0 +1,41 @@
+KueStatus Widget
+=====
+
+![](preview.png)
+
+A widget shows current status of [Kue](https://github.com/learnboost/kue) job queue.
+
+## Usage
+
+Add the widget HTML to your dashboard
+
+```html
+<li data-row="1" data-col="1" data-sizex="1" data-sizey="1">
+    <div data-id="kue-information" data-view="KueStatus" data-title="Kue information"></div>
+</li>
+````
+
+## Job
+
+An example of `jobs/kue_status_job.rb`
+
+```ruby
+# built-in Kue helpers
+require 'dashing-contrib/bottles/kue'
+
+SCHEDULER.every '10s' do
+  # Use .env file in your project to extract endpoint value
+  # if dev and production enviroment are different
+  client = DashingContrib::Kue::Client.new(endpoint: 'http://kue.example.com')
+  stats = client.stats
+
+  metrics = [
+      { label: 'Processed',  value: stats[:complete_count] },
+      { label: 'Processing', value: stats[:active_count] },
+      { label: 'Failed',     value: stats[:failed_count] },
+      { label: 'Queued',     value: stats[:inactive_count] },
+      { label: 'Delayed',     value: stats[:delayed_count] }
+  ]
+  send_event('kue-information', { metrics: metrics } )
+end
+````

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

@@ -0,0 +1 @@
+class Dashing.KueStatus extends Dashing.Widget

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

@@ -0,0 +1,10 @@
+<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>
+
+<p class="updated-at" data-bind="updatedAtMessage"></p>

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

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

data/lib/dashing-contrib/assets/widgets/pingdom_uptime/README.md

@@ -0,0 +1,68 @@
+Pingdom Uptime
+==============
+
+![](preview.png)
+
+
+### Requirement
+
+The smile face requires font-awesome >= 4.1.0. dashing-contrib includes 4.1.0 CSS and load font from CDN. You can safely delete the fonts folder and font-awesome css files in generated dashing asset folder.
+
+### Example html usage
+
+```html
+<li data-row="1" data-col="1" data-sizex="1" data-sizey="1">
+    <div data-view="PingdomUptime"
+         data-id="pingdom-uptime"
+         data-title="Dashboard"></div>
+</li>
+```
+
+
+### Example job
+
+This also shows a coupld of dashing-contrib data APIs for pingdom. 
+
+```ruby
+# Some helper methods for pingdom
+require 'dashing-contrib/bottles/pingdom'
+
+SCHEDULER.every '30s' do
+  nowTime = Time.now.to_i
+  t1_month = 86400 * 30
+
+  # 24 hours
+  defaultDateRange = nowTime - 86400
+  # 4 months ago
+  firstDateRange = nowTime - (t1_month * 4)
+  # 1 year to date
+  secondDateRange = nowTime - (t1_month * 12)
+
+  client = DashingContrib::Pingdom::Client.new(
+    username: ENV['PINGDOM_USERNAME'],
+    password: ENV['PINGDOM_PASSWORD'],
+    api_key:  ENV['PINGDOM_API_KEY']
+  )
+  # checks id provided by pingdom
+  id = '1234432'
+  current_uptime = client.uptime(id, defaultDateRange, nowTime)
+  first_uptime   = client.uptime(id, firstDateRange, nowTime)
+  second_uptime  = client.uptime(id, secondDateRange, nowTime)
+  status   = client.checks(id)
+
+  data = {
+    current: current_uptime.to_s,
+    first:  first_uptime.to_s,
+    first_title: '4 Months',
+    second: second_uptime.to_s,
+    second_title: 'YTD',
+    is_up: status[:check][:status] == 'up',
+    current_response_time: status[:check][:lastresponsetime],
+    last_downtime: ::DashingContrib::Time.readable_diff(::Time.at(status[:check][:lasterrortime]))
+  }
+  
+  send_event("pingdom-uptime", data)
+end
+```
+
+

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

@@ -4,7 +4,7 @@
 $background-color:  #2A2A2A;
 $value-color:       #73AA3A;
 
-$title-color:       #8b8b8b;
+$title-color:       #B2B2B2;
 $moreinfo-color:    rgba(255, 255, 255, 0.7);
 
 // ----------------------------------------------------------------------------

data/lib/dashing-contrib/assets/widgets/rickshawgraph/README.md

@@ -0,0 +1,86 @@
+Graphing Widget
+===============
+
+Documentation initally written by [jwalton](https://gist.github.com/jwalton) from [gist](https://gist.github.com/jwalton/6614023)
+
+dashing-contrib includes this widget by default. If you want view template structured differently, you can create a HTML template in project root `widgets/rickshawgraph/rickshawgraph.html`.
+
+
+The graphing widget shows graphs using the Rickshaw graphing library.  The names of data fields
+should be (vaguely) familiar if you've used Rickshaw before.
+
+dashing-contrib includes [latest rickshaw.js](https://raw.github.com/shutterstock/rickshaw/master/rickshaw.min.js). You can delete generated rickshaw Javascript in dashing project assets folder.
+
+Supported HTML data fields
+--------------------------
+
+* `data-title`: Title to display.
+* `data-displayed-value`: If provided, then the value to display overtop of the graph.  If not
+  provided, then the most recent value will be used if there is only one series.
+* `data-renderer`: Any valid Rickshaw renderer, including 'area', 'line', 'bar', 'scatterplot'.
+* `data-stroke`: If "true", then area graphs will be drawn with a stroke.
+* `data-unstack`: If "true", then area and bar graphs will be "unstacked".
+* `data-colors`: A ":" separated list of colors to use for each plot.  If there are fewer colors
+  provided than there are series to graph, then pleasing colors will be automatically chosen.  (e.g.:
+  `data-colors="#ccc:#ddd:#eee"`)
+* `data-stroke-colors`: A ":" separated list of colors to use for strokes.
+* `data-color-scheme`: One of "rainbow", "near-rainbow", "compliment", "default".  Controls how
+  default colors are assigned.
+* `data-default-alpha`: Alpha for default colors.
+* `data-legend`: If "true", then a legend will be added to your graph.
+* `data-min` and `data-max`: Set the highest and lowest values of the y-axis.
+* `data-summary-method` determines how the value shown in the graph is computed.  If
+  `data-displayed-value` is set, this is ignored.  Otherwise this should be one of:
+  * "last" - Default - If there is only one series, show the most recent value from that series.
+  * "sum" - Sum of all values across all series.
+  * "sumLast" - Sum of last values across all series.
+  * "highest" - For stacked graphs, the highest single data point based on the sum of all series.
+    For unstacked graphs, the highest single data point of any series.
+
+Passing Data
+------------
+
+Data can be provided in a number of formats.  Data can be passed as a series of points:
+
+    points = [{x:1, y: 4}, {x:2, y:27}, {x:3, y:6}]
+    send_event('convergence', points: points)
+
+Note that the `x` values are interpreted as unix timestamps.  Data can also be passed as full-on
+Rickshaw-style series:
+
+    series = [
+        {
+            name: "Convergence",
+            data: [{x:1, y: 4}, {x:2, y:27}, {x:3, y:6}]
+        },
+        {
+            name: "Divergence",
+            data: [{x:1, y: 5}, {x:2, y:2}, {x:3, y:9}]
+        }
+    ]
+    send_event('convergence', series: series)
+
+You can even provide colors and strokes here, which will override the values defined in the HTML.
+Or data can be passed as Graphite-style data:
+
+    graphite = [
+      {
+        target: "stats_counts.http.ok",
+        datapoints: [[10, 1378449600], [40, 1378452000], [53, 1378454400], [63, 1378456800], [27, 1378459200]]
+      },
+      {
+        target: "stats_counts.http.err",
+        datapoints: [[0, 1378449600], [4, 1378452000], [nil, 1378454400], [3, 1378456800], [0, 1378459200]]
+      }
+    ]
+    send_event('http', series: graphite)
+
+You can even send data as JSON strings, straight from Graphite:
+
+    require "rest-client"
+    SCHEDULER.every '10s', :first_in => 0 do
+        target = "aliasSub(summarize(stats_counts.http.*%2C%2720min%27)%2C%27%5E.*http.(%5Cw*).*%27%2C%27%5C1%27)"
+        url = "http://graphteserver.local:8000/render?format=json&target=#{target}&from=today"
+        graphite_json_data = RestClient.get url
+        send_event 'http_counts', { series: graphite_json_data }
+    end

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

@@ -70,11 +70,11 @@ $tick-color:        rgba(0, 0, 0, 0.4);
   .rickshaw_legend {
     position: absolute;
     left: 0px;
-    bottom: 0px;
+    bottom: -3px;
     white-space: nowrap;
     overflow-x: hidden;
     font-size: 15px;
-    height: 20px;
+    height: 30px;
 
     ul {
       margin: 0;
@@ -97,6 +97,7 @@ $tick-color:        rgba(0, 0, 0, 0.4);
     .label {
       display: inline-block;
       margin-left: 5px;
+      font-size: 12px;
     }
   }
 

data/lib/dashing-contrib/assets/widgets/sidekiq/README.md

@@ -0,0 +1,42 @@
+Sidekiq Widget
+===============
+
+Sidekiq widget and documentation is intially developed by [pallan](https://github.com/pallan) with some improvements.
+
+![](preview.png)
+
+
+## Usage
+
+Add the widget HTML to your dashboard
+```html
+    <li data-row="2" data-col="4" data-sizex="2" data-sizey="2">
+      <div data-id="sidekiq" data-view="Sidekiq" data-title="Sidekiq" style=""></div>
+    </li>
+```
+
+## Settings
+
+In `/jobs/sidekiq.rb` you need to configure the connection to your Redis server that backs Sidekiq.
+
+```ruby
+require 'sidekiq/api'
+
+redis_uri = "redis://:#{YOUR_REDIS_PASSWORD}@#{YOUR_REDIS_HOST}:#{YOUR_REDIS_PORT}"
+
+Sidekiq.configure_client do |config|
+  config.redis = { url: redis_uri, namespace: 'myapp:namespace' }
+end
+
+SCHEDULER.every '10s' do
+  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 }
+  ]
+  send_event('sidekiq', { metrics: metrics } )
+end
+```