fluent-plugin-cassandra-cql 0.0.1

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--backtrace
+--default_path spec

data/.simplecov

@@ -0,0 +1,5 @@
+# configure code coverage
+SimpleCov.start do
+  # exclude directories and files
+  add_filter "/spec/"
+end

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "fluentd", ">=0.10.27"
+gem "cassandra-cql", ">=1.1.3"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem "rdoc", ">= 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.8.4"
+  gem "rspec", ">= 0"
+  gem "simplecov"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 obie quelland
+
+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,54 @@
+# Cassandra plugin for Fluentd
+
+Cassandra output plugin for Fluentd.
+
+Implemented using the cassandra-cql gem and targets CQL 3.0.0
+and Cassandra 1.1.x
+
+# Raison d'être
+Currently, there's another Fluentd Cassandra plugin [see
+here](https://github.com/tomitakazutaka/fluent-plugin-cassandra)
+
+It's implemented via the Twitter Cassandra gem, which:
+
+    a) doesn't provide all of the niceties of CQL, i.e., create/alter/delete keyspaces/columnfamilies
+    b) doesn't allow a desktop client to make a call to a Cassandra instance hosted on EC2
+       (the gem resolves a cassandra node's IP address to its private EC2
+        IP address (ex: 10.x.x.x), which isn't accessible outside EC2)
+
+# Installation
+
+via RubyGems
+
+    gem install fluent-plugin-cassandra-cql
+
+# Quick Start
+
+## Cassandra Configuration
+    # create keyspace (via CQL)
+      CREATE KEYSPACE \"FluentdLoggers\" WITH strategy_class='org.apache.cassandra.locator.SimpleStrategy' AND strategy_options:replication_factor=1;
+
+    # create table (column family)
+      CREATE TABLE events (id varchar, ts bigint, payload text, PRIMARY KEY (id, ts)) WITH CLUSTERING ORDER BY (ts DESC);
+      
+
+## Fluentd.conf Configuration
+    <match cassandra.**>
+      type cassandra
+      host 127.0.0.1             # cassandra hostname.
+      port 9160                  # cassandra thrft port.
+      keyspace FluentdLoggers    # cassandra keyspace
+      columnfamily events        # cassandra column family
+      ttl 60                     # cassandra ttl *optional => default is 0*
+    </match>
+
+# Tests
+
+rake rspec
+
+NOTE: requires that cassandra be installed on the machine running the tests
+
+# TODOs
+    1) make host and port configurable for tests
+    2) make schema definition configurable
+    3) add rake task to generate keyspace and columnfamily

data/Rakefile

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fluent-plugin-cassandra-cql"
+  gem.homepage = "http://github.com/obieq/fluent-plugin-cassandra-cql"
+  gem.license = "MIT"
+  gem.summary = %Q{Fluent output plugin for Cassandra}
+  gem.description = %Q{Fluent output plugin for Cassandra via CQL version 3.0.0}
+  gem.email = "quelland@gmail.com"
+  gem.authors = ["obie quelland"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fluent-plugin-cassandra-cql #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Get spec rake tasks working in RSpec 2.0
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/fluent-plugin-cassandra-cql.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "fluent-plugin-cassandra-cql"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["obie quelland"]
+  s.date = "2012-11-07"
+  s.description = "Fluent output plugin for Cassandra via CQL version 3.0.0"
+  s.email = "quelland@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".rspec",
+    ".simplecov",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "fluent-plugin-cassandra-cql.gemspec",
+    "lib/fluent/plugin/out_cassandra.rb",
+    "spec/cassandra_output_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/obieq/fluent-plugin-cassandra-cql"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.19"
+  s.summary = "Fluent output plugin for Cassandra"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<fluentd>, [">= 0.10.27"])
+      s.add_runtime_dependency(%q<cassandra-cql>, [">= 1.1.3"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<fluentd>, [">= 0.10.27"])
+      s.add_dependency(%q<cassandra-cql>, [">= 1.1.3"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<fluentd>, [">= 0.10.27"])
+    s.add_dependency(%q<cassandra-cql>, [">= 1.1.3"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/fluent/plugin/out_cassandra.rb

@@ -0,0 +1,68 @@
+require 'cassandra-cql'
+require 'msgpack'
+require 'json'
+
+module Fluent
+
+  class CassandraOutput < BufferedOutput
+    Fluent::Plugin.register_output('cassandra', self)
+    include SetTimeKeyMixin
+    include SetTagKeyMixin
+
+    config_param :host,         :string
+    config_param :port,         :integer
+    config_param :keyspace,     :string
+    config_param :columnfamily, :string
+    config_param :ttl,          :integer, :default => 0
+
+    def connection
+      @connection ||= get_connection
+    end
+
+    #config_set_default :include_time_key, true
+    #config_set_default :include_tag_key, true
+    #config_set_default :time_format, "%Y%m%d%H%M%S"
+
+    def configure(conf)
+      super
+
+      raise ConfigError, "'Host' is required by Cassandra output (ex: localhost, 127.0.0.1, ec2-54-242-141-252.compute-1.amazonaws.com" unless self.keyspace = conf['keyspace']
+      raise ConfigError, "'Port' is required by Cassandra output (ex: 9160)" unless self.columnfamily = conf['columnfamily']
+      raise ConfigError, "'Keyspace' is required by Cassandra output (ex: FluentdLoggers)" unless self.keyspace = conf['keyspace']
+      raise ConfigError, "'ColumnFamily' is required by Cassandra output (ex: events)" unless self.columnfamily = conf['columnfamily']
+
+      #@host = conf.has_key?('host') ? conf['host'] : 'localhost'
+      #@port = conf.has_key?('port') ? conf['port'] : 9160
+    end
+
+    def start
+      super
+      connection
+    end
+
+    def shutdown
+      super
+    end
+
+    def format(tag, time, record)
+      record.to_msgpack
+    end
+
+    def write(chunk)
+      chunk.msgpack_each  { |record|
+        @connection.execute("INSERT INTO #{self.columnfamily} (id, ts, payload) " +
+                            "VALUES ('#{record['tag']}', #{record['time']}, '#{record.to_json}') " +
+                            "USING TTL #{self.ttl}")
+      }
+    end
+
+    private
+
+    def get_connection
+      connection_string = "#{self.host}:#{self.port}"
+      ::CassandraCQL::Database.new(connection_string, {:keyspace => "\"#{self.keyspace}\"", :cql_version => "3.0.0"})
+    end
+
+  end
+
+end

data/spec/cassandra_output_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+Fluent::Test.setup
+
+CONFIG = %[
+  host 127.0.0.1
+  port 9160
+  keyspace FluentdLoggers
+  columnfamily events
+]
+
+describe Fluent::CassandraOutput do
+  let(:driver) { Fluent::Test::BufferedOutputTestDriver.new(Fluent::CassandraOutput, 'test') }
+
+  after(:each) do
+    d = Fluent::Test::BufferedOutputTestDriver.new(Fluent::CassandraOutput, 'test')
+    d.configure(CONFIG)
+    d.instance.connection.execute("TRUNCATE events")
+  end
+
+  def add_ttl_to_config(ttl)
+    return CONFIG + %[  ttl #{ttl}\n]
+  end
+
+  context 'configuring' do
+
+    it 'should be properly configured' do
+      driver.configure(CONFIG)
+      driver.tag.should eq('test')
+      driver.instance.host.should eq('127.0.0.1')
+      driver.instance.port.should eq(9160)
+      driver.instance.keyspace.should eq('FluentdLoggers')
+      driver.instance.columnfamily.should eq('events')
+      driver.instance.ttl.should eq(0)
+    end
+
+    it 'should configure ttl' do
+      ttl = 20
+      driver.configure(add_ttl_to_config(ttl))
+      driver.instance.ttl.should eq(ttl)
+    end
+
+    describe 'exceptions' do
+
+      it 'should raise an exception if host is not configured' do
+        expect { driver.configure(CONFIG.gsub("host", "invalid_config_name")) }.to raise_error Fluent::ConfigError
+      end
+
+      it 'should raise an exception if port is not configured' do
+        expect { driver.configure(CONFIG.gsub("port", "invalid_config_name")) }.to raise_error Fluent::ConfigError
+      end
+
+      it 'should raise an exception if keyspace is not configured' do
+        expect { driver.configure(CONFIG.gsub("keyspace", "invalid_config_name")) }.to raise_error Fluent::ConfigError
+      end
+
+      it 'should raise an exception if columnfamily is not configured' do
+        expect { driver.configure(CONFIG.gsub("columnfamily", "invalid_config_name")) }.to raise_error Fluent::ConfigError
+      end
+
+    end
+
+  end
+
+  context 'fluentd logging' do
+
+    it 'should start' do
+      driver.configure(CONFIG)
+      driver.instance.start
+    end
+
+    it 'should shutdown' do
+      driver.configure(CONFIG)
+      driver.instance.start
+      driver.instance.shutdown
+    end
+
+    it 'should format' do
+      driver.configure(CONFIG)
+      time = Time.now.to_i
+      record = {'tag' => 'test', 'time' => time, 'a' => 1}
+
+      driver.emit(record)
+      driver.expect_format(record.to_msgpack)
+      driver.run
+    end
+
+    it 'should write' do
+      driver.configure(CONFIG)
+      tag1 = "test1"
+      tag2 = "test2"
+      time1 = Time.now.to_i
+      time2 = Time.now.to_i + 2
+      record1 = {'tag' => tag1, 'time' => time1, 'a' => 10, 'b' => 'Tesla'}
+      record2 = {'tag' => tag2, 'time' => time2, 'a' => 20, 'b' => 'Edison'}
+      records = [record1, record2]
+
+      driver.emit(records[0])
+      driver.emit(records[1])
+      driver.run # persists to cassandra
+
+      # query cassandra to verify data was correctly persisted
+      row_num = records.count # non-zero based index
+      events = driver.instance.connection.execute("SELECT * FROM events")
+      events.rows.should eq(records.count)
+      events.fetch do | event | # events should be sorted desc by tag, then time
+        row_num -= 1 # zero-based index
+        hash = event.to_hash
+        hash['id'].should eq(records[row_num]['tag'])
+        hash['ts'].should eq(records[row_num]['time'])
+        hash['payload'].should eq(records[row_num].to_json)
+      end
+    end
+
+    it 'should not locate event after ttl has expired' do
+      time = Time.now.to_i
+      tag = "ttl_test"
+      ttl = 1 # set ttl to 1 second
+
+      driver.configure(add_ttl_to_config(ttl))
+      driver.emit({'tag' => tag, 'time' => time, 'a' => 1})
+      driver.run
+
+      # verify record... should return in less than one sec if hitting
+      #                  cassandra running on localhost
+      events = driver.instance.connection.execute("SELECT * FROM events where ts = #{time}")
+      events.rows.should eq(1)
+
+      # now, sleep long enough for the event to be expired from cassandra
+      sleep(ttl)
+
+      # re-query and verify that no events were returned
+      events = driver.instance.connection.execute("SELECT * FROM events where ts = #{time}")
+      events.rows.should eq(0)
+    end
+
+  end
+
+end # CassandraOutput

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'simplecov'
+require 'rspec'
+require 'fluent/test'
+
+# require the library files
+Dir["./lib/**/*.rb"].each {|f| require f}
+
+# require the shared example files
+#Dir["./spec/support/**/*.rb"].each {|f| require f}

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-cassandra-cql
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- obie quelland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.27
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.27
+- !ruby/object:Gem::Dependency
+  name: cassandra-cql
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluent output plugin for Cassandra via CQL version 3.0.0
+email: quelland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .rspec
+- .simplecov
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- fluent-plugin-cassandra-cql.gemspec
+- lib/fluent/plugin/out_cassandra.rb
+- spec/cassandra_output_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: http://github.com/obieq/fluent-plugin-cassandra-cql
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -709806578343991657
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Fluent output plugin for Cassandra
+test_files: []