logstash-output-influxdb2 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f1923cfcb3ce2d41a66adcd3be3d3226e9715e56046c15982555b8e96696406
-  data.tar.gz: c06683b3e4dda36a47a71c6524c4293c221d85341a273d65ccaa42d13448455d
+  metadata.gz: 3dfd75d3189d4c6d414de1de45c4bc1cc238edab17b80c46f5854b69d40bf2a2
+  data.tar.gz: 016e508f44b388e632fa97a06fb8643691083b174495261305e48285d645da27
 SHA512:
-  metadata.gz: 57df12c97e4445ea07b765157fdf75809cba9fa5f7ce8cc386d713e051c17fbbfadf85c2e098962334e47570ffe749064e4a36c63804484a899aae86ea1497b6
-  data.tar.gz: 8b7e1db0e716c92b45d6983a7cb722933222dd2faa482c605cb395eee1b18f52a57485b429c36dbb85e8faf34cf0b286f1777af68ca6e10c03591da6ed2c79ba
+  metadata.gz: 8dc471f8845297d388f0cec6954da91b4d43149119df5bc5fa6c1a92fb3be740b523352728a95acf4f01159d95d0b21c0c3494dfacceb7219eed1593f9bf8abc
+  data.tar.gz: 3841350260e5bb965517caa45ce513a047dd6ec3046f0ff54c3e7703709158c3c5fd6eef4aef01297c9d22feeaaa7a963d15783941f93d43ac3eb9156f4e4b72

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.4.0
+  - Update documents
+  - Change tags to optional
+
+## 0.3.0
+  - Add guards for invalid event
+  - Remove include_tags and exclude_tags
+
 ## 0.2.0
   - Add a copyright notice
   - Update gemspec summary

data/lib/logstash/outputs/influxdb2.rb

@@ -14,12 +14,9 @@ class LogStash::Outputs::InfluxDB2 < LogStash::Outputs::Base
   config :write_options, :validate => :hash, :default => {}
 
   config :measurement, :validate => :string, :required => true
-  config :tags, :validate => :string, :required => true
+  config :tags, :validate => :string
   config :fields, :validate => :string, :required => true
 
-  config :include_tags, :validate => :string, :list => true, :default => []
-  config :exclude_tags, :validate => :string, :list => true, :default => []
-
   config :escape_value, :validate => :boolean, :default => false
 
   public
@@ -32,26 +29,24 @@ class LogStash::Outputs::InfluxDB2 < LogStash::Outputs::Base
 
   public
   def receive(event)
-    begin
-      tags = event.get(@tags)
-      unless @include_tags.empty?
-        tags = tags.select { |k,v| @include_tags.include?(k) }
-      end
-      unless @exclude_tags.empty?
-        tags = tags.select { |k,v| ! @exclude_tags.include?(k) }
-      end
-      fields = event.get(@fields)
-      unless @escape_value
-        fields = fields.transform_values { |v| ToStr.new(v) }
-      end
-      @write_api.write(data: InfluxDB2::Point.new(
-        name: event.sprintf(@measurement), tags: tags, fields: fields,
-        time: event.timestamp.time, precision: @precision))
-    rescue InfluxDB2::InfluxError => ie
-      @logger.warn("HTTP communication error while writing to InfluxDB", :exception => ie)
-    rescue Exception => e
-      @logger.warn("Non recoverable exception while writing to InfluxDB", :exception => e)
+    fields = event.get(@fields)
+    return unless fields.is_a?(Hash) && ! fields.empty?
+
+    tags = @tags.nil? ? nil : event.get(@tags)
+    return unless tags.nil? || tags.is_a?(Hash)
+
+    unless @escape_value
+      fields = fields.transform_values { |v| ToStr.new(v) }
     end
+
+    @write_api.write(data: InfluxDB2::Point.new(
+      name: event.sprintf(@measurement), tags: tags, fields: fields,
+      time: event.timestamp.time, precision: @precision))
+
+  rescue InfluxDB2::InfluxError => ie
+    @logger.warn("HTTP communication error while writing to InfluxDB", :exception => ie)
+  rescue Exception => e
+    @logger.warn("Non recoverable exception while writing to InfluxDB", :exception => e)
   end # def event
 
   def close

data/logstash-output-influxdb2.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-output-influxdb2'
-  s.version       = '0.2.0'
+  s.version       = '0.4.0'
   s.licenses      = ['Apache-2.0']
   s.summary       = 'Writes metrics to InfluxDB 2.x'
   s.description   = 'This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program'

data/spec/outputs/influxdb2_spec.rb

@@ -14,7 +14,6 @@ describe LogStash::Outputs::InfluxDB2 do
       "url" => "http://localhost:8086",
       "token" => "token123",
       "measurement" => "%{[kubernetes][labels][app]}",
-      "tags" => "[prometheus][labels]",
       "fields" => "[prometheus][metrics]"
     }
     end
@@ -56,10 +55,8 @@ describe LogStash::Outputs::InfluxDB2 do
       expect(write_options.batch_abort_on_exception).to be false
 
       expect(subject.instance_variable_get(:@measurement)).to eq "%{[kubernetes][labels][app]}"
-      expect(subject.instance_variable_get(:@tags)).to eq "[prometheus][labels]"
+      expect(subject.instance_variable_get(:@tags)).to be_nil
       expect(subject.instance_variable_get(:@fields)).to eq "[prometheus][metrics]"
-      expect(subject.instance_variable_get(:@include_tags)).to eq []
-      expect(subject.instance_variable_get(:@exclude_tags)).to eq []
       expect(subject.instance_variable_get(:@escape_value)).to be false
     end
 
@@ -100,8 +97,6 @@ describe LogStash::Outputs::InfluxDB2 do
       "measurement" => "%{[kubernetes][labels][app]}",
       "tags" => "[prometheus][labels]",
       "fields" => "[prometheus][metrics]",
-      "include_tags" => [ "foo", "abc" ],
-      "exclude_tags" => [ "bar", "xyz" ],
       "escape_value" => true
     }
     end
@@ -145,8 +140,6 @@ describe LogStash::Outputs::InfluxDB2 do
       expect(subject.instance_variable_get(:@measurement)).to eq "%{[kubernetes][labels][app]}"
       expect(subject.instance_variable_get(:@tags)).to eq "[prometheus][labels]"
       expect(subject.instance_variable_get(:@fields)).to eq "[prometheus][metrics]"
-      expect(subject.instance_variable_get(:@include_tags)).to eq [ "foo", "abc" ]
-      expect(subject.instance_variable_get(:@exclude_tags)).to eq [ "bar", "xyz" ]
       expect(subject.instance_variable_get(:@escape_value)).to be true
     end
 
@@ -288,7 +281,7 @@ describe LogStash::Outputs::InfluxDB2 do
 
   end
 
-  context "validate payload - tag filter" do
+  context "validate payload - invalid event" do
 
     let(:config) do
     {
@@ -297,10 +290,7 @@ describe LogStash::Outputs::InfluxDB2 do
       "options" => { "bucket" => "test-bucket", "org" => "test-org", "precision" => "ms" },
       "measurement" => "%{[kubernetes][labels][app]}",
       "tags" => "[prometheus][labels]",
-      "fields" => "[prometheus][metrics]",
-      "include_tags" => [ "foo", "abc", "test" ],
-      "exclude_tags" => [ "bar", "xyz", "test" ],
-      "escape_value" => true
+      "fields" => "[prometheus][metrics]"
     }
     end
 
@@ -314,12 +304,53 @@ describe LogStash::Outputs::InfluxDB2 do
         "@timestamp" => "2020-01-01T00:00:00Z",
         "kubernetes" => { "labels" => { "app" => "dummy" } },
         "prometheus" => {
-          "labels" => {
-            "foo" => "bar", "abc" => "xyz",
-            "bar" => "foo", "xyz" => "abc",
-            "test" => "123"
-          },
-          "metrics" => { "message" => "Hello World!" }
+          "labels" => { "foo" => "bar", "abc" => "xyz" }
+          # Invalid: no metrics!
+        }
+      ))
+
+      subject.receive(LogStash::Event.new(
+        "@timestamp" => "2020-01-01T00:00:00Z",
+        "kubernetes" => { "labels" => { "app" => "dummy" } },
+        "prometheus" => {
+          "labels" => { "foo" => "bar", "abc" => "xyz" },
+          "metrics" => {}  # Invalid: no metrics!
+        }
+      ))
+
+      subject.receive(LogStash::Event.new(
+        "@timestamp" => "2020-01-01T00:00:00Z",
+        "kubernetes" => { "labels" => { "app" => "dummy" } },
+        "prometheus" => {
+          "labels" => { "foo" => "bar", "abc" => "xyz" },
+          "metrics" => 123.0  # Invalid: metrics are not a hash!
+        }
+      ))
+
+      subject.receive(LogStash::Event.new(
+        "@timestamp" => "2020-01-01T00:00:00Z",
+        "kubernetes" => { "labels" => { "app" => "dummy" } },
+        "prometheus" => {
+          # Valid: no labels!
+          "metrics" => { "count" => 123.0 }
+        }
+      ))
+
+      subject.receive(LogStash::Event.new(
+        "@timestamp" => "2020-01-01T00:00:00Z",
+        "kubernetes" => { "labels" => { "app" => "dummy" } },
+        "prometheus" => {
+          "labels" => {},  # Valid: no labels!
+          "metrics" => { "count" => 123.0 }
+        }
+      ))
+
+      subject.receive(LogStash::Event.new(
+        "@timestamp" => "2020-01-01T00:00:00Z",
+        "kubernetes" => { "labels" => { "app" => "dummy" } },
+        "prometheus" => {
+          "labels" => "test",  # Invalid: labels are not a hash!
+          "metrics" => { "count" => 123.0 }
         }
       ))
 
@@ -330,8 +361,8 @@ describe LogStash::Outputs::InfluxDB2 do
       write_api = subject.instance_variable_get(:@write_api)
 
       expect(write_api).to have_received(:write_raw)
-        .with('dummy,abc=xyz,foo=bar message="Hello World!" 1577836800000',
-              {:bucket=>"test-bucket", :org=>"test-org", :precision=>"ms"})
+        .with('dummy count=123.0 1577836800000',
+              {:bucket=>"test-bucket", :org=>"test-org", :precision=>"ms"}).twice
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-influxdb2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Issey Yamakoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-13 00:00:00.000000000 Z
+date: 2023-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api