fluent-plugin-influxdb 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 669c3b535b02de2911b23d4031733d428ae0c2c9
-  data.tar.gz: 281bc8576f08186c507fc0101190df7dcc5e90d1
+  metadata.gz: c18eeb3df6edb6a13fd2c1bfb2297627b8523fd5
+  data.tar.gz: 684d18b8d759cb69474274f1346fff726591667b
 SHA512:
-  metadata.gz: 65dd2cecf483c1ca25a0d57aff6322344785048830970d79cee2572eead29d544a4f98f7b2bb33c2b9a03b94cb96f04cbc1c6fb213aac70526eb1cf62c9f2a38
-  data.tar.gz: e62c1259376e4cf34a21475a1d0187b868a18aa8a69beb13f6bedc314f95ef789b3f14723aff461d5842dec3a33de9301b94dc9d08b7e4c8e18a898c14625ec2
+  metadata.gz: 9479f05a97776e1d6e210212c05bb4e4c741a4362d157cf14007b913ad0bd7857152bca5297ea2f3974c77b118fdb25f1b164a542a308bb1a31b5ebd0df02398
+  data.tar.gz: d801c178625d67e10514679190e43aa4700f83858f34b122c6e8cd871fe4669d1101ed47489bc3dca56e9d799c6b7311717395b2ba41e9a63a35b6dce571990f

data/History.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+0.2.3 (Feb, 27, 2016)
+=====
+
+- Add sequence_tag option
+- Add parameter descriptions
+
 0.2.2 (Nov, 02, 2015)
 =====
 

data/README.md

@@ -39,6 +39,8 @@ Just like other regular output plugins, Use type `influxdb` in your fluentd conf
 
 `tag_keys`: The names of the keys to use as influxDB tags.
 
+`sequence_tag`: The name of the tag whose value is incremented for the consecutive simultaneous events and reset to zero for a new event with the different timestamp
+
 ### Fluentd Tag and InfluxDB Series
 
 influxdb plugin uses Fluentd event tag for InfluxDB series.
@@ -57,6 +59,7 @@ So if you have events with `app.event`, influxdb plugin inserts events into `app
   use_ssl false
   time_precision s
   tag_keys ["key1", "key2"]
+  sequence_tag _seq
 </match>
 ```
 

data/fluent-plugin-influxdb.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name          = "fluent-plugin-influxdb"
-  s.version       = '0.2.2'
+  s.version       = '0.2.3'
   s.authors       = ["Masahiro Nakagawa", "FangLi"]
   s.email         = ["repeatedly@gmail.com", "surivlee@gmail.com"]
   s.description   = %q{InfluxDB output plugin for Fluentd}

data/lib/fluent/plugin/out_influxdb.rb

@@ -7,18 +7,40 @@ class Fluent::InfluxdbOutput < Fluent::BufferedOutput
 
   include Fluent::HandleTagNameMixin
 
-  config_param :host, :string,  :default => 'localhost'
-  config_param :port, :integer,  :default => 8086
-  config_param :dbname, :string,  :default => 'fluentd'
-  config_param :user, :string,  :default => 'root'
-  config_param :password, :string,  :default => 'root', :secret => true
-  config_param :time_precision, :string, :default => 's'
-  config_param :use_ssl, :bool, :default => false
-  config_param :tag_keys, :array, :default => []
+  config_param :host, :string,  :default => 'localhost',
+               :desc => "The IP or domain of influxDB."
+  config_param :port, :integer,  :default => 8086,
+               :desc => "The HTTP port of influxDB."
+  config_param :dbname, :string,  :default => 'fluentd',
+               :desc => <<-DESC
+The database name of influxDB.
+You should create the database and grant permissions at first.
+DESC
+  config_param :user, :string,  :default => 'root',
+               :desc => "The DB user of influxDB, should be created manually."
+  config_param :password, :string,  :default => 'root', :secret => true,
+               :desc => "The password of the user."
+  config_param :time_precision, :string, :default => 's',
+               :desc => <<-DESC
+The time precision of timestamp.
+You should specify either hour (h), minutes (m), second (s),
+millisecond (ms), microsecond (u), or nanosecond (n).
+DESC
+  config_param :use_ssl, :bool, :default => false,
+               :desc => "Use SSL when connecting to influxDB."
+  config_param :tag_keys, :array, :default => [],
+               :desc => "The names of the keys to use as influxDB tags."
+  config_param :sequence_tag, :string, :default => nil,
+               :desc => <<-DESC
+The name of the tag whose value is incremented for the consecutive simultaneous
+events and reset to zero for a new event with the different timestamp.
+DESC
 
 
   def initialize
     super
+    @seq = 0
+    @prev_timestamp = nil
   end
 
   def configure(conf)
@@ -54,15 +76,36 @@ class Fluent::InfluxdbOutput < Fluent::BufferedOutput
   def write(chunk)
     points = []
     chunk.msgpack_each do |tag, time, record|
-      point = {}
-      point[:timestamp] = record.delete('time') || time
-      point[:series] = tag
+      timestamp = record.delete('time') || time
       if tag_keys.empty?
-        point[:values] = record
+        values = record
+        tags = {}
       else
-        point[:tags] = record.select{|k,v| @tag_keys.include?(k)}
-        point[:values] = record.select{|k,v| !@tag_keys.include?(k)}
+        values = {}
+        tags = {}
+        record.each_pair do |k, v|
+          if @tag_keys.include?(k)
+            tags[k] = v
+          else
+            values[k] = v
+          end
+        end
       end
+      if @sequence_tag
+        if @prev_timestamp == timestamp
+          @seq += 1
+        else
+          @seq = 0
+        end
+        tags[@sequence_tag] = @seq
+        @prev_timestamp = timestamp
+      end
+      point = {
+        :timestamp => timestamp,
+        :series    => tag,
+        :values    => values,
+        :tags      => tags,
+      }
       points << point
     end
 

data/test/plugin/test_out_influxdb.rb

@@ -1,5 +1,18 @@
 require 'helper'
+
 class InfluxdbOutputTest < Test::Unit::TestCase
+  class DummyInfluxDBClient
+    attr_reader :points
+
+    def initialize
+      @points = []
+    end
+
+    def write_points(points)
+      @points += points
+    end
+  end
+
   def setup
     Fluent::Test.setup
   end
@@ -21,8 +34,10 @@ class InfluxdbOutputTest < Test::Unit::TestCase
 
   def create_driver(conf=CONFIG, tag='test')
     Fluent::Test::BufferedOutputTestDriver.new(Fluent::InfluxdbOutput, tag) do
-      def write(chunk)
-        chunk.read
+      attr_reader :influxdb
+      def configure(conf)
+        super
+        @influxdb = DummyInfluxDBClient.new()
       end
     end.configure(conf)
   end
@@ -60,7 +75,71 @@ class InfluxdbOutputTest < Test::Unit::TestCase
 
     data = driver.run
 
-    assert_equal(['input.influxdb', time, {'a' => 1}].to_msgpack +
-                 ['input.influxdb', time, {'a' => 2}].to_msgpack, data)
+    assert_equal([
+      {
+        :timestamp => time,
+        :series    => 'input.influxdb',
+        :values    => {'a' => 1},
+        :tags      => {},
+      },
+      {
+        :timestamp => time,
+        :series    => 'input.influxdb',
+        :values    => {'a' => 2},
+        :tags      => {},
+      }
+    ], driver.instance.influxdb.points)
+
+  end
+
+  def test_seq
+    config = %[
+      type influxdb
+      host  localhost
+      port  8086
+      dbname test
+      user  testuser
+      password  mypwd
+      use_ssl false
+      time_precision s 
+      sequence_tag _seq
+    ]
+    driver = create_driver(config, 'input.influxdb')
+
+    time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    driver.emit({'a' => 1}, time)
+    driver.emit({'a' => 2}, time)
+
+    driver.emit({'a' => 1}, time + 1)
+    driver.emit({'a' => 2}, time + 1)
+
+    data = driver.run
+
+    assert_equal([
+      {
+        :timestamp => time,
+        :series    => 'input.influxdb',
+        :values    => {'a' => 1},
+        :tags      => {'_seq' => 0},
+      },
+      {
+        :timestamp => time,
+        :series    => 'input.influxdb',
+        :values    => {'a' => 2},
+        :tags      => {'_seq' => 1},
+      },
+      {
+        :timestamp => time + 1,
+        :series    => 'input.influxdb',
+        :values    => {'a' => 1},
+        :tags      => {'_seq' => 0},
+      },
+      {
+        :timestamp => time + 1,
+        :series    => 'input.influxdb',
+        :values    => {'a' => 2},
+        :tags      => {'_seq' => 1},
+      }
+    ], driver.instance.influxdb.points)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-influxdb
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Masahiro Nakagawa
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2016-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A buffered output plugin for fluentd and influxDB