logstash-output-charrington 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9e0b78caecf406a5c26c0c433a9e9e03361ca64110e5380333ecbb1b7e14c53
+  data.tar.gz: 97b48b44372f9f44463c608d03d9362984ccaded87257e5938bed056ac7c6bc2
+SHA512:
+  metadata.gz: 7a8d64b4f5cc6de22d26297477ca3561af1d9cde45dbcc32f7ad785f9485b490780832698265402ad7bb9291b164ea06ca57fd4aaa18968ce1eefe3848590bd5
+  data.tar.gz: 5a79965fad327dc2588ea45b4b6eae8c8a1c2393e28cc7f02e76eb6e1100688405f454e2a0d2d4966330483899bbb217cddd3cb1e0992204de8f57ca95edd430

data/CHANGELOG.md

@@ -0,0 +1,64 @@
+# Change Log
+All notable changes to this project will be documented in this file, from 0.2.0.
+
+## [5.3.0] - 2017-11-08
+  - Adds configuration options `enable_event_as_json_keyword` and `event_as_json_keyword`
+  - Adds BigDecimal support
+  - Adds additional logging for debugging purposes (with thanks to @mlkmhd's work)
+
+## [5.2.1] - 2017-04-09
+  - Adds Array and Hash to_json support for non-sprintf syntax
+
+## [5.2.0] - 2017-04-01
+  - Upgrades HikariCP to latest
+  - Fixes HikariCP logging integration issues
+
+## [5.1.0] - 2016-12-17
+  - phoenix-thin fixes for issue #60
+
+## [5.0.0] - 2016-11-03
+  - logstash v5 support
+
+## [0.3.1] - 2016-08-28
+  - Adds connection_test configuration option, to prevent the connection test from occuring, allowing the error to be suppressed.
+    Useful for cockroachdb deployments. https://github.com/theangryangel/logstash-output-jdbc/issues/53 
+
+## [0.3.0] - 2016-07-24
+  - Brings tests from v5 branch, providing greater coverage
+  - Removes bulk update support, due to inconsistent behaviour
+  - Plugin now marked as threadsafe, meaning only 1 instance per-Logstash
+    - Raises default max_pool_size to match the default number of workers (1 connection per worker)
+
+## [0.2.10] - 2016-07-07
+  - Support non-string entries in statement array
+  - Adds backtrace to exception logging
+
+## [0.2.9] - 2016-06-29
+  - Fix NameError exception. 
+  - Moved log_jdbc_exception calls
+
+## [0.2.7] - 2016-05-29
+  - Backport retry exception logic from v5 branch
+  - Backport improved timestamp compatibility from v5 branch
+
+## [0.2.6] - 2016-05-02
+  - Fix for exception infinite loop
+
+## [0.2.5] - 2016-04-11
+### Added
+  - Basic tests running against DerbyDB
+  - Fix for converting Logstash::Timestamp to iso8601 from @hordijk
+
+## [0.2.4] - 2016-04-07
+  - Documentation fixes from @hordijk
+
+## [0.2.3] - 2016-02-16
+  - Bug fixes
+
+## [0.2.2] - 2015-12-30
+  - Bug fixes
+
+## [0.2.1] -  2015-12-22
+  - Support for connection pooling support added through HikariCP
+  - Support for unsafe statement handling (allowing dynamic queries)
+  - Altered exception handling to now count sequential flushes with exceptions thrown

data/Gemfile

@@ -0,0 +1,11 @@
+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.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# logstash-output-jdbc 
+
+[![Build Status](https://travis-ci.org/theangryangel/logstash-output-jdbc.svg?branch=master)](https://travis-ci.org/theangryangel/logstash-output-jdbc) [![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=the_angry_angel&url=https://github.com/the_angry_angel/logstash-output-jdbc&title=logstash-output-jdbc&language=&tags=github&category=software)
+
+This plugin is provided as an external plugin and is not part of the Logstash project.
+
+This plugin allows you to output to SQL databases, using JDBC adapters.
+See below for tested adapters, and example configurations.
+
+This has not yet been extensively tested with all JDBC drivers and may not yet work for you.
+
+If you do find this works for a JDBC driver without an example, let me know and provide a small example configuration if you can.
+
+This plugin does not bundle any JDBC jar files, and does expect them to be in a
+particular location. Please ensure you read the 4 installation lines below.
+
+## Support & release schedule
+I no longer have time at work to maintain this plugin in step with Logstash's releases, and I am not completely immersed in the Logstash ecosystem. If something is broken for you I will do my best to help, but I cannot guarantee timeframes.
+
+Pull requests are always welcome. 
+
+## Changelog
+See CHANGELOG.md
+
+## Versions
+Released versions are available via rubygems, and typically tagged.
+
+For development:
+  - See master branch for logstash v5 & v6 :warning: This is untested under Logstash 6.3 at this time, and there has been 1 unverified report of an issue. Please use at your own risk until I can find the time to evaluate and test 6.3.
+  - See v2.x branch for logstash v2
+  - See v1.5 branch for logstash v1.5 
+  - See v1.4 branch for logstash 1.4
+
+## Installation
+  - Run `bin/logstash-plugin install logstash-output-charrington` in your logstash installation directory
+  - Now either:
+    - Use driver_jar_path in your configuraton to specify a path to your jar file
+  - Or:
+    - Create the directory vendor/jar/jdbc in your logstash installation (`mkdir -p vendor/jar/jdbc/`)
+    - Add JDBC jar files to vendor/jar/jdbc in your logstash installation
+  - And then configure (examples can be found in the examples directory)
+
+## Configuration options
+
+| Option                       | Type             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Required? | Default |
+| ------                       | ----             | -----------                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | --------- | ------- |
+| driver_class                 | String           | Specify a driver class if autoloading fails                                                                                                                                                                                                                                                                                                                                                                                                                                                   | No        |         |
+| driver_auto_commit           | Boolean          | If the driver does not support auto commit, you should set this to false                                                                                                                                                                                                                                                                                                                                                                                                                      | No        | True    |
+| driver_jar_path              | String           | File path to jar file containing your JDBC driver. This is optional, and all JDBC jars may be placed in $LOGSTASH_HOME/vendor/jar/jdbc instead.                                                                                                                                                                                                                                                                                                                                               | No        |         |
+| connection_string            | String           | JDBC connection URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Yes       |         |
+| connection_test              | Boolean          | Run a JDBC connection test. Some drivers do not function correctly, and you may need to disable the connection test to supress an error. Cockroach with the postgres JDBC driver is such an example.                                                                                                                                                                                                                                                                                          | No        | Yes     |
+| connection_test_query        | String           | Connection test and init query string, required for some JDBC drivers that don't support isValid(). Typically you'd set to this "SELECT 1"                                                                                                                                                                                                                                                                                                                                                    | No        |         |
+| username                     | String           | JDBC username - this is optional as it may be included in the connection string, for many drivers                                                                                                                                                                                                                                                                                                                                                                                             | No        |         |
+| password                     | String           | JDBC password - this is optional as it may be included in the connection string, for many drivers                                                                                                                                                                                                                                                                                                                                                                                             | No        |         |
+| statement                    | Array            | An array of strings representing the SQL statement to run. Index 0 is the SQL statement that is prepared, all other array entries are passed in as parameters (in order). A parameter may either be a property of the event (i.e. "@timestamp", or "host") or a formatted string (i.e. "%{host} - %{message}" or "%{message}"). If a key is passed then it will be automatically converted as required for insertion into SQL. If it's a formatted string then it will be passed in verbatim. | Yes       |         |
+| unsafe_statement             | Boolean          | If yes, the statement is evaluated for event fields - this allows you to use dynamic table names, etc. **This is highly dangerous** and you should **not** use this unless you are 100% sure that the field(s) you are passing in are 100% safe. Failure to do so will result in possible SQL injections. Example statement: [ "insert into %{table_name_field} (column) values(?)", "fieldname" ]                                                                                            | No        | False   |
+| max_pool_size                | Number           | Maximum number of connections to open to the SQL server at any 1 time                                                                                                                                                                                                                                                                                                                                                                                                                         | No        | 5       |
+| connection_timeout           | Number           | Number of milliseconds before a SQL connection is closed                                                                                                                                                                                                                                                                                                                                                                                                                                           | No        | 10000   |
+| flush_size                   | Number           | Maximum number of entries to buffer before sending to SQL - if this is reached before idle_flush_time                                                                                                                                                                                                                                                                                                                                                                                         | No        | 1000    |
+| max_flush_exceptions         | Number           | Number of sequential flushes which cause an exception, before the set of events are discarded. Set to a value less than 1 if you never want it to stop. This should be carefully configured with respect to retry_initial_interval and retry_max_interval, if your SQL server is not highly available                                                                                                                                                                                         | No        | 10      |
+| retry_initial_interval       | Number           | Number of seconds before the initial retry in the event of a failure. On each failure it will be doubled until it reaches retry_max_interval                                                                                                                                                                                                                                                                                                                                                  | No        | 2       |
+| retry_max_interval           | Number           | Maximum number of seconds between each retry                                                                                                                                                                                                                                                                                                                                                                                                                                                  | No        | 128     |
+| retry_sql_states             | Array of strings | An array of custom SQL state codes you wish to retry until `max_flush_exceptions`. Useful if you're using a JDBC driver which returns retry-able, but non-standard SQL state codes in it's exceptions.                                                                                                                                                                                                                                                                                        | No        | []      |
+| event_as_json_keyword        | String           | The magic key word that the plugin looks for to convert the entire event into a JSON object. As Logstash does not support this out of the box with it's `sprintf` implementation, you can use whatever this field is set to in the statement parameters                                                                                                                                                                                                                                       | No        | @event  |
+| enable_event_as_json_keyword | Boolean          | Enables the magic keyword set in the configuration option `event_as_json_keyword`. Without this enabled the plugin will not convert the `event_as_json_keyword` into JSON encoding of the entire event.                                                                                                                                                                                                                                                                                       | No        | False   |
+
+## Example configurations
+Example logstash configurations, can now be found in the examples directory. Where possible we try to link every configuration with a tested jar.
+
+If you have a working sample configuration, for a DB thats not listed, pull requests are welcome.
+
+## Development and Running tests
+For development tests are recommended to run inside a virtual machine (Vagrantfile is included in the repo), as it requires
+access to various database engines and could completely destroy any data in a live system.
+
+If you have vagrant available (this is temporary whilst I'm hacking on v5 support. I'll make this more streamlined later):
+  - `vagrant up`
+  - `vagrant ssh`
+  - `cd /vagrant`
+  - `gem install bundler`
+  - `cd /vagrant && bundle install && bundle exec rake vendor && bundle exec rake install_jars`
+  - `./scripts/travis-before_script.sh && source ./scripts/travis-variables.sh`
+  - `bundle exec rspec`
+
+## Releasing
+  - Update Changelog
+  - Bump version in gemspec
+  - Commit
+  - Create tag `git tag v<version-number-in-gemspec>`
+  - `bundle exec rake install_jars`
+  - `bundle exec rake pre_release_checks`
+  - `gem build logstash-output-jdbc.gemspec`
+  - `gem push`

data/THANKS.md

@@ -0,0 +1,18 @@
+logstash-output-jdbc is a project originally created by Karl Southern 
+(the_angry_angel), but there are a number of people that have contributed 
+or implemented key features over time. We do our best to keep this list 
+up-to-date, but you can also have a look at the nice contributor graphs
+produced by GitHub: https://github.com/theangryangel/logstash-output-jdbc/graphs/contributors
+
+ * [hordijk](https://github.com/hordijk)
+ * [dmitryakadiamond](https://github.com/dmitryakadiamond)
+ * [MassimoSporchia](https://github.com/MassimoSporchia)
+ * [ebuildy](https://github.com/ebuildy)
+ * [kushtrimjunuzi](https://github.com/kushtrimjunuzi)
+ * [josemazo](https://github.com/josemazo)
+ * [aceoliver](https://github.com/aceoliver)
+ * [roflmao](https://github.com/roflmao)
+ * [onesuper](https://github.com/onesuper)
+ * [phr0gz](https://github.com/phr0gz)
+ * [jMonsinjon](https://github.com/jMonsinjon)
+ * [mlkmhd](https://github.com/mlkmhd)

data/lib/logstash-output-charrington_jars.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+require 'logstash/environment'
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+LogStash::Environment.load_runtime_jars! File.join(root_dir, 'vendor')

data/lib/logstash/outputs/charrington.rb

@@ -0,0 +1,422 @@
+# encoding: utf-8
+require 'logstash/outputs/base'
+require 'logstash/namespace'
+require 'concurrent'
+require 'stud/interval'
+require 'java'
+require 'logstash-output-charrington_jars'
+require 'json'
+require 'bigdecimal'
+
+# Write events to a SQL engine, using JDBC.
+#
+# It is upto the user of the plugin to correctly configure the plugin. This
+# includes correctly crafting the SQL statement, and matching the number of
+# parameters correctly.
+#
+class LogStash::Outputs::Charrington < LogStash::Outputs::Base
+  concurrency :shared
+
+  STRFTIME_FMT = '%Y-%m-%d %T.%L'.freeze
+
+  RETRYABLE_SQLSTATE_CLASSES = [
+    # Classes of retryable SQLSTATE codes
+    # Not all in the class will be retryable. However, this is the best that
+    # we've got right now.
+    # If a custom state code is required, set it in retry_sql_states.
+    '08', # Connection Exception
+    '24', # Invalid Cursor State (Maybe retry-able in some circumstances)
+    '25', # Invalid Transaction State
+    '40', # Transaction Rollback
+    '53', # Insufficient Resources
+    '54', # Program Limit Exceeded (MAYBE)
+    '55', # Object Not In Prerequisite State
+    '57', # Operator Intervention
+    '58', # System Error
+  ].freeze
+
+  config_name 'charrington'
+
+  # Driver class - Reintroduced for https://github.com/theangryangel/logstash-output-jdbc/issues/26
+  config :driver_class, validate: :string
+
+  # Does the JDBC driver support autocommit?
+  config :driver_auto_commit, validate: :boolean, default: true, required: true
+
+  # Where to find the jar
+  # Defaults to not required, and to the original behaviour
+  config :driver_jar_path, validate: :string, required: false
+
+  # jdbc connection string
+  config :connection_string, validate: :string, required: true
+
+  # jdbc username - optional, maybe in the connection string
+  config :username, validate: :string, required: false
+
+  # jdbc password - optional, maybe in the connection string
+  config :password, validate: :string, required: false
+
+  # [ "insert into table (message) values(?)", "%{message}" ]
+  config :statement, validate: :array, required: true
+
+  # If this is an unsafe statement, use event.sprintf
+  # This also has potential performance penalties due to having to create a
+  # new statement for each event, rather than adding to the batch and issuing
+  # multiple inserts in 1 go
+  config :unsafe_statement, validate: :boolean, default: false
+
+  # Number of connections in the pool to maintain
+  config :max_pool_size, validate: :number, default: 5
+
+  # Connection timeout
+  config :connection_timeout, validate: :number, default: 10000
+
+  # We buffer a certain number of events before flushing that out to SQL.
+  # This setting controls how many events will be buffered before sending a
+  # batch of events.
+  config :flush_size, validate: :number, default: 1000
+
+  # Set initial interval in seconds between retries. Doubled on each retry up to `retry_max_interval`
+  config :retry_initial_interval, validate: :number, default: 2
+
+  # Maximum time between retries, in seconds
+  config :retry_max_interval, validate: :number, default: 128
+
+  # Any additional custom, retryable SQL state codes.
+  # Suitable for configuring retryable custom JDBC SQL state codes.
+  config :retry_sql_states, validate: :array, default: []
+
+  # Run a connection test on start.
+  config :connection_test, validate: :boolean, default: true
+
+  config :connection_test_query, validate: :string, required: false
+
+  # Maximum number of sequential failed attempts, before we stop retrying.
+  # If set to < 1, then it will infinitely retry.
+  # At the default values this is a little over 10 minutes
+
+  config :max_flush_exceptions, validate: :number, default: 10
+
+  config :max_repeat_exceptions, obsolete: 'This has been replaced by max_flush_exceptions - which behaves slightly differently. Please check the documentation.'
+  config :max_repeat_exceptions_time, obsolete: 'This is no longer required'
+  config :idle_flush_time, obsolete: 'No longer necessary under Logstash v5'
+
+  # Allows the whole event to be converted to JSON
+  config :enable_event_as_json_keyword, validate: :boolean, default: false
+
+  # The magic key used to convert the whole event to JSON. If you need this, and you have the default in your events, you can use this to change your magic keyword.
+  config :event_as_json_keyword, validate: :string, default: '@event'
+
+  def register
+    @logger.info('JDBC - Starting up')
+
+    load_jar_files!
+
+    @stopping = Concurrent::AtomicBoolean.new(false)
+
+    @logger.warn('JDBC - Flush size is set to > 1000') if @flush_size > 1000
+
+    if @statement.empty?
+      @logger.error('JDBC - No statement provided. Configuration error.')
+    end
+
+    if !@unsafe_statement && @statement.length < 2
+      @logger.error("JDBC - Statement has no parameters. No events will be inserted into SQL as you're not passing any event data. Likely configuration error.")
+    end
+
+    setup_and_test_pool!
+  end
+
+  def multi_receive(events)
+    events.each_slice(@flush_size) do |slice|
+      retrying_submit(slice)
+    end
+  end
+
+  def close
+    @stopping.make_true
+    @pool.close
+    super
+  end
+
+  private
+
+  def setup_and_test_pool!
+    # Setup pool
+    @pool = Java::ComZaxxerHikari::HikariDataSource.new
+
+    @pool.setAutoCommit(@driver_auto_commit)
+    @pool.setDriverClassName(@driver_class) if @driver_class
+
+    @pool.setJdbcUrl(@connection_string)
+
+    @pool.setUsername(@username) if @username
+    @pool.setPassword(@password) if @password
+
+    @pool.setMaximumPoolSize(@max_pool_size)
+    @pool.setConnectionTimeout(@connection_timeout)
+
+    validate_connection_timeout = (@connection_timeout / 1000) / 2
+
+    if !@connection_test_query.nil? and @connection_test_query.length > 1
+      @pool.setConnectionTestQuery(@connection_test_query)
+      @pool.setConnectionInitSql(@connection_test_query)
+    end
+
+    return unless @connection_test
+
+    # Test connection
+    test_connection = @pool.getConnection
+    unless test_connection.isValid(validate_connection_timeout)
+      @logger.warn('JDBC - Connection is not reporting as validate. Either connection is invalid, or driver is not getting the appropriate response.')
+    end
+    test_connection.close
+  end
+
+  def load_jar_files!
+    # Load jar from driver path
+    unless @driver_jar_path.nil?
+      raise LogStash::ConfigurationError, 'JDBC - Could not find jar file at given path. Check config.' unless File.exist? @driver_jar_path
+      require @driver_jar_path
+      return
+    end
+
+    # Revert original behaviour of loading from vendor directory
+    # if no path given
+    jarpath = if ENV['LOGSTASH_HOME']
+                File.join(ENV['LOGSTASH_HOME'], '/vendor/jar/jdbc/*.jar')
+              else
+                File.join(File.dirname(__FILE__), '../../../vendor/jar/jdbc/*.jar')
+              end
+
+    @logger.trace('JDBC - jarpath', path: jarpath)
+
+    jars = Dir[jarpath]
+    raise LogStash::ConfigurationError, 'JDBC - No jars found. Have you read the README?' if jars.empty?
+
+    jars.each do |jar|
+      @logger.trace('JDBC - Loaded jar', jar: jar)
+      require jar
+    end
+  end
+
+  def create_statement(event)
+    event = event.to_hash
+    hashed = event.delete_if {|k, _v| k.start_with?("@") || k == 'host' || k == 'path' }
+
+    columns = '(' + hashed.keys.join(', ') + ')'
+
+    value_placeholders = ('?' * hashed.length).split('')
+    values = '(' + value_placeholders.join(', ') + ')'
+
+    table_name = create_table_name(event)
+    return "INSERT INTO #{table_name} #{columns} VALUES #{values}", hashed.keys
+  end
+
+  def create_table_name(event)
+    if event.nil? || event.to_hash["event"].nil?
+     raise TableNameNil.new("Table name is nil", event)
+    end
+    event.to_hash["event"].to_s.strip.gsub(/[ -]+/, "_").downcase
+  end
+
+  def prepared_statement(keys)
+    keys.map do |key|
+      turn_into_wrapped(key)
+    end
+  end
+
+  def turn_into_wrapped(key)
+    "[#{key}]"
+  end
+
+  def submit(events)
+    connection = nil
+    statement = nil
+    events_to_retry = []
+
+    begin
+      connection = @pool.getConnection
+    rescue => e
+      log_jdbc_exception(e, true, nil)
+      # If a connection is not available, then the server has gone away
+      # We're not counting that towards our retry count.
+      return events, false
+    end
+
+    events.each do |event|
+
+
+      begin
+        ins, columns = create_statement(event)
+        keys_we_care_about = prepared_statement(columns)
+        statement = connection.prepareStatement(
+          ins
+        )
+        statement = add_statement_event_params(statement, event, keys_we_care_about)
+        statement.execute
+      rescue TableNameNil => e
+        @logger.error("#{e.message} event=#{e.event}")
+      rescue => e
+        @logger.error "Rescue from SQLException #{e.message}"
+        create_statement = make_create_statement(event, columns)
+        puts 'create_statement'
+        puts create_statement
+
+        statement = connection.prepareStatement(
+          create_statement
+        )
+        statement.execute
+        @logger.debug('Created new Table.')
+        events_to_retry.push(event)
+      ensure
+        statement.close unless statement.nil?
+      end
+    end
+
+    connection.close unless connection.nil?
+
+    return events_to_retry, true
+  end
+
+  def retrying_submit(actions)
+    # Initially we submit the full list of actions
+    submit_actions = actions
+    count_as_attempt = true
+
+    attempts = 1
+
+    sleep_interval = @retry_initial_interval
+    while @stopping.false? and (submit_actions and !submit_actions.empty?)
+      return if !submit_actions || submit_actions.empty? # If everything's a success we move along
+      # We retry whatever didn't succeed
+      submit_actions, count_as_attempt = submit(submit_actions)
+
+      # Everything was a success!
+      break if !submit_actions || submit_actions.empty?
+
+      if @max_flush_exceptions > 0 and count_as_attempt == true
+        attempts += 1
+
+        if attempts > @max_flush_exceptions
+          @logger.error("JDBC - max_flush_exceptions has been reached. #{submit_actions.length} events have been unable to be sent to SQL and are being dropped. See previously logged exceptions for details.")
+          break
+        end
+      end
+
+      # If we're retrying the action sleep for the recommended interval
+      # Double the interval for the next time through to achieve exponential backoff
+      Stud.stoppable_sleep(sleep_interval) { @stopping.true? }
+      sleep_interval = next_sleep_interval(sleep_interval)
+    end
+  end
+
+  def make_create_statement(event, keys_we_care_about)
+    columns = []
+
+    keys_we_care_about.each_with_index do |key, idx|
+      wrapped = turn_into_wrapped(key)
+
+      case event.get(wrapped)
+      when Time, LogStash::Timestamp
+        columns << "#{key} TIMESTAMP"
+      when Integer
+        columns << "#{key} BIGINT"
+      when BigDecimal
+        columns << "#{key} DECIMAL"
+      when Float
+        columns << "#{key} DOUBLE PRECISION"
+      when String, Array, Hash
+        columns << "#{key} VARCHAR"
+      when true, false
+        columns << "#{key} BOOLEAN"
+      end
+    end
+
+    "CREATE TABLE IF NOT EXISTS #{create_table_name(event)} (#{columns.join(', ')})"
+  end
+
+  def add_statement_event_params(statement, event, keys_we_care_about)
+    keys_we_care_about.each_with_index do |key, idx|
+      if @enable_event_as_json_keyword == true and key.is_a? String and key == @event_as_json_keyword
+        value = event.to_json
+      elsif key.is_a? String
+        value = event.get(key)
+        if value.nil? and key =~ /%\{/
+          value = event.sprintf(key)
+        end
+      else
+        value = key
+      end
+
+      case value
+      when Time
+        statement.setString(idx + 1, value.strftime(STRFTIME_FMT))
+      when LogStash::Timestamp
+        statement.setString(idx + 1, value.time.strftime(STRFTIME_FMT))
+      when Integer
+        if value > 2147483647 or value < -2147483648
+          statement.setLong(idx + 1, value)
+        else
+          statement.setInt(idx + 1, value)
+        end
+      when BigDecimal
+        statement.setBigDecimal(idx + 1, value.to_java)
+      when Float
+        statement.setFloat(idx + 1, value)
+      when String
+        statement.setString(idx + 1, value)
+      when Array, Hash
+        statement.setString(idx + 1, value.to_json)
+      when true, false
+        statement.setBoolean(idx + 1, value)
+      else
+        statement.setString(idx + 1, nil)
+      end
+    end
+
+    statement
+  end
+
+  def retry_exception?(exception, event)
+    retrying = (exception.respond_to? 'getSQLState' and (RETRYABLE_SQLSTATE_CLASSES.include?(exception.getSQLState.to_s[0,2]) or @retry_sql_states.include?(exception.getSQLState)))
+    log_jdbc_exception(exception, retrying, event)
+
+    retrying
+  end
+
+  def log_jdbc_exception(exception, retrying, event)
+    current_exception = exception
+    log_text = 'JDBC - Exception. ' + (retrying ? 'Retrying' : 'Not retrying')
+
+    log_method = (retrying ? 'warn' : 'error')
+
+    loop do
+      # TODO reformat event output so that it only shows the fields necessary.
+
+      @logger.send(log_method, log_text, :exception => current_exception, :statement => @statement[0], :event => event)
+
+      if current_exception.respond_to? 'getNextException'
+        current_exception = current_exception.getNextException()
+      else
+        current_exception = nil
+      end
+
+      break if current_exception == nil
+    end
+  end
+
+  def next_sleep_interval(current_interval)
+    doubled = current_interval * 2
+    doubled > @retry_max_interval ? @retry_max_interval : doubled
+  end
+end # class LogStash::Outputs::Charrington
+
+class TableNameNil < StandardError
+  attr_reader :event
+
+  def initialize(msg='Table name is nil', event={})
+    @event = event
+    super(msg)
+  end
+end

data/logstash-output-charrington.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-charrington'
+  s.version = '0.1.0'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = 'This plugin allows you to output to SQL, via JDBC'
+  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 'logstash-output-charrington'. This gem is not a stand-alone program"
+  s.authors = ['dconger', 'brianbroderick', 'spencerdcarlson']
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','Gemfile','LICENSE.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', ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_development_dependency 'logstash-devutils'
+
+  s.requirements << "jar 'com.zaxxer:HikariCP', '2.7.2'"
+  s.requirements << "jar 'org.apache.logging.log4j:log4j-slf4j-impl', '2.6.2'"
+
+  s.add_development_dependency 'jar-dependencies'
+  s.add_development_dependency 'ruby-maven', '~> 3.3'
+  s.add_development_dependency 'rubocop', '0.41.2'
+end

data/spec/charrington_spec_helper.rb

@@ -0,0 +1,216 @@
+require 'logstash/devutils/rspec/spec_helper'
+require 'logstash/outputs/charrington'
+require 'stud/temporary'
+require 'java'
+require 'securerandom'
+
+RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 80000
+
+RSpec.configure do |c|
+
+  def start_service(name)
+    cmd = "sudo /etc/init.d/#{name}* start"
+
+    `which systemctl`
+    if $?.success?
+      cmd = "sudo systemctl start #{name}"
+    end
+
+    `#{cmd}`
+  end
+
+  def stop_service(name)
+    cmd = "sudo /etc/init.d/#{name}* stop"
+
+    `which systemctl`
+    if $?.success?
+      cmd = "sudo systemctl stop #{name}"
+    end
+
+    `#{cmd}`
+  end
+
+end
+
+RSpec.shared_context 'rspec setup' do
+  it 'ensure jar is available' do
+    expect(ENV[jdbc_jar_env]).not_to be_nil, "#{jdbc_jar_env} not defined, required to run tests"
+    expect(File.exist?(ENV[jdbc_jar_env])).to eq(true), "#{jdbc_jar_env} defined, but not valid"
+  end
+end
+
+RSpec.shared_context 'when initializing' do
+  it 'shouldn\'t register with a missing jar file' do
+    jdbc_settings['driver_jar_path'] = nil
+    plugin = LogStash::Plugin.lookup('output', 'jdbc').new(jdbc_settings)
+    expect { plugin.register }.to raise_error(LogStash::ConfigurationError)
+  end
+end
+
+RSpec.shared_context 'when outputting messages' do
+  let(:logger) {
+    double("logger")
+  }
+
+  let(:jdbc_test_table) do
+    'logstash_output_jdbc_test'
+  end
+
+  let(:jdbc_drop_table) do
+    "DROP TABLE #{jdbc_test_table}"
+  end
+
+  let(:jdbc_statement_fields) do
+    [
+      {db_field: "created_at",       db_type: "datetime",      db_value: '?',  event_field: '@timestamp'},
+      {db_field: "message",          db_type: "varchar(512)",  db_value: '?',  event_field: 'message'},
+      {db_field: "message_sprintf",  db_type: "varchar(512)",  db_value: '?',  event_field: 'sprintf-%{message}'},
+      {db_field: "static_int",       db_type: "int",           db_value: '?',  event_field: 'int'},
+      {db_field: "static_bigint",    db_type: "bigint",        db_value: '?',  event_field: 'bigint'},
+      {db_field: "static_float",     db_type: "float",         db_value: '?',  event_field: 'float'},
+      {db_field: "static_bool",      db_type: "boolean",       db_value: '?',  event_field: 'bool'},
+      {db_field: "static_bigdec",    db_type: "decimal",       db_value: '?',  event_field: 'bigdec'}
+    ]
+  end
+
+  let(:jdbc_create_table) do
+    fields = jdbc_statement_fields.collect { |entry| "#{entry[:db_field]} #{entry[:db_type]} not null" }.join(", ")
+
+    "CREATE table #{jdbc_test_table} (#{fields})"
+  end
+
+  let(:jdbc_drop_table) do
+    "DROP table #{jdbc_test_table}"
+  end
+
+  let(:jdbc_statement) do
+    fields = jdbc_statement_fields.collect { |entry| "#{entry[:db_field]}" }.join(", ")
+    values = jdbc_statement_fields.collect { |entry| "#{entry[:db_value]}" }.join(", ")
+    statement = jdbc_statement_fields.collect { |entry| entry[:event_field] }
+
+    statement.insert(0, "insert into #{jdbc_test_table} (#{fields}) values(#{values})")
+  end
+
+  let(:systemd_database_service) do
+    nil
+  end
+
+  let(:event) do
+    # TODO: Auto generate fields from jdbc_statement_fields
+    LogStash::Event.new({
+      message: "test-message #{SecureRandom.uuid}",
+      float: 12.1,
+      bigint: 4000881632477184,
+      bool: true,
+      int: 1,
+      bigdec: BigDecimal.new("123.123")
+    })
+  end
+
+  let(:plugin) do
+    # Setup logger
+    allow(LogStash::Outputs::Jdbc).to receive(:logger).and_return(logger)
+
+    # XXX: Suppress reflection logging. There has to be a better way around this.
+    allow(logger).to receive(:debug).with(/config LogStash::/)
+
+    # Suppress beta warnings.
+    allow(logger).to receive(:info).with(/Please let us know if you find bugs or have suggestions on how to improve this plugin./)
+
+    # Suppress start up messages.
+    expect(logger).to receive(:info).once.with(/JDBC - Starting up/)
+
+    # Setup plugin
+    output = LogStash::Plugin.lookup('output', 'jdbc').new(jdbc_settings)
+    output.register
+
+    output
+  end
+
+  before :each do
+    # Setup table
+    c = plugin.instance_variable_get(:@pool).getConnection
+
+    # Derby doesn't support IF EXISTS.
+    # Seems like the quickest solution. Bleurgh.
+    begin
+      stmt = c.createStatement
+      stmt.executeUpdate(jdbc_drop_table)
+    rescue
+      # noop
+    ensure
+      stmt.close
+
+      stmt = c.createStatement
+      stmt.executeUpdate(jdbc_create_table)
+      stmt.close
+      c.close
+    end
+  end
+
+  # Delete table after each
+  after :each do
+    c = plugin.instance_variable_get(:@pool).getConnection
+
+    stmt = c.createStatement
+    stmt.executeUpdate(jdbc_drop_table)
+    stmt.close
+    c.close
+  end
+
+  it 'should save a event' do
+    expect { plugin.multi_receive([event]) }.to_not raise_error
+
+    # Verify the number of items in the output table
+    c = plugin.instance_variable_get(:@pool).getConnection
+
+    # TODO replace this simple count with a check of the actual contents
+
+    stmt = c.prepareStatement("select count(*) as total from #{jdbc_test_table} where message = ?")
+    stmt.setString(1, event.get('message'))
+    rs = stmt.executeQuery
+    count = 0
+    count = rs.getInt('total') while rs.next
+    stmt.close
+    c.close
+
+    expect(count).to eq(1)
+  end
+
+  it 'should not save event, and log an unretryable exception' do
+    e = event
+    original_event = e.get('message')
+    e.set('message', nil)
+
+    expect(logger).to receive(:error).once.with(/JDBC - Exception. Not retrying/, Hash)
+    expect { plugin.multi_receive([event]) }.to_not raise_error
+
+    e.set('message', original_event)
+  end
+
+  it 'it should retry after a connection loss, and log a warning' do
+    skip "does not run as a service, or known issue with test" if systemd_database_service.nil?
+
+    p = plugin
+
+    # Check that everything is fine right now
+    expect { p.multi_receive([event]) }.not_to raise_error
+
+    stop_service(systemd_database_service)
+
+    # Start a thread to restart the service after the fact.
+    t = Thread.new(systemd_database_service) { |systemd_database_service|
+      sleep 20
+
+      start_service(systemd_database_service)
+    }
+
+    t.run
+
+    expect(logger).to receive(:warn).at_least(:once).with(/JDBC - Exception. Retrying/, Hash)
+    expect { p.multi_receive([event]) }.to_not raise_error
+
+    # Wait for the thread to finish
+    t.join
+  end
+end

data/spec/outputs/charrington_mysql_spec.rb

@@ -0,0 +1,24 @@
+# require_relative '../jdbc_spec_helper'
+
+# describe 'logstash-output-jdbc: mysql', if: ENV['JDBC_MYSQL_JAR'] do
+#   include_context 'rspec setup'
+#   include_context 'when outputting messages'
+#
+#   let(:jdbc_jar_env) do
+#     'JDBC_MYSQL_JAR'
+#   end
+#
+#   let(:systemd_database_service) do
+#     'mysql'
+#   end
+#
+#   let(:jdbc_settings) do
+#     {
+#       'driver_class' => 'com.mysql.jdbc.Driver',
+#       'connection_string' => 'jdbc:mysql://localhost/logstash?user=logstash&password=logstash',
+#       'driver_jar_path' => ENV[jdbc_jar_env],
+#       'statement' => jdbc_statement,
+#       'max_flush_exceptions' => 1
+#     }
+#   end
+# end

data/spec/outputs/charrington_postgres_spec.rb

@@ -0,0 +1,42 @@
+# require_relative '../jdbc_spec_helper'
+
+# describe 'logstash-output-jdbc: postgres', if: ENV['JDBC_POSTGRES_JAR'] do
+#   include_context 'rspec setup'
+#   include_context 'when outputting messages'
+#
+#   let(:jdbc_jar_env) do
+#     'JDBC_POSTGRES_JAR'
+#   end
+#
+#   # TODO: Postgres doesnt kill connections fast enough for the test to pass
+#   # Investigate options.
+#
+#   #let(:systemd_database_service) do
+#   #  'postgresql'
+#   #end
+#
+#   let(:jdbc_statement_fields) do
+#     [
+#         {db_field: "created_at",       db_type: "timestamp",     db_value: 'CAST(? as timestamp)',  event_field: '@timestamp'},
+#         {db_field: "message",          db_type: "varchar(512)",  db_value: '?',                     event_field: 'message'},
+#         {db_field: "message_sprintf",  db_type: "varchar(512)",  db_value: '?',                     event_field: 'sprintf-%{message}'},
+#         {db_field: "static_int",       db_type: "int",           db_value: '?',                     event_field: 'int'},
+#         {db_field: "static_bigint",    db_type: "bigint",        db_value: '?',                     event_field: 'bigint'},
+#         {db_field: "static_float",     db_type: "float",         db_value: '?',                     event_field: 'float'},
+#         {db_field: "static_bool",      db_type: "boolean",       db_value: '?',                     event_field: 'bool'},
+#         {db_field: "static_bigdec",    db_type: "decimal",       db_value: '?',                     event_field: 'bigdec'}
+#
+#     ]
+#   end
+#
+#   let(:jdbc_settings) do
+#     {
+#         'driver_class' => 'org.postgresql.Driver',
+#         'connection_string' => 'jdbc:postgresql://localhost/logstash?user=logstash&password=logstash',
+#         'driver_jar_path' => ENV[jdbc_jar_env],
+#         'statement' => jdbc_statement,
+#         'max_flush_exceptions' => 1
+#     }
+#   end
+# end
+

data/spec/outputs/charrington_spec.rb

@@ -0,0 +1,11 @@
+# require_relative '../charrington_spec_helper'
+#
+# describe LogStash::Outputs::Jdbc do
+#   context 'when initializing' do
+#     it 'shouldn\'t register without a config' do
+#       expect do
+#         LogStash::Plugin.lookup('output', 'charrington').new
+#       end.to raise_error(LogStash::ConfigurationError)
+#     end
+#   end
+# end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-charrington
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dconger
+- brianbroderick
+- spencerdcarlson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2019-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: jar-dependencies
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  name: ruby-maven
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.41.2
+  name: rubocop
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.41.2
+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 'logstash-output-charrington'.
+  This gem is not a stand-alone program
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- THANKS.md
+- lib/com/zaxxer/HikariCP/2.7.2/HikariCP-2.7.2.jar
+- lib/logstash-output-charrington_jars.rb
+- lib/logstash/outputs/charrington.rb
+- lib/org/apache/logging/log4j/log4j-api/2.6.2/log4j-api-2.6.2.jar
+- lib/org/apache/logging/log4j/log4j-slf4j-impl/2.6.2/log4j-slf4j-impl-2.6.2.jar
+- lib/org/slf4j/slf4j-api/1.7.25/slf4j-api-1.7.25.jar
+- logstash-output-charrington.gemspec
+- spec/charrington_spec_helper.rb
+- spec/outputs/charrington_mysql_spec.rb
+- spec/outputs/charrington_postgres_spec.rb
+- spec/outputs/charrington_spec.rb
+- vendor/jar-dependencies/runtime-jars/HikariCP-2.7.2.jar
+- vendor/jar-dependencies/runtime-jars/log4j-api-2.6.2.jar
+- vendor/jar-dependencies/runtime-jars/log4j-slf4j-impl-2.6.2.jar
+- vendor/jar-dependencies/runtime-jars/slf4j-api-1.7.25.jar
+- vendor/postgresql-42.2.5.jar
+- vendor/redshift.jar
+homepage:
+licenses:
+- Apache License (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:
+- jar 'com.zaxxer:HikariCP', '2.7.2'
+- jar 'org.apache.logging.log4j:log4j-slf4j-impl', '2.6.2'
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
+specification_version: 4
+summary: This plugin allows you to output to SQL, via JDBC
+test_files:
+- spec/charrington_spec_helper.rb
+- spec/outputs/charrington_mysql_spec.rb
+- spec/outputs/charrington_postgres_spec.rb
+- spec/outputs/charrington_spec.rb