internet_box_logger 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 574855b609060db1351ee2c495899f6e02d0250c
-  data.tar.gz: b728d0a189e66aaaac27539c486cb624922ecb71
+  metadata.gz: 392bfee54def08775eba49ee699e8ca6be2c1c15
+  data.tar.gz: b8f847eff5ec8a64b41513847a1c9b2cced20937
 SHA512:
-  metadata.gz: 1da791238fbde65f9149cd5fa38d7dc1663b331d1d6abf14f2f5ac3c2436da7fd153a725a40f61be6b65501a4ae921ae26dc68f42ef86af97c1bf67b9906ad33
-  data.tar.gz: 761dd388490129d650e73d30489d16261e428155b61f0a7fc1c287473b461b9936cbeac2aff4ef876e6efb26066fc277ba8a718ee27800a28053b9c9cec99df0
+  metadata.gz: 30beb6ae14b11d89cabff73936e33d293f4d62a9358b6b3d1094f34a959904f55815ff5eb1a2d6647334dd084d5a6fe158382cab8b5b94a0e1985510eaad7774
+  data.tar.gz: df1da0de0bc8cf0e426e2f0681d611031b848c58862122fec4e7b24d990db14870bae2f326eebec30623044934ea3f52f3d7802acbc6eb8c2e2a772a830701da

data/README.md

@@ -6,6 +6,9 @@
 ## Overview
 
 The goal of this [gem][IBL] is to provide an easy way to monitor your internet box status.
+The idea is to gather as much data as you can about your box, and regularly store the metrics into an ElasticSearch
+server/cluster in order to provide a Kibana dashboard on top to visualize the metrics.
+
 It primarily targets the box I am using (the Freebox V5 from the '[Free]' french ISP).
 
 Currently supported box:
@@ -222,14 +225,17 @@ Basically, to contribute you may want to:
 The contract is pretty simple. Create a module to gather your box's data into the InternetBoxLogger::Parsers namespace
 (module). This module should implement two methods:
 
-* `get_box_data` that returns a hash of key-value pairs representing the data you  monitor from your box. The way you
+* `get_box_data` that returns a hash of key-value pairs representing the data you want to monitor from your box. The way you
  get these is not important. In the case of the Freebox V5 the sole possibility is to parse a page returned by the
  box itself and than contains a lot of metrics. But maybe your box provides a more sophisticated API, REST or
  whatever.
-* `as_es_documents` should return an array of documents in the ElasticSearch way of thinking. This should the
- transformation of the data returned by `get_box_data`, organised as an array of documents. This way you can organize
+* `as_es_documents` should return an array of documents (hashes) in the ElasticSearch way of thinking. This should be the
+ transformation of the data returned by `get_box_data`, and organised as an array of documents. This way you can organize
  your data in a way that will allow you to query this data from Kibana to build your dashboards.
 
+Then you have to specify this new parser in the configuration file using the `box_type` property (see the default value
+ in the upper part of this help to see how to do it).
+
 ### Tests
 
 You should upgrade the test set to cover what you added.

data/bin/internet_box_logger

@@ -8,13 +8,14 @@ require 'tasks/internet_box_logger_tasks'
 module InternetBoxLogger
   class Script
     include EasyAppHelper
-
+    include InternetBoxLogger::Tasks
     APP_NAME = 'The Internet Box Logger'
     DESCRIPTION = 'This application will log your Internet box metrics into ElasticSearch.'
 
     def initialize
       # Providing this data is optional but brings better logging and online help
       config.describes_application(app_name: APP_NAME, app_version: InternetBoxLogger::VERSION, app_description: DESCRIPTION)
+      config.script_filename = "#{ibl_gem_path}/config/internet_box_logger.conf"
     end
 
     def run
@@ -29,7 +30,6 @@ module InternetBoxLogger
           raise msg
         end
         if config[:deploy_reports]
-          self.extend InternetBoxLogger::Tasks
           self.extend InternetBoxLogger::Tasks::Kibana
           kibana_info
           deploy_reports
@@ -37,25 +37,21 @@ module InternetBoxLogger
         end
 
         if config[:cron_setup]
-          self.extend InternetBoxLogger::Tasks
           self.extend InternetBoxLogger::Tasks::Cron
           cron_setup
           exit 0
         end
         if config[:cron_remove]
-          self.extend InternetBoxLogger::Tasks
           self.extend InternetBoxLogger::Tasks::Cron
           cron_remove
           exit 0
         end
         if config[:es_start]
-          self.extend InternetBoxLogger::Tasks
           self.extend InternetBoxLogger::Tasks::ElasticSearch
           start_es_server
           exit 0
         end
         if config[:es_stop]
-          self.extend InternetBoxLogger::Tasks
           self.extend InternetBoxLogger::Tasks::ElasticSearch
           stop_es_server
           exit 0
@@ -63,7 +59,6 @@ module InternetBoxLogger
 
 
         if config[:serve]
-          self.extend InternetBoxLogger::Tasks
           self.extend InternetBoxLogger::Tasks::Kibana
           kibana_info
           serve_ui

data/lib/internet_box_logger/version.rb

@@ -1,3 +1,3 @@
 module InternetBoxLogger
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: internet_box_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Laurent B
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-10 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler