logstash-input-elastic_jdbc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03f49ece3284c2f8e8d6ad338af961f25403ca08fc780aa2243aa2fb7a8c77cc
+  data.tar.gz: 50bbff1c78e0595d85a9d9f5b6a85d96e33ea7e94a4e2fb844c07165816ebf18
+SHA512:
+  metadata.gz: 2c4ed56a6b061da002ee7fe84dcf70fdf68af9271f18ed959e668922269253d55d75d25dba430705389e167e0d1549da62eabf959b560d321aba719122b83a38
+  data.tar.gz: 5cc7cd3fa424730b1eb69c6d4b75fc5d4678be93d9fbedd063fabebec15e5355bdf5b8b8733508ec09266aece6487c4c30d2c17c92b6ab48406bdbf10f5e1994

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:
+*  - 
+
+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-input-elastic_jdbc
+Example input plugin. This should help bootstrap your effort to write your own input plugin!

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end
+
+

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,107 @@
+# Logstash Plugin
+[GitHub](https://github.com/ernesrocker/RubyGems).
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source.
+
+## Documentation
+This plugin inherit of elasticsearch input plugin, and added a tracking_column
+using in jdbc input plugin for make a query to obtain the updates values
+Sample :
+ input {
+       # Read all documents from Elasticsearch matching the given query
+       elastic_jdbc {
+         hosts => "localhost"
+         tracking_column => "last_update"
+ 	            last_run_metadata_path => "/path_file"
+ 	    }
+     }
+
+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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- 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/inputs/elastic_jdbc.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/inputs/elasticsearch"
+require_relative "value_tracking"
+require "json"
+require "logstash/json"
+require "time"
+
+# This plugin is a simple extension of Elasticsearch input plugin. We added tracking_column property
+# for search in elasticsearch query all hits that contains the 'last_update' value bigger that the value_tracker.
+# The value_tracker contains the last consult to that index stored in a last run file created.
+# We build the query based on the above described.
+# This is a sample of elastic_jdbc plugin statement:
+# input {
+#       # Read all documents from Elasticsearch matching the given query
+#       elastic_jdbc {
+#         hosts => "localhost"
+#         tracking_column => "last_update"
+# 	            last_run_metadata_path => "/opt/logstash/last_run/index_name"
+# 	    }
+#     }
+#
+class LogStash::Inputs::ElasticJdbc < LogStash::Inputs::Elasticsearch
+  config_name "elastic_jdbc"
+
+  #region tracking configuration
+  # Path to file with last run time
+  config :last_run_metadata_path, :validate => :string, :default => "#{ENV['HOME']}/.logstash_jdbc_last_run"
+
+  # If tracking column value rather than timestamp, the column whose value is to be tracked
+  config :tracking_column, :validate => :string
+
+  # Type of tracking column. Currently only "numeric" and "timestamp"
+  config :tracking_column_type, :validate => ['timestamp'], :default => 'timestamp'
+
+  # Whether the previous run state should be preserved
+  config :clean_run, :validate => :boolean, :default => false
+
+  # Whether to save state or not in last_run_metadata_path
+  config :record_last_run, :validate => :boolean, :default => true
+
+  #endregion
+
+  public
+  def register
+    super()
+    if @tracking_column.nil?
+        raise(LogStash::ConfigurationError, "Must set :tracking_column if :use_column_value is true.")
+      end
+    set_value_tracker(ValueTracking.build_last_value_tracker(self))
+    build_query()
+  end # def register
+
+  def set_value_tracker(instance)
+    @value_tracker = instance
+  end
+
+  def build_query
+    time_now = Time.now.utc
+    last_value = @value_tracker ? Time.parse(@value_tracker.value.to_s).iso8601 : Time.parse(time_now).iso8601
+    column = @tracking_column.to_s
+    query = {query: { range: {column => {gt: last_value.to_s}}}, sort: [{column => {order: "desc"}}]}
+    @query = query.to_json
+    @base_query = LogStash::Json.load(@query)
+  end
+
+  def run(queue)
+    begin
+      super(queue)
+    rescue => e
+      @logger.error("Failed running elastic_jdbc plugin", :exception => e)
+    else
+      @value_tracker.set_value(Time.now.to_s)
+      @value_tracker.write
+    end
+  end # def run
+
+  def stop
+    super()
+  end
+end # class LogStash::Inputs::ElasticJdbc

data/lib/logstash/inputs/value_tracking.rb

@@ -0,0 +1,87 @@
+require "yaml" # persistence
+class ValueTracking
+
+  def self.build_last_value_tracker(plugin)
+    handler = NullFileHandler.new(plugin.last_run_metadata_path)
+    if plugin.record_last_run
+      handler = FileHandler.new(plugin.last_run_metadata_path)
+    end
+    if plugin.clean_run
+      handler.clean
+    end
+    instance = DateTimeValueTracker.new(handler)
+  end
+
+  attr_reader :value
+
+  def initialize(handler)
+    @file_handler = handler
+    set_value(get_initial)
+  end
+
+  def get_initial
+    # override in subclass
+  end
+
+  def set_value(value)
+    # override in subclass
+  end
+
+  def write
+    @file_handler.write(@value.to_s)
+  end
+end
+
+
+class DateTimeValueTracker < ValueTracking
+  def get_initial
+    @file_handler.read || DateTime.new(1970)
+  end
+
+  def set_value(value)
+    if value.respond_to?(:to_datetime)
+      @value = value.to_datetime
+    else
+      @value = DateTime.parse(value)
+    end
+  end
+end
+
+class FileHandler
+  def initialize(path)
+    @path = path
+    @exists = ::File.exist?(@path)
+  end
+
+  def clean
+    return unless @exists
+    ::File.delete(@path)
+    @exists = false
+  end
+
+  def read
+    return unless @exists
+    YAML.load(::File.read(@path))
+  end
+
+  def write(value)
+    ::File.write(@path, YAML.dump(value))
+    @exists = true
+  end
+end
+
+class NullFileHandler
+  def initialize(path)
+  end
+
+  def clean
+  end
+
+  def read
+  end
+
+  def write(value)
+  end
+end
+
+

data/logstash-input-elastic-jdbc.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+Gem::Specification.new do |s|
+  s.name          = 'logstash-input-elastic_jdbc'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Logstash elastic_jdbc'
+  s.description   = 'This plugin inherit of elasticsearch input plugin, but added tracking_column like jdbc input plugin.'
+  s.homepage      = 'https://github.com/ernesrocker/RubyGems'
+  s.authors       = ['Ernesto Soler Calaña']
+  s.email         = 'ernes920825@gmail.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" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud', '>= 0.0.22'
+  s.add_development_dependency 'logstash-devutils', '~> 0.0', '>= 0.0.16'
+end

data/spec/inputs/elastic-jdbc_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/elastic_jdbc"
+
+describe LogStash::Inputs::ElasticJdbc do
+
+  it_behaves_like "an interruptible input plugin" do
+    let(:config) { { "interval" => 100 } }
+  end
+
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-elastic_jdbc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ernesto Soler Calaña
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-09 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: stud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+description: This plugin inherit of elasticsearch input plugin, but added tracking_column
+  like jdbc input plugin.
+email: ernes920825@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/inputs/elastic_jdbc.rb
+- lib/logstash/inputs/value_tracking.rb
+- logstash-input-elastic-jdbc.gemspec
+- spec/inputs/elastic-jdbc_spec.rb
+homepage: https://github.com/ernesrocker/RubyGems
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Logstash elastic_jdbc
+test_files:
+- spec/inputs/elastic-jdbc_spec.rb