fluent-plugin-out-solr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc782b093daee34447a02fd38a5329ea324b5451
+  data.tar.gz: f9d6ed5c4ee8e56adf8bbda753cbf099a02d9eda
+SHA512:
+  metadata.gz: 1c6087383a13c05b88f30e4d14553e17852cce81bd3181b958a3329354d59328fd253527a4281b54d9d3506c74725aa88e44498af7aa5fe87e5059a21c8fd765
+  data.tar.gz: 0a5ef15f05a429891962cd8661b3507ccab8c911638b1d2eec38e80da1b21bd8435099dedc16c20c37b7193fdd5e46485ea780710081e5ac7802133addc38a0f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2012 Uken Games
+Copyright (c) HARUYAMA Seigo
+
+MIT License
+
+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,75 @@
+# fluent-plugin-out-solr
+
+Yet another Solr output plugin for fluentd based on [uken/fluent-plugin-elasticsearch](https://github.com/uken/fluent-plugin-elasticsearch).
+
+Notice: no relationship with [btigit/fluent-plugin-solr](https://github.com/btigit/fluent-plugin-solr).
+
+## Installation
+
+    $ gem install fluent-plugin-out-solr
+
+## Usage
+
+### fluent.conf snippet
+
+```
+<source>
+  type tail
+  format apache
+  path /tmp/access.log
+  tag apache.access
+</source>
+
+<match apache.*>
+  type solr
+  host localhost
+  port 8983
+  core collection1
+  include_tag_key true
+  tag_key tag
+  flush_interval 3s
+</match>
+```
+
+### solrconfig.xml snippet
+
+See: [UniqueKey - Solr Wiki](https://wiki.apache.org/solr/UniqueKey)
+
+```xml
+  <requestHandler name="/update" class="solr.UpdateRequestHandler">
+    <lst name="defaults">
+      <str name="update.chain">uuid</str>
+    </lst>
+  </requestHandler>
+
+  <updateRequestProcessorChain name="uuid">
+    <processor class="solr.UUIDUpdateProcessorFactory">
+      <str name="fieldName">id</str>
+    </processor>
+    <processor class="solr.RunUpdateProcessorFactory" />
+  </updateRequestProcessorChain>
+```
+
+### schema.xml snippet
+
+```xml
+   <field name="id"      type="uuid"   indexed="true" stored="true" required="true"/>
+
+   <field name="host"    type="string"  indexed="true" stored="true"/>
+   <field name="user"    type="string"  indexed="true" stored="true"/>
+   <field name="method"  type="string"  indexed="true" stored="true"/>
+   <field name="path"    type="string"  indexed="true" stored="true"/>
+   <field name="code"    type="string"  indexed="true" stored="true"/>
+   <field name="size"    type="string"  indexed="true" stored="true"/>
+   <field name="referer" type="string"  indexed="true" stored="true"/>
+   <field name="agent"   type="text_ws" indexed="true" stored="true"/>
+   <field name="tag"     type="string"  indexed="true" stored="true"/>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+

data/fluent-plugin-out-solr.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'fluent-plugin-out-solr'
+  s.version       = '0.0.1'
+  s.authors       = ['diogo', 'pitr', 'haruyama']
+  s.email         = ['team@uken.com', 'haruyama@unixuser.org']
+  s.description   = %q{Solr output plugin for Fluent event collector}
+  s.summary       = s.description
+  s.homepage      = 'https://github.com/haruyama/fluent-plugin-out-solr'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'fluentd'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'webmock'
+end

data/lib/fluent/plugin/out_solr.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+require 'net/http'
+require 'uri'
+
+# Solr output plugin for Fluent
+class Fluent::SolrOutput < Fluent::BufferedOutput
+  Fluent::Plugin.register_output('solr', self)
+
+  config_param :host,       :string,  default: 'localhost'
+  config_param :port,       :integer, default: 8983
+  config_param :core,       :string,  default: 'collection1'
+
+  include Fluent::SetTagKeyMixin
+  config_set_default :include_tag_key, false
+
+  def initialize
+    super
+  end
+
+  def configure(conf)
+    super
+  end
+
+  def start
+    super
+  end
+
+  def format(tag, time, record)
+    [tag, time, record].to_msgpack
+  end
+
+  def shutdown
+    super
+  end
+
+  def write(chunk)
+    bulk_message = []
+
+    chunk.msgpack_each do |tag, time, record|
+      record.merge!(@tag_key => tag) if @include_tag_key
+
+      bulk_message << record
+    end
+
+    http = Net::HTTP.new(@host, @port.to_i)
+    request = Net::HTTP::Post.new('/solr/' + URI.escape(@core) + '/update', 'content-type' => 'application/json; charset=utf-8')
+    request.body = Yajl::Encoder.encode(bulk_message)
+    http.request(request).value
+  end
+end

data/test/helper.rb

@@ -0,0 +1 @@
+require 'minitest/pride'

data/test/plugin/.rubocop.yml

@@ -0,0 +1,25 @@
+LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: true
+  CountComments: false # count full line comments?
+  Max: 50
+
+FavorSprintf:
+  Enabled: false
+
+MultilineBlocks:
+  Enabled: false
+
+AvoidPerlBackrefs:
+  Enabled: false
+
+PercentLiterals:
+  Enabled: false
+
+BraceAfterPercent:
+  Enabled: false
+
+ClassLength:
+  Enabled: false

data/test/plugin/test_out_solr.rb

@@ -0,0 +1,116 @@
+require 'test/unit'
+
+require 'fluent/test'
+require 'fluent/plugin/out_solr'
+
+require 'webmock/test_unit'
+require 'date'
+
+require 'helper'
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.dirname(__FILE__)
+
+WebMock.disable_net_connect!
+
+# Solr output test
+class SolrOutput < Test::Unit::TestCase
+  attr_accessor :index_cmds, :content_type
+
+  def setup
+    Fluent::Test.setup
+    @driver = nil
+  end
+
+  def driver(tag = 'test', conf = '')
+    @driver ||= Fluent::Test::BufferedOutputTestDriver.new(Fluent::SolrOutput, tag).configure(conf)
+  end
+
+  def sample_record
+    { 'age' => 26, 'request_id' => '42' }
+  end
+
+  def stub_solr(url = 'http://localhost:8983/solr/collection1/update')
+    stub_request(:post, url).with do |req|
+      @content_type = req.headers['Content-Type']
+      @index_cmds = JSON.parse(req.body)
+    end
+  end
+
+  def stub_solr_unavailable(url = 'http://localhost:8983/solr/collection1/update')
+    stub_request(:post, url).to_return(status: [503, 'Service Unavailable'])
+  end
+
+  def test_writes_to_default_index
+    stub_solr
+    driver.emit(sample_record)
+    driver.run
+    assert_equal(26,   @index_cmds[0]['age'])
+    assert_equal('42', @index_cmds[0]['request_id'])
+  end
+
+  def test_wrties_with_proper_content_type
+    stub_solr
+    driver.emit(sample_record)
+    driver.run
+    assert_equal('application/json; charset=utf-8', @content_type)
+  end
+
+  def test_writes_to_speficied_core
+    driver.configure("core mycore\n")
+    solr_request = stub_solr('http://localhost:8983/solr/mycore/update')
+    driver.emit(sample_record)
+    driver.run
+    assert_requested(solr_request)
+  end
+
+  def test_writes_to_speficied_host
+    driver.configure("host 192.168.33.50\n")
+    solr_request = stub_solr('http://192.168.33.50:8983/solr/collection1/update')
+    driver.emit(sample_record)
+    driver.run
+    assert_requested(solr_request)
+  end
+
+  def test_writes_to_speficied_port
+    driver.configure("port 9201\n")
+    solr_request = stub_solr('http://localhost:9201/solr/collection1/update')
+    driver.emit(sample_record)
+    driver.run
+    assert_requested(solr_request)
+  end
+
+  def test_makebulk
+    stub_solr
+    driver.emit(sample_record)
+    driver.emit(sample_record.merge('age' => 27))
+    driver.run
+    assert_equal(2, index_cmds.count)
+    assert_equal(26, @index_cmds[0]['age'])
+    assert_equal(27, @index_cmds[1]['age'])
+  end
+
+  def test_doesnt_add_tag_key_by_default
+    stub_solr
+    driver.emit(sample_record)
+    driver.run
+    assert_nil(index_cmds[0]['tag'])
+  end
+
+  def test_adds_tag_key_when_configured
+    driver('mytag').configure("include_tag_key true\n")
+    stub_solr
+    driver.emit(sample_record)
+    driver.run
+    assert(index_cmds[0].key?('tag'))
+    assert_equal(index_cmds[0]['tag'], 'mytag')
+  end
+
+  def test_request_error
+    stub_solr_unavailable
+    driver.emit(sample_record)
+    assert_raise(Net::HTTPFatalError) do
+      driver.run
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-out-solr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- diogo
+- pitr
+- haruyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Solr output plugin for Fluent event collector
+email:
+- team@uken.com
+- haruyama@unixuser.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-out-solr.gemspec
+- lib/fluent/plugin/out_solr.rb
+- test/helper.rb
+- test/plugin/.rubocop.yml
+- test/plugin/test_out_solr.rb
+homepage: https://github.com/haruyama/fluent-plugin-out-solr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Solr output plugin for Fluent event collector
+test_files:
+- test/helper.rb
+- test/plugin/.rubocop.yml
+- test/plugin/test_out_solr.rb