bidu-house 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f2691ba3e4a43b932d5ba3770027da4f9c15ce1
-  data.tar.gz: 827b28c6b28b3766a77250a3dec8678c74449044
+  metadata.gz: 61df7ae9ad7055e431d7912230db3f33cd23c672
+  data.tar.gz: 6e2d298063bbd83ffa628bf2da57bb314a468d47
 SHA512:
-  metadata.gz: 1599973e3f184f9e0082a5b7c38971fa55296864d672722fcf4c04fde4984d7e4c99b24af7339b0433a3321462dde3fa595b6a2f8974b84349d23a5891f70203
-  data.tar.gz: c2e980424aa1d6f5bfdd2ae75f59d1b40a074ab1613e53c066e536becea3fba553d4ecb15cb187c1b3cdb240ed21490504ea49cef4c925b6e27966292cfc6ff7
+  metadata.gz: 8fbf8718e925ea3e3d005e5178a940c32ddcbbc76edd3900693221b6144beae7ed9b430b28321f96dcb09f74e302a415b3b77082dca36a80b631bf1c3cbe977b
+  data.tar.gz: 090601be4bbd3711920ea90fcea1853da102bd033b468ccb955ffa3ecd05aaad8d529b5aaa4f5cf11cb5eafdf42392c91d69e2d2b76a65dfcc737864d25b66a2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bidu-house (0.1.1)
+    bidu-house (0.1.2)
       activesupport
       bidu-core_ext
       concern_builder

data/README.md

@@ -1,2 +1,65 @@
-# house
-Health Check Gem
+Bidu House
+==========
+
+This gem tries to make server monitoring easier and more reliable by adding an easly configurable
+report and making it avaliable in a controller
+
+Getting started
+---------------
+1. Add JsonParser to your `Gemfile` and `bundle install`:
+
+    ```ruby
+    gem 'json_parser'
+    ```
+
+
+2. Include in your health check controller passing the configuration to fetch your Documents
+with error and render the report
+
+  ```ruby
+  class HealthCheckController < ApplicationController
+    include Bidu::House
+
+    status_report :failures, clazz: Document
+    status_report :failures, clazz: Schedules, on: :schedules
+    status_report :delays, clazz: Schedules, scope: :late, on: :schedules
+
+    def status
+      render_status
+    end
+
+    def late_status
+      render_status(:schedules)
+    end
+  end
+  ```
+
+3. Add a route to your controller
+
+  ```ruby
+  scope path: 'health-check', controller: :health_check do
+    get '/status' => :status
+    get '/late-status' => :late_status
+  end
+  ```
+
+3. Set the correct options on your status report to achieve a perfect report
+ - clazz: Class of the object that might contain error
+ - scope: scope to be fetched when trying to find objects with error (default: :with_error)
+ - external_key: column to be exposed as id for the objects with error
+ - threshold: default report threshold (default: 0.02)
+ - period: default search period (default: 1 day)
+ - on: report bucket (default: :default)
+
+ 4. Run the server and hit the health-check routes
+
+ ```
+ wget http://localhost:3000/health-check/status
+ wget http://localhost:3000/health-check/late-status
+ ```
+
+5. Customize your request for multiple reports
+ ```
+ wget http://localhost:3000/health-check/status?period=3.days&threshold=0.005
+ wget http://localhost:3000/health-check/late-status?period=1.hours&threshold=0.1
+ ```

data/lib/bidu/house/concern.rb

@@ -2,7 +2,7 @@ module Bidu
   module House
     extend ActiveSupport::Concern
 
-    def render_status(key)
+    def render_status(key = :default)
       status = self.class.status_builder.build(key, params)
       render json: status.as_json, status: status.status
     end

data/lib/bidu/house/version.rb

@@ -1,5 +1,5 @@
 module Bidu
   module House
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bidu-house
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Bidu Dev's Team