influxdb-lineprotocol-writer 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2307f068a4620a1b356e831401a146b86181b0a
-  data.tar.gz: 46145262953662339106ba706239c0029ee3c6e8
+  metadata.gz: 2a6bd82a5bc5351981041f25ce0d1a874dbe147e
+  data.tar.gz: f5c51246e047119578f8f8b8e09b1f903c091e4f
 SHA512:
-  metadata.gz: 222af5f8370017815d43eb23a07fa6d13b49f5f4831e62cf9eb0ead20ed4738277ff49a044f13c9b4a49b5e31970b7e5f71b036c59055407858f487ba5914242
-  data.tar.gz: f2a9c4063ec8ae03cc0758150c7bad1df9da637ae065111fcbd4edd3da7b4833011a3ef0aadd5a4fda3b81c3cbb82321ebe5afe4bf4653960b343df268d41932
+  metadata.gz: 232be04dbc631056180ad87355a779c86a5a7b78f61b443b7c73718bbb2519f0d9f473ffa56e5619f6f1d91f3932a209732dfa6b646005dcd049ad4e71c882ac
+  data.tar.gz: ed4907e75587a960fb6fbd9f12b5d45bbf30a315a48300892640e2caa5ee43e1232293450d3553b7b767a0b152055190137b73bae17a41e673674a1f439e24f5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    influxdb-lineprotocol-writer (0.2.0)
+    influxdb-lineprotocol-writer (0.2.1)
       excon (~> 0.45, >= 0.45.3)
 
 GEM

data/README.md

@@ -19,28 +19,4 @@ $ gem install influxdb-lineprotocol-writer
 
 ## Usage
 
-```ruby
-require 'influxdb-lineprotocol-writer'
-
-
-client = InfluxDB::LineProtocolWriter::Core.new host: '<host/IP>', 
-                                                  db: '<DB>', 
-                                                user: '<USER>', 
-                                                pass: '<PASS>'
-client.debug = true # Enable debug Excon output
-client.connect
-
-client.add_metric 'test', {test: 'test', test2: 'test2', a: 'val'}, {value: 1.0}
-sleep 0.1
-client.add_metric 'test', {z: 'val2', test: 'test', test2: 'test2'}, {value: 2.0}
-sleep 0.1
-client.add_metric 'test', {z: 'val2', test: 'test', test2: 'test2'}, {value: 2.0}
-client.add_metric 'test', {test: 'test', test2: 'test2'}, {value: 3.0}
-sleep 0.1
-client.add_metric 'test', nil, {value: 3.0}
-client.add_metric 'test3', nil, {value: 3.0, test: 'string', deploy: 'v2.0'}
-sleep 0.1
-client.add_metric 'test3', nil, {value: 3.0, test: 'string', deploy: 'v2.1'}, 1434077536000
-
-client.write
-```
+Files in the `examples` demonstrate usage both as a regular library and as a [Sensu](http://sensuapp.org) Check and Handler.

data/examples/influxdb_event_handler.rb

@@ -1,14 +1,40 @@
 #!/usr/bin/env ruby
-
 require 'influxdb-lineprotocol-writer/sensu-metric-handler'
 
 class InfluxDBHandler < ::InfluxDB::LineProtocolWriter::Metric::Handler
 
+  # for this example, which doesn't actually use Sensu, I disabled the filter method below
+  # because this example doesn't have access to the settings hash.
   def filter; end
 
   def handle
+
+    # the sensu metric check helper class (lib/influxdb-lineprotocol-write/sensu-metric-check) 
+    # writes metrics as a JSON Hash, one per line.  If, for whatever reason, a metric does not 
+    # parse correctly from the json gem, it can be caught in the output variable below and 
+    # handled as appropriate.  This should perhaps be handled better by a mutator.
+    #
+    # Example Output as originally printed by the check:
+    # {"measurement": "ping", "tags": {"host": "google.com"}, "fields": {"value": 0.1}}
+    # Ping Metric Check Successful
     metrics, output = split_metrics_from_output
 
+    # This is a hack which would not be used in a production handler
+    #
+    # For a real handler, settings for a specific cluster can
+    # be added to the handler settings as such:
+    # {
+    #   { "influxdb":
+    #       "host": "hostname",
+    #       "user": "username",
+    #       "pass": "password",
+    #       "ssl": boolean,
+    #       "db": "database",
+    #       "consistency": "one",
+    #       "retentionPolicy": "default"
+    #   },
+    #   { handler_specific_settings.. }
+    # }
     begin
       settings = settings['influxdb']
     rescue
@@ -19,12 +45,18 @@ class InfluxDBHandler < ::InfluxDB::LineProtocolWriter::Metric::Handler
     settings['pass'] ||= 'admin'
     settings['db']   ||= 'graphite'
 
+    # We tack the AWS Instance on the end of a Sensu Client Name for tracking
     hostname, instance_id = @event['client']['name'].split('--')
+
+    # The write_metrics method in the gem can do all the heavy lifting, not
+    # to mention add tags at the handler level based on data added by Sensu
+    # to the @event hash which could prove useful
     write_metrics metrics, settings do |metric|
       metric['tags']['source'] = hostname
       metric['tags']['instance_id'] = instance_id unless instance_id.nil?
     end
 
+    # This'll end up in the Uchiwa Logs
     puts output
 
   end

data/examples/sensu-metric-check.rb

@@ -3,9 +3,10 @@
 require 'influxdb-lineprotocol-writer/sensu-metric-check'
 require 'net/ping'
 
-class PingMetric < InfluxDB::LineProtocolWriter::Metric::CLI
+class PingMetric < ::InfluxDB::LineProtocolWriter::Metric::CLI
   option :host,
          short: '-h host',
+         proc: proc(&:to_s),
          default: 'localhost'
 
   option :timeout,

data/lib/influxdb-lineprotocol-writer/sensu-metric-handler.rb

@@ -11,7 +11,7 @@ module InfluxDB
         def split_metrics_from_output
           metrics = []
           output = ''
-          @event['output'].each_line do |line|
+          @event['check']['output'].each_line do |line|
             begin
               metrics << JSON.parse(line.chomp).to_h
             rescue

data/lib/influxdb-lineprotocol-writer/version.rb

@@ -1,5 +1,5 @@
 module InfluxDB
   module LineProtocolWriter
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-lineprotocol-writer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Randy D. Wallace Jr.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-15 00:00:00.000000000 Z
+date: 2015-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon