influxdb-lineprotocol-writer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 173c0c4ce86d9a6f831304467ba84a729c8095e7
-  data.tar.gz: 641825007e147abd3989e3ccdd66fab8a7c2a65d
+  metadata.gz: a2307f068a4620a1b356e831401a146b86181b0a
+  data.tar.gz: 46145262953662339106ba706239c0029ee3c6e8
 SHA512:
-  metadata.gz: 0d68b6bc00e556e4353265be592ce5eca44b7f60d53600a99ba1936b4db5fcf8f6309ed30d94d9df1015b9a1ec23fa8eee2a7427ffee2be6c26358af60928d1f
-  data.tar.gz: 2c9320c58376f649ef42f7c1ea87ea54a07867e99578fe9092ca48aa57d02694b75b97153436b3474c24cf13d377cd30d5c34f8ed9bbf9d3924c52362a4fbc8a
+  metadata.gz: 222af5f8370017815d43eb23a07fa6d13b49f5f4831e62cf9eb0ead20ed4738277ff49a044f13c9b4a49b5e31970b7e5f71b036c59055407858f487ba5914242
+  data.tar.gz: f2a9c4063ec8ae03cc0758150c7bad1df9da637ae065111fcbd4edd3da7b4833011a3ef0aadd5a4fda3b81c3cbb82321ebe5afe4bf4653960b343df268d41932

data/.gitignore

@@ -1,6 +1,7 @@
 *.gem
 *.rbc
 *.swp
+*.log
 .config
 coverage/
 InstalledFiles

data/Gemfile.lock

@@ -1,18 +1,26 @@
 PATH
   remote: .
   specs:
-    influxdb-lineprotocol-writer (0.1.0)
-      excon (>= 0.45.3)
+    influxdb-lineprotocol-writer (0.2.0)
+      excon (~> 0.45, >= 0.45.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
     excon (0.45.3)
+    json (1.8.3)
+    mixlib-cli (1.5.0)
+    net-ping (1.7.7)
     rake (10.1.0)
+    sensu-plugin (1.1.0)
+      json
+      mixlib-cli (>= 1.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   influxdb-lineprotocol-writer!
+  net-ping
   rake
+  sensu-plugin (~> 1.1, >= 1.1.0)

data/README.md

@@ -1,2 +1,46 @@
 # influxdb-lineprotocol-writer-ruby
 A Ruby Library for Writing to InfluxDB v0.9+ using the new Line Protocol (https://github.com/influxdb/influxdb/pull/2696)
+
+*This is alpha-quality code*
+
+Currently supports all param options made available except SSL b/c I'm too lazy to test that at this time.
+
+Likewise, this sorts the keys and fields to further hopefully make this the fastest writer currently out there (sorting is strongly recommended in the referenced PR).
+
+If you fork this and make it better, I'll review, merge, increment version, and push an updated gem in a reasonable timeframe.
+
+Default URI params are documented in lib/influxdb-lineprotocol-writer-ruby/core.rb in the class initializer. 
+
+## Install
+
+```shell
+$ 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
+```

data/examples/influxdb_event_handler.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'influxdb-lineprotocol-writer/sensu-metric-handler'
+
+class InfluxDBHandler < ::InfluxDB::LineProtocolWriter::Metric::Handler
+
+  def filter; end
+
+  def handle
+    metrics, output = split_metrics_from_output
+
+    begin
+      settings = settings['influxdb']
+    rescue
+      settings = {}
+    end
+    settings['host'] ||= '10.0.1.159'
+    settings['user'] ||= 'admin'
+    settings['pass'] ||= 'admin'
+    settings['db']   ||= 'graphite'
+
+    hostname, instance_id = @event['client']['name'].split('--')
+    write_metrics metrics, settings do |metric|
+      metric['tags']['source'] = hostname
+      metric['tags']['instance_id'] = instance_id unless instance_id.nil?
+    end
+
+    puts output
+
+  end
+end
+

data/examples/sensu-metric-check.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require 'influxdb-lineprotocol-writer/sensu-metric-check'
+require 'net/ping'
+
+class PingMetric < InfluxDB::LineProtocolWriter::Metric::CLI
+  option :host,
+         short: '-h host',
+         default: 'localhost'
+
+  option :timeout,
+         short: '-T timeout',
+         proc: proc(&:to_i),
+         default: 5
+
+  option :count,
+         short: '-c count',
+         description: 'The number of ping requests',
+         proc: proc(&:to_i),
+         default: 1
+
+  option :interval,
+         short: '-i interval',
+         description: 'The number of seconds to wait between ping requests',
+         proc: proc(&:to_f),
+         default: 1
+
+  option :'measurement-name',
+         short: '-m measurement_name',
+         description: 'An alternate name for the metric',
+         proc: proc(&:to_s),
+         default: 'ping'
+
+  def run
+    result_arr = []
+    pt = Net::Ping::External.new(config[:host], nil, config[:timeout])
+    config[:count].times do |i|
+      sleep(config[:interval]) unless i == 0
+      unless pt.ping?
+        warning "Failed to ping #{config[:host]}"
+      else
+        result_arr << pt.duration
+      end
+    end
+    duration = result_arr.inject{ |sum, el| sum + el }.to_f / result_arr.size
+    begin
+      output measurement: config[:'measurement-name'],
+             tags: { host: config[:host] },
+             fields: { value: duration }
+    rescue InfluxDB::LineProtocolWriter::OptionError => e
+      warning e.message
+    rescue Exception => e
+      critical e.message
+    end
+    ok "Ping check of #{config[:host]} Successful"
+  end
+end

data/examples/sensu-test.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+while true; do 
+  bundle exec ./sensu-metric-check.rb -h $1 -c 1 |\
+  bundle exec ./sensu_event_generator.rb |\
+  bundle exec ./influxdb_event_handler.rb
+  sleep 1
+done

data/examples/sensu_event.json

@@ -0,0 +1,28 @@
+{
+  "action": "create",
+  "occurrences": 1,
+  "client": {
+    "name": "vpc-test-server--i-424242",
+    "address": "8.8.8.8",
+    "subscriptions": [
+      "production",
+      "webserver",
+      "mysql"
+    ],
+    "timestamp": 1326390159
+  },
+  "check":{
+    "name": "frontend_http_check",
+    "issued": 1326390169,
+    "subscribers":[
+      "frontend"
+    ],
+    "interval": 60,
+    "status": 2,
+    "handler": "influxdb",
+    "history": [
+      "0",
+      "2"
+    ]
+  }
+}

data/examples/sensu_event_generator.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'json'
+
+check_output = ARGF.read
+
+event_json_base = JSON.parse(File.read('sensu_event.json'))
+event_json_base["output"] = check_output.to_s
+event_json_base["command"] = "test.rb -c 1"
+
+puts JSON.pretty_generate(event_json_base)
+

data/examples/test.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'influxdb-lineprotocol-writer'
+require 'benchmark'
+
+
+Benchmark.bm(7) do |x|
+  client = InfluxDB::LineProtocolWriter::Core.new host: '10.0.1.159', db: 'graphite', user: 'admin', pass: 'admin'
+  client.debug = true
+  x.report(__LINE__) { client.connect }
+  
+  x.report(__LINE__) { client.add_metric 'test', {test: 'test', test2: 'test2', a: 'val'}, {value: 1.0}, 'ms'}
+  x.report(__LINE__) { client.add_metric 'test', {z: 'val2', test: 'test', test2: 'test2'}, {value: 2.0}}
+  x.report(__LINE__) { client.add_metric 'test', {z: 'val2', test: 'test', test2: 'test2'}, {value: 2.0}}
+  x.report(__LINE__) { client.add_metric 'test', {test: 'test', test2: 'test2'}, {value: 3.0}}
+  x.report(__LINE__) { client.add_metric 'test', nil, {value: 3.0}}
+  x.report(__LINE__) { client.add_metric 'test3', nil, {value: 3.0, test: 'string', deploy: 'v2.0'}}
+  x.report(__LINE__) { client.add_metric 'test3', nil, {value: 3.0, test: 'string', deploy: 'v2.1'}, 'ms', 1434077536000}
+  
+#  x.report(__LINE__) { puts client.metrics}
+  
+  x.report(__LINE__) { client.write}
+end

data/influxdb-lineprotocol-writer.gemspec

@@ -26,6 +26,8 @@ EOF
   s.required_ruby_version = '>= 2.0.0'
   s.homepage    = 'https://github.com/randywallace/influxdb-lineprotocol-writer-ruby'
 
-  s.add_runtime_dependency 'excon', '>= 0.45.3'
+  s.add_runtime_dependency 'excon', '~> 0.45', '>= 0.45.3'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'sensu-plugin', '~> 1.1', '>= 1.1.0'
+  s.add_development_dependency 'net-ping'
 end

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

@@ -2,20 +2,62 @@ require 'excon'
 
 module InfluxDB
   module LineProtocolWriter
+    module Util
+      def build_metric(measurement, tags, fields, precision='ms', timestamp=nil)
+        raise OptionError, 'measurement does not implement to_s' unless measurement.respond_to? :to_s
+        raise OptionError, 'fields does not implement to_h' unless fields.respond_to? :to_h
+        raise OptionError, 'precision does not implement to_s' unless precision.respond_to? :to_s
+        timestamp = get_now_timestamp(precision.to_s) unless timestamp
+        working = measurement.to_s
+        if tags.respond_to?(:to_h) && !tags.to_h.empty?
+          working += ',' + tags.sort.map{|k,v|"#{k.to_s}=#{v.to_s}"}.join(",")
+        end
+        working += ' '
+        working += fields.sort.map{|k,v|"#{k.to_s}=#{if v.is_a?(String);'"'+v+'"';else;v;end}"}.join(",")
+        working += " #{timestamp}"
+      end
+      def check_precision(val)
+        if %[n u ms s m h].include?(val.to_s)
+          true
+        else
+          false
+        end
+      end
+      def get_now_timestamp precision='ms'
+        check_precision precision
+        case precision
+        when 'n'
+          raise NotSupportedError, 'Nanosecond resolution not currently supported.  Pass timestamp in manually'
+        when 'u'
+          raise NotSupportedError, 'Microsecond resolution not currently supported.  Pass timestamp in manually'
+        when 'ms'
+          ( Time.now.to_f * 1000 ).to_i
+        when 's'
+          Time.now.to_i
+        when 'm'
+          ( Time.now.to_i / 60 ).to_i
+        when 'h'
+          ( Time.now.to_i / 3600 ).to_i
+        end
+      end
+    end
     class Core
+      include Util
+
       attr_reader :host, :port, :user, :pass, :ssl, :db, :precision, :consistency, :retentionPolicy, :debug
+
       def initialize(opts={})
         # set the defaults
-        opts      = {host: 'localhost',
-                     port: '8086',
-                     user: 'root',
-                     pass: 'root',
-                     ssl: false,
-                     db: 'influxdb',
-                     precision: 'ms',
-                     consistency: 'one',
-                     retentionPolicy: 'default',
-                     debug: false}.merge(opts)
+        opts = {host: 'localhost',
+                port: '8086',
+                user: 'root',
+                pass: 'root',
+                ssl: false,
+                db: 'influxdb',
+                precision: 'ms',
+                consistency: 'one',
+                retentionPolicy: 'default',
+                debug: false}.merge(opts)
         self.host = opts[:host]
         self.port = opts[:port]
         self.user = opts[:user]
@@ -33,17 +75,12 @@ module InfluxDB
         @conn = Excon.new(get_uri, debug: debug)
       end
 
-      def add_metric(measurement, tags, fields, timestamp=get_now_timestamp)
-        working = measurement.to_s
-        working += ',' + tags.sort.map{|k,v|"#{k.to_s}=#{v.to_s}"}.join(",") if tags.is_a?(Hash)
-        working += ' '
-        working += fields.sort.map{|k,v|"#{k.to_s}=#{if v.is_a?(String);'"'+v+'"';else;v;end}"}.join(",")
-        working += " #{timestamp}"
-        puts "Adding #{working}"
-        @metrics << working
+      def add_metric(*args)
+        @metrics << build_metric(*args)
       end
 
       def write
+        puts "Writing to InfluxDB at #{get_uri} with params #{get_query_hash} and metrics:\n#{metrics}"
         @conn.request( expects: [204],
                        method:  :post,
                        headers: get_headers,
@@ -65,7 +102,19 @@ module InfluxDB
       end
 
       def metrics
-        @metrics.join("\n")
+        if @metrics.respond_to? :to_a
+          @metrics.join("\n")
+        else
+          @metrics
+        end
+      end
+
+      def metrics= val
+        if val.respond_to?(:to_a) or val.respond_to?(:to_s)
+          @metrics = val
+        else
+          raise OptionError, 'Metrics must implement #to_a or #to_s'
+        end
       end
 
       def host= val
@@ -100,8 +149,9 @@ module InfluxDB
         @retentionPolicy = val
       end
 
+
       def precision= val
-        if %[n u ms s m h].include?(val.to_s)
+        if check_precision val
           @precision = val.to_s
         else
           raise OptionError, 'Precision must be one of (n, u, ms, s, m, h)'
@@ -133,7 +183,7 @@ module InfluxDB
       end
 
       def get_uri
-        if self.ssl
+        if ssl
           uri = "https://"
         else
           uri = "http://"
@@ -144,24 +194,6 @@ module InfluxDB
       def get_headers
         { 'Content-Type' => 'plain/text' }
       end
-
-      def get_now_timestamp
-        case precision
-        when 'n'
-          raise NotSupportedError, 'Nanosecond resolution not currently supported.  Pass timestamp in manually'
-        when 'u'
-          raise NotSupportedError, 'Microsecond resolution not currently supported.  Pass timestamp in manually'
-        when 'ms'
-          ( Time.now.to_f * 1000 ).to_i
-        when 's'
-          Time.now.to_i
-        when 'm'
-          ( Time.now.to_i / 60 ).to_i
-        when 'h'
-          ( Time.now.to_i / 3600 ).to_i
-        end
-      end
-
     end
   end
 end

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

@@ -0,0 +1,30 @@
+require 'influxdb-lineprotocol-writer'
+require 'sensu-plugin/cli'
+require 'json'
+
+module InfluxDB
+  module LineProtocolWriter
+    class Metric
+      class CLI < Sensu::Plugin::CLI
+        include InfluxDB::LineProtocolWriter::Util
+        def output opts=''
+          if opts.respond_to? :to_h
+
+            opts[:measurement] ||= File.basename($0, ".*")
+            opts[:tags]        ||= {}
+            opts[:precision]   ||= 'ms'
+            opts[:timestamp]   ||= get_now_timestamp(opts[:precision])
+
+            if !opts.key?(:fields) || !opts[:fields].respond_to?(:to_h) || opts[:fields].to_h.keys.length == 0
+              raise OptionError, "At least one field is required.  For example: { fields: { key: value } }"
+            end
+
+            puts opts.to_json
+          else
+            puts opts.to_s
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require 'influxdb-lineprotocol-writer'
+require 'sensu-handler'
+require 'json'
+
+module InfluxDB
+  module LineProtocolWriter
+    class Metric
+      class Handler < Sensu::Handler
+        include ::InfluxDB::LineProtocolWriter::Util
+
+        def split_metrics_from_output
+          metrics = []
+          output = ''
+          @event['output'].each_line do |line|
+            begin
+              metrics << JSON.parse(line.chomp).to_h
+            rescue
+              output += line.chomp + ' '
+            end
+          end
+          return metrics, output
+        end
+
+        def write_metrics(metrics, settings, debug=false)
+          metrics.chunk{ |i| i['precision'] }.each do |precision_group|
+            settings[:precision] = precision_group[0]
+            settings = Hash[settings.map{ |k,v| [k.to_sym, v] } ]
+            settings[:debug] = debug
+            client = Core.new settings
+            client.connect
+            precision_group[1].each do |metric|
+              yield metric if block_given?
+              client.add_metric metric['measurement'],
+                                metric['tags'],
+                                metric['fields'],
+                                metric['precision'],
+                                metric['timestamp']
+            end
+            client.write
+          end
+        end
+
+      end
+    end
+  end
+end

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

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

metadata

@@ -1,19 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-lineprotocol-writer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Randy D. Wallace Jr.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-12 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.45.3
@@ -21,6 +24,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.45.3
@@ -38,6 +44,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: net-ping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   This is a very basic gem that provides a library that, via Excon, reliably
   publishes metrics to InfluxDB 0.9.0rc33+ via the LineProtocol Interface.
@@ -58,13 +98,20 @@ files:
 - README.md
 - Rakefile
 - bin/influxdb-lineprotocol-writer
+- examples/influxdb_event_handler.rb
+- examples/sensu-metric-check.rb
+- examples/sensu-test.sh
+- examples/sensu_event.json
+- examples/sensu_event_generator.rb
+- examples/test.rb
 - influxdb-lineprotocol-writer.gemspec
 - lib/influxdb-lineprotocol-writer.rb
 - lib/influxdb-lineprotocol-writer/cli.rb
 - lib/influxdb-lineprotocol-writer/core.rb
 - lib/influxdb-lineprotocol-writer/exceptions.rb
+- lib/influxdb-lineprotocol-writer/sensu-metric-check.rb
+- lib/influxdb-lineprotocol-writer/sensu-metric-handler.rb
 - lib/influxdb-lineprotocol-writer/version.rb
-- oneoff/test.rb
 homepage: https://github.com/randywallace/influxdb-lineprotocol-writer-ruby
 licenses:
 - MIT

data/oneoff/test.rb

@@ -1,20 +0,0 @@
-require 'influxdb-lineprotocol-writer'
-
-
-client = InfluxDB::LineProtocolWriter::Core.new host: '10.0.1.159', db: 'graphite', user: 'admin', pass: 'admin'
-client.debug = true
-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