logstash-output-mongodb_upsert_custom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f4e52a56cac12d0e591dacb03e3c9968888da377515300e6f80d14858ba98a6
+  data.tar.gz: deb4b185920556250d6af0455cfa1a464ab7551a41ebd5e085d44b74edebe012
+SHA512:
+  metadata.gz: 4c6d965c49a3e955934be9d9aca63c61bb3b63aad6dd2169ec34c252a080b55b735c3feb6df3b12e3f623361ecf8de24745b9f11d5dc8142e10bd88e18c25593
+  data.tar.gz: 3975b1adc830f4b4a88200b1f2b69d847e3a5976379df73bbf2f6266ed8d2190ad38f3922be631b17453b67fcc8241e99b8b566f2ce4989665be9c692b6aa45d

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* jijikarikkad - jijikarikkad@gmail.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-output-mongodb_upsert_custom
+Example output plugin. This should help bootstrap your effort to write your own output plugin!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/bson/big_decimal.rb

@@ -0,0 +1,66 @@
+# Copyright (C) 2009-2014 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Modified 2015 Elastic
+
+module BSON
+
+  # Injects behaviour for encoding and decoding BigDecimal values
+  # to and from # raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  module BigDecimal
+
+    # A floating point is type 0x01 in the BSON spec.
+    BSON_TYPE = 1.chr.force_encoding(BINARY).freeze
+
+    # The pack directive is for 8 byte floating points.
+    PACK = "E".freeze
+
+    # Get the floating point as encoded BSON.
+    # @example Get the floating point as encoded BSON.
+    #   1.221311.to_bson
+    # @return [ String ] The encoded string.
+    # @see http://bsonspec.org/#/specification
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      encoded << [ self ].pack(PACK)
+    end
+
+    module ClassMethods
+
+      # Deserialize an instance of a BigDecimal from a BSON double.
+      # @param [ BSON ] bson object from Mongo.
+      # @return [ BigDecimal ] The decoded BigDecimal.
+      # @see http://bsonspec.org/#/specification
+      def from_bson(bson)
+        from_bson_double(bson.read(8))
+      end
+
+      private
+
+      def from_bson_double(double)
+        new(double.unpack(PACK).first.to_s)
+      end
+    end
+
+    # Register this type when the module is loaded.
+    Registry.register(BSON_TYPE, ::BigDecimal)
+  end
+
+  # Enrich the core BigDecimal class with this module.
+  #
+  # @since 2.0.0
+  ::BigDecimal.send(:include, BigDecimal)
+  ::BigDecimal.send(:extend, BigDecimal::ClassMethods)
+end

data/lib/logstash/outputs/bson/logstash_event.rb

@@ -0,0 +1,76 @@
+# Copyright (C) 2009-2014 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Modified 2015 Elastic
+
+module BSON
+
+  # Injects behaviour for encoding and decoding time values to
+  # and from raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  module LogStashEvent
+
+    # An Event is an embedded document is type 0x03 in the BSON spec..
+    BSON_TYPE = 3.chr.force_encoding(BINARY).freeze
+
+    # Get the event as encoded BSON.
+    # @example Get the hash as encoded BSON.
+    #   Event.new("field" => "value").to_bson
+    # @return [ String ] The encoded string.
+    # @see http://bsonspec.org/#/specification
+     def to_bson(buffer = ByteBuffer.new)
+      position = buffer.length
+      buffer.put_int32(0)
+      to_hash.each do |field, value|
+        buffer.put_byte(value.bson_type)
+        buffer.put_cstring(field.to_bson_key)
+        value.to_bson(buffer)
+      end
+      buffer.put_byte(NULL_BYTE)
+      buffer.replace_int32(position, buffer.length - position)
+    end
+
+    # Converts the event to a normalized value in a BSON document.
+    # @example Convert the event to a normalized value.
+    #   event.to_bson_normalized_value
+    # @return [ BSON::Document ] The normalized event.
+    def to_bson_normalized_value
+      Document.new(self)
+    end
+
+    module ClassMethods
+      # Deserialize the Event from BSON.
+      # @param [ ByteBuffer ] buffer The byte buffer.
+      # @return [ Event ] The decoded bson document.
+      # @see http://bsonspec.org/#/specification
+      def from_bson(buffer)
+        hash = Hash.new
+        buffer.get_int32 # Throw away the size.
+        while (type = buffer.get_byte) != NULL_BYTE
+          field = buffer.get_cstring
+          hash.store(field, BSON::Registry.get(type).from_bson(buffer))
+        end
+        new(hash)
+      end
+    end
+
+    # Register this type when the module is loaded.
+    Registry.register(BSON_TYPE, ::LogStash::Event)
+  end
+
+  # Enrich the core LogStash::Event class with this module.
+  ::LogStash::Event.send(:include, ::LogStashEvent)
+  ::LogStash::Event.send(:extend, ::LogStashEvent::ClassMethods)
+end

data/lib/logstash/outputs/bson/logstash_timestamp.rb

@@ -0,0 +1,50 @@
+# Copyright (C) 2009-2014 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Modified 2015 Elastic
+
+module BSON
+
+  # Injects behaviour for encoding and decoding time values to
+  # and from raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  module LogStashTimestamp
+
+    # A time is type 0x09 in the BSON spec.
+    BSON_TYPE = 9.chr.force_encoding(BINARY).freeze
+
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      time.to_bson(encoded)
+    end
+
+    module ClassMethods
+      # Deserialize UTC time from BSON.
+      # @param [ BSON ] bson encoded time.
+      # @return [ ::LogStash::Timestamp ] The decoded UTC time as a ::LogStash::Timestamp.
+      # @see http://bsonspec.org/#/specification
+      def from_bson(bson)
+        seconds, fragment = BSON::Int64.from_bson(bson).divmod(1000)
+        new(::Time.at(seconds, fragment * 1000).utc)
+      end
+    end
+
+    # Register this type when the module is loaded.
+    Registry.register(BSON_TYPE, ::LogStash::Timestamp)
+  end
+
+  # Enrich the core LogStash::Timestamp class with this module.
+  ::LogStash::Timestamp.send(:include, LogStashTimestamp)
+  ::LogStash::Timestamp.send(:extend, LogStashTimestamp::ClassMethods)
+end

data/lib/logstash/outputs/mongodb_upsert_custom.rb

@@ -0,0 +1,202 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "mongo"
+require_relative "bson/big_decimal"
+require_relative "bson/logstash_timestamp"
+
+# This output writes events to MongoDB.
+class LogStash::Outputs::MongodbUpsertCustom < LogStash::Outputs::Base
+
+  config_name "mongodb_upsert_custom"
+
+  # A MongoDB URI to connect to.
+  # See http://docs.mongodb.org/manual/reference/connection-string/.
+  config :uri, :validate => :string, :required => true
+
+  # The database to use.
+  config :database, :validate => :string, :required => true
+
+  # The collection to use. This value can use `%{foo}` values to dynamically
+  # select a collection based on data in the event.
+  config :collection, :validate => :string, :required => true
+
+  # If true, store the @timestamp field in MongoDB as an ISODate type instead
+  # of an ISO8601 string.  For more information about this, see
+  # http://www.mongodb.org/display/DOCS/Dates.
+  config :isodate, :validate => :boolean, :default => false
+
+  # The number of seconds to wait after failure before retrying.
+  config :retry_delay, :validate => :number, :default => 3, :required => false
+
+  # If true, an "_id" field will be added to the document before insertion.
+  # The "_id" field will use the timestamp of the event and overwrite an existing
+  # "_id" field in the event.
+  config :generateId, :validate => :boolean, :default => false
+
+
+  # Bulk insert flag, set to true to allow bulk insertion, else it will insert events one by one.
+  config :bulk, :validate => :boolean, :default => false
+  # Bulk interval, Used to insert events periodically if the "bulk" flag is activated.
+  config :bulk_interval, :validate => :number, :default => 2
+  # Bulk events number, if the number of events to insert into a collection raise that limit, it will be bulk inserted
+  # whatever the bulk interval value (mongodb hard limit is 1000).
+  config :bulk_size, :validate => :number, :default => 900, :maximum => 999, :min => 2
+
+  config :date_keys, :validate => :string, :default => nil
+
+  config :is_insert, :validate => :boolean, :default => nil
+
+  config :update_keys, :validate => :string, :default => nil
+
+  config :filter_key1, :validate => :string, :default => nil
+
+  config :filter_key2, :validate => :string, :default => nil
+
+  # Mutex used to synchronize access to 'documents'
+  @@mutex = Mutex.new
+
+  def register
+    if @bulk_size > 1000
+      raise LogStash::ConfigurationError, "Bulk size must be lower than '1000', currently '#{@bulk_size}'"
+    end
+
+    Mongo::Logger.logger = @logger
+    conn = Mongo::Client.new(@uri)
+    @db = conn.use(@database)
+
+    @closed = Concurrent::AtomicBoolean.new(false)
+    @documents = {}
+    @bulk_thread = Thread.new(@bulk_interval) do |bulk_interval|
+      while @closed.false? do
+        sleep(bulk_interval)
+
+        @@mutex.synchronize do
+          @documents.each do |collection, values|
+            if values.length > 0
+              if !@is_insert
+                values.each do |value|
+                  criteria = Hash.new
+                  criteria_key1 = @filter_key1
+                  criteria[criteria_key1] = value[criteria_key1]
+                  criteria_key2 = @filter_key2
+                  criteria[criteria_key2] = value[criteria_key2]
+                  documentToUpdate = @db[collection].find(criteria)
+                  if documentToUpdate.count() > 0
+                    documentToUpdate.update_many('$set' => value)
+                  else 
+                    @db[collection].insert_many([value])
+                  end
+                end
+              else 
+                @db[collection].insert_many(values)
+              end
+              @documents.delete(collection)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def receive(event)
+    begin
+      # Our timestamp object now has a to_bson method, using it here
+      # {}.merge(other) so we don't taint the event hash innards
+      document = {}.merge(event.to_hash)
+      if !@isodate
+        timestamp = event.timestamp
+        if timestamp
+          # not using timestamp.to_bson
+          document["@timestamp"] = timestamp.to_json
+        else
+          @logger.warn("Cannot set MongoDB document `@timestamp` field because it does not exist in the event", :event => event)
+        end
+      end
+
+      if @date_keys
+        keys = date_keys.to_s.split(",")
+        document.each do |key, value|
+          if keys.index key
+            document[key] = LogStash::Timestamp.new(value)
+          end
+        end
+      end
+
+      if @update_keys
+        filterkeys = update_keys.to_s.split(",")
+        @filter_key1 = filterkeys[0]
+        @filter_key2 = filterkeys[1]
+      end
+
+      if @generateId
+        document["_id"] = BSON::ObjectId.new
+      end
+
+      if @bulk
+        collection = event.sprintf(@collection)
+        @@mutex.synchronize do
+          if(!@documents[collection])
+            @documents[collection] = []
+          end
+          @documents[collection].push(document)
+          if(@documents[collection].length >= @bulk_size)
+            if !@is_insert
+              @documents[collection].each do |docRecord|
+                criteria = Hash.new
+                criteria_key1 = @filter_key1
+                criteria[criteria_key1] = docRecord[criteria_key1]
+                criteria_key2 = @filter_key2
+                criteria[criteria_key2] = docRecord[criteria_key2]
+                documentToUpdate = @db[collection].find(criteria)
+                if documentToUpdate.count() > 0
+                  documentToUpdate.update_many('$set' => docRecord)
+                else 
+                  @db[collection].insert_many([docRecord])
+                end
+              end
+            else
+              @db[collection].insert_many(@documents[collection])
+            end
+            @documents.delete(collection)
+          end
+        end
+      else
+        if !@is_insert
+          criteria = Hash.new
+          criteria_key1 = @filter_key1
+          criteria[criteria_key1] = document[criteria_key1]
+          criteria_key2 = @filter_key2
+          criteria[criteria_key2] = document[criteria_key2]
+          singleDoc = @db[event.sprintf(@collection)].find(criteria)
+          if singleDoc.count() > 0
+            singleDoc.update_one('$set' => document)
+          else
+            @db[event.sprintf(@collection)].insert_one(document)
+          end
+        else
+          @db[event.sprintf(@collection)].insert_one(document)
+        end
+      end
+    rescue => e
+      if e.message =~ /^E11000/
+        # On a duplicate key error, skip the insert.
+        # We could check if the duplicate key err is the _id key
+        # and generate a new primary key.
+        # If the duplicate key error is on another field, we have no way
+        # to fix the issue.
+        @logger.warn("Skipping insert because of a duplicate key error", :event => event, :exception => e)
+      else
+        @logger.warn("Failed to send event to MongoDB, retrying in #{@retry_delay.to_s} seconds", :event => event, :exception => e)
+        sleep(@retry_delay)
+        retry
+      end
+    end
+  end
+
+  def close
+    @closed.make_true
+    @bulk_thread.wakeup
+    @bulk_thread.join
+  end
+end

data/logstash-output-mongodb_upsert_custom.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-output-mongodb_upsert_custom'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Plugin to write to mongo db.'
+  s.description   = 'This plugin is to write the logstash input to given mongo db.'
+  s.homepage      = 'http://www.elastic.co/guide/en/logstash/current/index.html'
+  s.authors       = ['jijk']
+  s.email         = 'jiji.k@softwareag.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/mongodb_upsert_custom_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/mongodb_upsert_custom"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::MongodbUpsertCustom do
+  let(:sample_event) { LogStash::Event.new }
+  let(:output) { LogStash::Outputs::MongodbUpsertCustom.new }
+
+  before do
+    output.register
+  end
+
+  describe "receive message" do
+    subject { output.receive(sample_event) }
+
+    it "returns a string" do
+      expect(subject).to eq("Event received")
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-mongodb_upsert_custom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jijk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  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 plugin is to write the logstash input to given mongo db.
+email: jiji.k@softwareag.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/outputs/bson/big_decimal.rb
+- lib/logstash/outputs/bson/logstash_event.rb
+- lib/logstash/outputs/bson/logstash_timestamp.rb
+- lib/logstash/outputs/mongodb_upsert_custom.rb
+- logstash-output-mongodb_upsert_custom.gemspec
+- spec/outputs/mongodb_upsert_custom_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Plugin to write to mongo db.
+test_files:
+- spec/outputs/mongodb_upsert_custom_spec.rb