logstash-output-cassandra 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb924301f2fb18274dadf7937c5fb10ddab91a80
+  data.tar.gz: d05bf1803112c866ffdc2ac13d5a7f4116709f31
+SHA512:
+  metadata.gz: ad63bb3d2685b22ec636c0af391689b4353231f448b2806bb05c2617dfa2cfcc391772ba7d1b23c921eccaad1281c63f7ccd080ba3d8463299d14df9f01a029d
+  data.tar.gz: 1dcda642fb5e9ab2f26930810ecc8ef99253a0cea977fb242823892a50e38fcd1025f17dc6a6ef42a44d6d0505c663d3293271e6e57a41d8846b865f52de0cad

data/CONTRIBUTORS

@@ -0,0 +1,7 @@
+The following is a list of people who have contributed (in chronological order) ideas, code, bug
+reports, or in general have helped this plugin along its way.
+
+Contributors:
+* Oleg Tokarev (otokarev)
+* Elad Amit (eladamitpxi, amitelad7)
+* Valentin Fischer (valentinul)

data/Gemfile

@@ -0,0 +1,4 @@
+#ruby=jruby
+#ruby-gemset=logstash-output-cassandra
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,218 @@
+<<<<<<< HEAD
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
+
+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.
+=======
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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.
+
+>>>>>>> 56f47bec0cc3d3230ae48792e7ac094823872298

data/README.md

@@ -0,0 +1,148 @@
+# Logstash Cassandra Output 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.
+
+It was originally a fork of the [logstash-output-cassandra](https://github.com/otokarev/logstash-output-cassandra) plugin by [Oleg Tokarev](https://github.com/otokarev), which has gone unmaintained and went through a major re-design in this version we built.
+
+## Usage
+
+<pre><code>
+output {
+    cassandra {
+        # List of Cassandra hostname(s) or IP-address(es)
+        hosts => [ "cass-01", "cass-02" ]
+
+        # The port cassandra is listening to
+        port => 9042
+
+        # The protocol version to use with cassandra
+        protocol_version => 4
+
+        # Cassandra consistency level.
+        # Options: "any", "one", "two", "three", "quorum", "all", "local_quorum", "each_quorum", "serial", "local_serial", "local_one"
+        # Default: "one"
+        consistency => 'any'
+
+        # The keyspace to use
+        keyspace => "a_ks"
+
+        # The table to use (event level processing (e.g. %{[key]}) is supported)
+        table => "%{[@metadata][cassandra_table]}"
+
+        # Username
+        username => "cassandra"
+
+        # Password
+        password => "cassandra"
+
+        # An optional hints hash which will be used in case filter_transform or filter_transform_event_key are not in use
+        # It is used to trigger a forced type casting to the cassandra driver types in
+        # the form of a hash from column name to type name in the following manner:
+        hints => {
+            id => "int"
+            at => "timestamp"
+            resellerId => "int"
+            errno => "int"
+            duration => "float"
+            ip => "inet"
+        }
+
+        # The retry policy to use (the default is the default retry policy)
+        # the hash requires the name of the policy and the params it requires
+        # The available policy names are:
+        # * default => retry once if needed / possible
+        # * downgrading_consistency => retry once with a best guess lowered consistency
+        # * failthrough => fail immediately (i.e. no retries)
+        # * backoff => a version of the default retry policy but with configurable backoff retries
+        # The backoff options are as follows:
+        # * backoff_type => either * or ** for linear and exponential backoffs respectively
+        # * backoff_size => the left operand for the backoff type in seconds
+        # * retry_limit => the maximum amount of retries to allow per query
+        # example:
+        # using { "type" => "backoff" "backoff_type" => "**" "backoff_size" => 2 "retry_limit" => 10 } will perform 10 retries with the following wait times: 1, 2, 4, 8, 16, ... 1024
+        # NOTE: there is an underlying assumption that the insert query is idempotent !!!
+        # NOTE: when the backoff retry policy is used, it will also be used to handle pure client timeouts and not just ones coming from the coordinator
+        retry_policy => { "type" => "default" }
+
+        # The command execution timeout
+        request_timeout => 1
+
+        # Ignore bad values
+        ignore_bad_values => false
+
+        # In Logstashes >= 2.2 this setting defines the maximum sized bulk request Logstash will make
+        # You you may want to increase this to be in line with your pipeline's batch size.
+        # If you specify a number larger than the batch size of your pipeline it will have no effect,
+        # save for the case where a filter increases the size of an inflight batch by outputting
+        # events.
+        #
+        # In Logstashes <= 2.1 this plugin uses its own internal buffer of events.
+        # This config option sets that size. In these older logstashes this size may
+        # have a significant impact on heap usage, whereas in 2.2+ it will never increase it.
+        # To make efficient bulk API calls, we will buffer a certain number of
+        # events before flushing that out to Cassandra. This setting
+        # controls how many events will be buffered before sending a batch
+        # of events. Increasing the `flush_size` has an effect on Logstash's heap size.
+        # Remember to also increase the heap size using `LS_HEAP_SIZE` if you are sending big commands
+        # or have increased the `flush_size` to a higher value.
+        flush_size => 500
+
+        # The amount of time since last flush before a flush is forced.
+        #
+        # This setting helps ensure slow event rates don't get stuck in Logstash.
+        # For example, if your `flush_size` is 100, and you have received 10 events,
+        # and it has been more than `idle_flush_time` seconds since the last flush,
+        # Logstash will flush those 10 events automatically.
+        #
+        # This helps keep both fast and slow log streams moving along in
+        # near-real-time.
+        idle_flush_time => 1
+    }
+}
+</code></pre>
+
+## Running Plugin in Logstash
+### Run in a local Logstash clone
+
+Edit Logstash Gemfile and add the local plugin path, for example:
+```
+gem "logstash-output-cassandra", :path => "/your/local/logstash-output-cassandra"
+```
+
+Install plugin
+```
+bin/plugin install --no-verify
+```
+Run Logstash with the plugin
+```
+bin/logstash -e 'output {cassandra {}}'
+```
+
+### Run in an installed Logstash
+
+You can use the same 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
+```
+gem build logstash-output-cassandra.gemspec
+```
+Install the plugin from the Logstash home
+```
+bin/plugin install /your/local/plugin/logstash-output-cassandra.gem
+```
+Run Logstash with the plugin
+```
+bin/logstash -e 'output {cassandra {}}'
+```
+
+## TODO
+* Finish integration specs
+    * it "properly works with counter columns"
+    * it "properly adds multiple events to multiple tables in the same bulk"
+* Improve retries to include (but probably only handle Errors::Timeout and Errors::NoHostsAvailable):
+    * \#get_query
+    * \#execute_async
+* Upgrade / test with logstash 2.3
+* Upgrade / test with cassandra 3

data/lib/logstash/outputs/cassandra.rb

@@ -0,0 +1,164 @@
+# encoding: utf-8
+require 'logstash/outputs/base'
+require 'logstash/namespace'
+require 'logstash/outputs/cassandra/buffer'
+require 'logstash/outputs/cassandra/event_parser'
+require 'logstash/outputs/cassandra/safe_submitter'
+
+class LogStash::Outputs::CassandraOutput < LogStash::Outputs::Base
+
+  milestone 1
+
+  config_name 'cassandra'
+
+  # List of Cassandra hostname(s) or IP-address(es)
+  config :hosts, :validate => :array, :required => true
+
+  # The port cassandra is listening to
+  config :port, :validate => :number, :default => 9042, :required => true
+
+  # The protocol version to use with cassandra
+  config :protocol_version, :validate => :number, :default => 4
+
+  # Cassandra consistency level.
+  # Options: "any", "one", "two", "three", "quorum", "all", "local_quorum", "each_quorum", "serial", "local_serial", "local_one"
+  # Default: "one"
+  config :consistency, :validate => [ 'any', 'one', 'two', 'three', 'quorum', 'all', 'local_quorum', 'each_quorum', 'serial', 'local_serial', 'local_one' ], :default => 'one'
+
+  # The keyspace to use
+  config :keyspace, :validate => :string, :required => true
+
+  # The table to use (event level processing (e.g. %{[key]}) is supported)
+  config :table, :validate => :string, :required => true
+
+  # Username
+  config :username, :validate => :string, :required => true
+
+  # Password
+  config :password, :validate => :string, :required => true
+
+  # An optional hash describing how / what to transform / filter from the original event
+  # Each key is expected to be of the form { event_key => "..." column_name => "..." cassandra_type => "..." }
+  # Event level processing (e.g. %{[key]}) is supported for all three
+  config :filter_transform, :validate => :array, :default => []
+
+  # An optional string which points to the event specific location from which to pull the filter_transform definition
+  # The contents need to conform with those defined for the filter_transform config setting
+  # Event level processing (e.g. %{[key]}) is supported
+  config :filter_transform_event_key, :validate => :string, :default => nil
+
+  # An optional hints hash which will be used in case filter_transform or filter_transform_event_key are not in use
+  # It is used to trigger a forced type casting to the cassandra driver types in
+  # the form of a hash from column name to type name in the following manner:
+  # hints => {
+  #    id => "int"
+  #    at => "timestamp"
+  #    resellerId => "int"
+  #    errno => "int"
+  #    duration => "float"
+  #    ip => "inet" }
+  config :hints, :validate => :hash, :default => {}
+
+  # The retry policy to use (the default is the default retry policy)
+  # the hash requires the name of the policy and the params it requires
+  # The available policy names are:
+  # * default => retry once if needed / possible
+  # * downgrading_consistency => retry once with a best guess lowered consistency
+  # * failthrough => fail immediately (i.e. no retries)
+  # * backoff => a version of the default retry policy but with configurable backoff retries
+  # The backoff options are as follows:
+  # * backoff_type => either * or ** for linear and exponential backoffs respectively
+  # * backoff_size => the left operand for the backoff type in seconds
+  # * retry_limit => the maximum amount of retries to allow per query
+  # example:
+  # using { "type" => "backoff" "backoff_type" => "**" "backoff_size" => 2 "retry_limit" => 10 } will perform 10 retries with the following wait times: 1, 2, 4, 8, 16, ... 1024
+  # NOTE: there is an underlying assumption that the insert query is idempotent !!!
+  # NOTE: when the backoff retry policy is used, it will also be used to handle pure client timeouts and not just ones coming from the coordinator
+  config :retry_policy, :validate => :hash, :default => { 'type' => 'default' }, :required => true
+
+  # The command execution timeout
+  config :request_timeout, :validate => :number, :default => 1
+
+  # Ignore bad values
+  config :ignore_bad_values, :validate => :boolean, :default => false
+
+  # In Logstashes >= 2.2 this setting defines the maximum sized bulk request Logstash will make
+  # You you may want to increase this to be in line with your pipeline's batch size.
+  # If you specify a number larger than the batch size of your pipeline it will have no effect,
+  # save for the case where a filter increases the size of an inflight batch by outputting
+  # events.
+  #
+  # In Logstashes <= 2.1 this plugin uses its own internal buffer of events.
+  # This config option sets that size. In these older logstashes this size may
+  # have a significant impact on heap usage, whereas in 2.2+ it will never increase it.
+  # To make efficient bulk API calls, we will buffer a certain number of
+  # events before flushing that out to Cassandra. This setting
+  # controls how many events will be buffered before sending a batch
+  # of events. Increasing the `flush_size` has an effect on Logstash's heap size.
+  # Remember to also increase the heap size using `LS_HEAP_SIZE` if you are sending big commands
+  # or have increased the `flush_size` to a higher value.
+  config :flush_size, :validate => :number, :default => 500
+
+  # The amount of time since last flush before a flush is forced.
+  #
+  # This setting helps ensure slow event rates don't get stuck in Logstash.
+  # For example, if your `flush_size` is 100, and you have received 10 events,
+  # and it has been more than `idle_flush_time` seconds since the last flush,
+  # Logstash will flush those 10 events automatically.
+  #
+  # This helps keep both fast and slow log streams moving along in
+  # near-real-time.
+  config :idle_flush_time, :validate => :number, :default => 1
+
+  def register
+    setup_event_parser
+    setup_safe_submitter
+    setup_buffer_and_handler
+  end
+
+  def receive(event)
+    @buffer << @event_parser.parse(event)
+  end
+
+  def multi_receive(events)
+    events.each_slice(@flush_size) do |slice|
+      @safe_submitter.submit(slice.map {|event| @event_parser.parse(event) })
+    end
+  end
+
+  def teardown
+    close
+  end
+
+  def close
+    @buffer.stop
+  end
+
+  def flush
+    @buffer.flush
+  end
+
+  private
+  def setup_event_parser
+    @event_parser = ::LogStash::Outputs::Cassandra::EventParser.new(
+      'logger' => @logger, 'table' => @table,
+      'filter_transform_event_key' => @filter_transform_event_key, 'filter_transform' => @filter_transform,
+      'hints' => @hints, 'ignore_bad_values' => @ignore_bad_values
+    )
+  end
+
+  def setup_safe_submitter
+    @safe_submitter = ::LogStash::Outputs::Cassandra::SafeSubmitter.new(
+      'logger' => @logger, 'cassandra' => ::Cassandra,
+      'hosts' => @hosts, 'port' => @port, 'username' => @username, 'password' => @password,
+      'consistency' => @consistency, 'request_timeout' => @request_timeout, 'retry_policy' => @retry_policy,
+      'keyspace' => @keyspace
+    )
+  end
+
+  def setup_buffer_and_handler
+    @buffer = ::LogStash::Outputs::Cassandra::Buffer.new(@logger, @flush_size, @idle_flush_time) do |actions|
+      @safe_submitter.submit(actions)
+    end
+  end
+end