fluent-plugin-influxdb 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a070089e8dc07509c16215ef08d368ec1091662c
-  data.tar.gz: df19de18d8a2614e49f48a2ed12c9dd97063a8b3
+  metadata.gz: 19ed5ac1760f771e950cd309fd82c7762b7ce0ba
+  data.tar.gz: c0ef1cc12321bd4270b46ad6f077302ae587a82f
 SHA512:
-  metadata.gz: 6b7eaeedded220c7941b2f9c2fa736ec84415c6f29b4ed3ef62e912af27dad0358068644ed4d596a36f9974ccb45ef609f9bbf59ce989079b374004c7e83e55e
-  data.tar.gz: 70ead7e7d18a23de64a6ab43a78a54aa81ee3172e50417d01b05fdc46f5f230bd24de4e277bfb5e7b481a41c52747ac9b69e9c543c1075bb9f5f89774e29d9b0
+  metadata.gz: 5294012a219916c4cf1bf943c3980cedb6cd03f8c22553e5b4a8ac226cc7aa1866d6877b4332192e8c7899b74caf0282ebba9ac4029d16cf53fc1816ba4934da
+  data.tar.gz: 28663a91913a16451713e89b2278eb35b948c386a7154ab8b0c8535d079fab7ade8781e69caac7f5030a6e2c59fdf6e1a5c87236d83267b437f076a5da766301

data/History.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+0.2.7 (May, 10, 2016)
+=====
+
+- Add default_retention_policy and retention_policy parameters
+
 0.2.6 (Apr, 22, 2016)
 =====
 

data/README.md

@@ -43,6 +43,10 @@ Just like other regular output plugins, Use type `influxdb` in your fluentd conf
 
 `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
 
+`default_retention_policy`: The retention policy applied by default.  influxdb >= 0.2.3 is required to use this functionality.
+
+`retention_policy_key`: The name of the key in the record whose value specifies the retention policy.  The default retention policy will be applied if no such key exists.  influxdb >= 0.2.3 is required to use this functionality.
+
 ### Fluentd Tag and InfluxDB Series
 
 influxdb plugin uses Fluentd event tag for InfluxDB series.
@@ -52,7 +56,7 @@ So if you have events with `app.event`, influxdb plugin inserts events into `app
 
 ```
 <match mylog.*>
-  type influxdb
+  @type influxdb
   host  localhost
   port  8086
   dbname test

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.6'
+  s.version       = '0.2.7'
   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

@@ -41,6 +41,10 @@ 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
+  config_param :retention_policy_key, :string, :default => nil,
+               :desc => "The key of the key in the record that stores the retention policy name"
+  config_param :default_retention_policy, :string, :default => nil,
+               :desc => "The name of the default retention policy"
 
 
   def initialize
@@ -131,9 +135,30 @@ DESC
         :values    => values,
         :tags      => tags,
       }
-      points << point
+      retention_policy = @default_retention_policy
+      unless @retention_policy_key.nil?
+        retention_policy = record.delete(@retention_policy_key) || @default_retention_policy
+        unless points.nil?
+          if retention_policy != @default_retention_policy
+            # flush the retention policy first
+            @influxdb.write_points(points, nil, @default_retention_policy)
+            points = nil
+          end
+        end
+      end
+      if points.nil?
+        @influxdb.write_points([point], nil, retention_policy)
+      else
+        points << point
+      end
     end
 
-    @influxdb.write_points(points)
+    unless points.nil?
+      if @default_retention_policy.nil?
+        @influxdb.write_points(points)
+      else
+        @influxdb.write_points(points, nil, @default_retention_policy)
+      end
+    end
   end
 end

data/test/plugin/test_out_influxdb.rb

@@ -12,11 +12,11 @@ class InfluxdbOutputTest < Test::Unit::TestCase
       [{'name' => 'test'}]
     end
 
-    def write_points(points)
-      @points += points
+    def stop!
     end
 
-    def stop!
+    def write_points(points, precision=nil, retention_policy=nil)
+      @points << [points, precision, retention_policy]
     end
   end
 
@@ -42,7 +42,7 @@ class InfluxdbOutputTest < Test::Unit::TestCase
   def create_driver(conf=CONFIG, tag='test')
     Fluent::Test::BufferedOutputTestDriver.new(Fluent::InfluxdbOutput, tag) do
       attr_reader :influxdb
-      def start
+      def configure(conf)
         @influxdb = DummyInfluxDBClient.new()
         super
       end
@@ -83,18 +83,24 @@ class InfluxdbOutputTest < Test::Unit::TestCase
     data = driver.run
 
     assert_equal([
-      {
-        :timestamp => time,
-        :series    => 'input.influxdb',
-        :values    => {'a' => 1},
-        :tags      => {},
-      },
-      {
-        :timestamp => time,
-        :series    => 'input.influxdb',
-        :values    => {'a' => 2},
-        :tags      => {},
-      }
+      [
+        [
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :tags      => {},
+            :values    => {'a' => 1}
+          },
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :tags      => {},
+            :values    => {'a' => 2}
+          },
+        ],
+        nil,
+        nil
+      ]
     ], driver.instance.influxdb.points)
 
   end
@@ -116,24 +122,30 @@ class InfluxdbOutputTest < Test::Unit::TestCase
     data = driver.run
 
     assert_equal([
-      {
-        :timestamp => time,
-        :series    => 'input.influxdb',
-        :values    => {'a' => 1},
-        :tags      => {},
-      },
-      {
-        :timestamp => time,
-        :series    => 'input.influxdb',
-        :values    => {'a' => 2},
-        :tags      => {'b' => 1},
-      },
-      {
-        :timestamp => time,
-        :series    => 'input.influxdb',
-        :values    => {'a' => 3},
-        :tags      => {},
-      }
+      [
+        [
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :values    => {'a' => 1},
+            :tags      => {},
+          },
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :values    => {'a' => 2},
+            :tags      => {'b' => 1},
+          },
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :values    => {'a' => 3},
+            :tags      => {},
+          },
+        ],
+        nil,
+        nil
+      ]
     ], driver.instance.influxdb.points)
   end
 
@@ -161,30 +173,188 @@ class InfluxdbOutputTest < Test::Unit::TestCase
     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},
-      }
+      [
+        [
+          {
+            :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},
+          }
+        ],
+        nil,
+        nil
+      ]
+    ], driver.instance.influxdb.points)
+
+  end
+
+  def test_write_default_retention_policy_only
+    config = CONFIG + "\n" + %[
+      default_retention_policy ephemeral_1d
+    ]
+    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)
+
+    data = driver.run
+
+    assert_equal([
+      [
+        [
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :tags      => {},
+            :values    => {'a' => 1}
+          },
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :tags      => {},
+            :values    => {'a' => 2}
+          },
+        ],
+        nil,
+        'ephemeral_1d'
+      ]
     ], driver.instance.influxdb.points)
+
+  end
+
+  def test_write_respective_retention_policy
+    config = CONFIG + "\n" + %[
+      retention_policy_key rp
+    ]
+    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, 'rp' => 'ephemeral_1d'}, time)
+    driver.emit({'a' => 3, 'rp' => 'ephemeral_1m'}, time)
+
+    data = driver.run
+
+    assert_equal([
+      [
+        [
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :tags      => {},
+            :values    => {'a' => 1},
+          }
+        ],
+        nil,
+        nil
+      ],
+      [
+        [
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :tags      => {},
+            :values    => {'a' => 2},
+          }
+        ],
+        nil,
+        'ephemeral_1d'
+      ],
+      [
+        [
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :tags      => {},
+            :values    => {'a' => 3},
+          }
+        ],
+        nil,
+        'ephemeral_1m'
+      ]
+    ], driver.instance.influxdb.points)
+
+  end
+
+  def test_write_combined_retention_policy
+    config = CONFIG + "\n" + %[
+      default_retention_policy ephemeral_1d
+      retention_policy_key rp
+    ]
+    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, 'rp' => 'ephemeral_1d'}, time)
+    driver.emit({'a' => 3, 'rp' => 'ephemeral_1m'}, time)
+    driver.emit({'a' => 4}, time)
+
+    data = driver.run
+
+    assert_equal([
+      [
+        [
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :tags      => {},
+            :values    => {'a' => 1},
+          },
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :tags      => {},
+            :values    => {'a' => 2},
+          }
+        ],
+        nil,
+        'ephemeral_1d'
+      ],
+      [
+        [
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :tags      => {},
+            :values    => {'a' => 3},
+          }
+        ],
+        nil,
+        'ephemeral_1m'
+      ],
+      [
+        [
+          {
+            :timestamp => time,
+            :series    => 'input.influxdb',
+            :tags      => {},
+            :values    => {'a' => 4},
+          }
+        ],
+        nil,
+        'ephemeral_1d'
+      ]
+    ], 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.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Masahiro Nakagawa
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-05-09 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.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A buffered output plugin for fluentd and influxDB