dashing-contrib 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f910eb445f25ea5ea1ba28bc77a4197224879a0
-  data.tar.gz: c90b294dcf58caa1b61a40dd9a497f2dc584891c
+  metadata.gz: ec500df2f1e3dabe80001d360235bab603642512
+  data.tar.gz: 5f27671229a2809906e0dd522b2767cf4fcd3372
 SHA512:
-  metadata.gz: c9512cfb5954f4cc079e9df977d776544b4cb8af78043eb8860f51bc4183ff6495b4704a627934ea4d173bd5bf182881012b376b201fbe2dddbc7fd5b91b37e6
-  data.tar.gz: 7739802b0ac7fb6adaf9e23bfd0a50ff127ef418e02d391cc7c89b029a0fef212eae1f9096a04dbb9f7c7097975a7dbed7518787e67a9af52e07906bd0b119ca
+  metadata.gz: 6c41b316df3d7f77cac798f53414ca25c49e08ac195c192dd13c9510277703b21bbb4c2f383c320185c166cd98565a57b4f157e7a10fb19def458a0ebc04a7af
+  data.tar.gz: e9ac3b976d43ecc3ea5929e9498c3f8f9dd9e5b128049a5e5740f7948ada8dc17e5f397424178866b64168d999ebe4b8d4bb5fa6e3ec9e8304dd0752bcadc13d

data/README.md

@@ -17,7 +17,7 @@ Read each individual widget documentation to use dashing-contrib built-in widget
 ## Installation
 Add this line to your Dashing's dashboard Gemfile:
 
-    gem 'dashing-contrib', '~> 0.1.0'
+    gem 'dashing-contrib', '~> 0.1.1'
 
 Update dependencies:
 
@@ -40,12 +40,12 @@ Include built-in SCSS to `assets/stylesheets/application.scss`
 
 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
+ * [Rickshawgraph](https://github.com/QubitProducts/dashing-contrib/wiki/Widget:-Rickshawgraph)
+ * [Sidekiq](https://github.com/QubitProducts/dashing-contrib/wiki/Widget:-Sidekiq)
+ * [Pingdom Uptime](https://github.com/QubitProducts/dashing-contrib/wiki/Widget:-Pingdom-Uptime)
+ * [Kue Status](https://github.com/QubitProducts/dashing-contrib/wiki/Widget:-Kue-Status)
+ * [Nagios List](https://github.com/QubitProducts/dashing-contrib/wiki/Widget:-Nagios-List)
+ * Dashing State (global alert if any widget is under critical state)
 
 ## dotenv
 
@@ -126,6 +126,40 @@ Take a look some build-in jobs as example:
 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. 
 
 
+# Widget State
+
+All built-in jobs managed by 'DashingContrib::Runnable' assumes each widget instance has a 'state' under ok, warning or critical. We suggest your custom widget should also follow this convension.
+
+This gem creates an additional REST API, as well as a widget to show a global healthness of the system. This is awesome if you would like to build some physical alert system around it.
+
+`GET http://{dashing_endpoint}/api/states`
+
+```json
+{
+    "ok": 2,
+    "warning": 0,
+    "critical": 0,
+    "detailed_status": {
+      "dashboard": {
+        "state": "ok",
+        "title": "Dashboard",
+        "updated_at": 1403823187
+      },
+      "nagios-list": {
+        "state": "ok",
+        "title": "Nagios Checks",
+        "updated_at": 1403823178
+      }
+    }
+}
+```
+
+# Persistent History
+
+A new REST endpoint allows to force keep a snapshot of current events data and update the history.yml yaml file. 
+
+`Post http://{dashing_endpoint}/api/history/save`
+
 
 ## How to contribute
 

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

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

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

@@ -17,8 +17,8 @@
 
     </div>
     <ul>
-        <li data-foreach-item="items" data-bind-class="item.state | prepend 'item-state-'">
-            <span data-bind="item.title"></span>
+        <li data-foreach-state="widgetStates" data-bind-class="state.state | prepend 'item-state-'">
+            <span data-bind="state.title"></span>
         </li>
     </ul>
 </div>

data/lib/dashing-contrib/history.rb

@@ -8,7 +8,17 @@ module DashingContrib
     def history
       Sinatra::Application.settings.history
     end
-    
+
+    def history_file
+      Sinatra::Application.settings.history_file
+    end
+
+    def save
+      File.open(history_file, 'w') do |f|
+        f.puts history.to_yaml
+      end
+    end
+
     def raw_event(event_name)
       return nil if history[event_name].nil?
       history[event_name].gsub(/^data:/, '')

data/lib/dashing-contrib/routes.rb

@@ -18,4 +18,12 @@ get '/api/states' do
   content_type :json
 
   DashingContrib::Dashing.states.to_json
+end
+
+post '/api/history/save' do
+  protected!
+  content_type :json
+
+  DashingContrib::History.save
+  { message: 'done' }
 end

data/lib/dashing-contrib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dashing-contrib
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jing Dong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2014-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -214,25 +214,18 @@ files:
 - 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
 - lib/dashing-contrib/assets/widgets/pingdom_uptime/pingdom_uptime.scss
-- lib/dashing-contrib/assets/widgets/pingdom_uptime/preview.png
-- lib/dashing-contrib/assets/widgets/rickshawgraph/README.md
 - lib/dashing-contrib/assets/widgets/rickshawgraph/rickshawgraph.coffee
 - lib/dashing-contrib/assets/widgets/rickshawgraph/rickshawgraph.html
 - lib/dashing-contrib/assets/widgets/rickshawgraph/rickshawgraph.scss
-- lib/dashing-contrib/assets/widgets/sidekiq/README.md
-- lib/dashing-contrib/assets/widgets/sidekiq/preview.png
 - lib/dashing-contrib/assets/widgets/sidekiq/sidekiq.coffee
 - lib/dashing-contrib/assets/widgets/sidekiq/sidekiq.html
 - lib/dashing-contrib/assets/widgets/sidekiq/sidekiq.scss

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

@@ -1,41 +0,0 @@
-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/pingdom_uptime/README.md

@@ -1,68 +0,0 @@
-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/rickshawgraph/README.md

@@ -1,86 +0,0 @@
-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/sidekiq/README.md

@@ -1,36 +0,0 @@
-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>
-```
-
-## Job setup
-
-Create a `jobs/sidekiq.rb` in your dashing project.
-
-
-```ruby
-
-# Require a built-in job
-require 'dashing-contrib/jobs/sidekiq'
-
-# Configure the job and setup Sidekiq connection
-# 'event' is your dashing event name
-
-DashingContrib::Jobs::Sidekiq.run every: '10s', event: 'sidekiq-metric-name' do
-  Sidekiq.configure_client do |config|
-    config.redis = { url: 'redis://localhost.com:6379', namespace: 'sidekiq:namespace' }
-  end
-end
-```