logstash-output-solr 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38b9cc03511ee8a4bf31c90c2dd774fc22e18ac6
-  data.tar.gz: 817cce20b93a0adfd67908a074cf7c2066bdb61c
+  metadata.gz: 5cbd829a77c764d7b526d66cc7416606e484cdd0
+  data.tar.gz: 0d697136ead9938e9b75067021d2d106326d8173
 SHA512:
-  metadata.gz: 57828ac60e065ecf652c49ba91500bef3fb962b2246c2a8868fbd62fb0428cadfab8ff159b7078d1774f6944feae080e0a31fd751882e3e9a6aa733e065567c9
-  data.tar.gz: b8fadbde9a065fbbfeff162929e4b344163fecef1bd2703a3617b3a70b6e491fd7d07f1c05d147df4881110542c06304b64e8419ad305a9f759b4d4a4e4672e2
+  metadata.gz: a57339df7bb7aa5b38497a7db8d4fad4586a82ce32ba39bf847fc5d16bb424f63acabc52cb28d50b6df02605b46a736d422d44c06fb8bcaafa606f579dc3e9c8
+  data.tar.gz: 322ccddd33ac5e2248ff94abf5383fc0ee9a9140975caed9946a4c29e1d0169a6e3c33d8929f6293b50aa688d346cb09850a6d8d941ba63b5820f24d5a3cfac1

data/CHANGELOG.md

@@ -1,2 +1,8 @@
+## 0.2.0
+ - Bug fix.
+
+## 0.2.0
+ - Supports SolrCloud.
+
 ## 0.1.0
  - First release.

data/README.md

@@ -4,16 +4,169 @@ This is a plugin for [Logstash](https://github.com/elastic/logstash). It support
 
 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.
 
-## Documentation
+## Config parameters
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+### url
 
-- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+The Solr server url (for example http://localhost:8983/solr/collection1).
+
+```
+url http://localhost:8983/solr/collection1
+```
+
+### zk_host
+
+The ZooKeeper connection string that SolrCloud refers to (for example localhost:2181/solr).
+
+```
+zk_host localhost:2181/solr
+```
+
+### collection
+
+The SolrCloud collection name (default collection1).
+
+```
+collection collection1
+```
+
+### defined_fields
+
+The defined fields in the Solr schema.xml. If omitted, it will get fields via Solr Schema API.
+
+```
+defined_fields ["id", "title"]
+```
+
+### ignore_undefined_fields
+
+Ignore undefined fields in the Solr schema.xml.
+
+```
+ignore_undefined_fields false
+```
+
+### unique_key_field
+
+A field name of unique key in the Solr schema.xml. If omitted, it will get unique key via Solr Schema API.
+
+```
+unique_key_field id
+```
+
+### timestamp_field
+
+A field name of event timestamp in the Solr schema.xml (default event_timestamp).
+
+```
+timestamp_field event_timestamp
+```
+
+### flush_size
+
+A number of events to queue up before writing to Solr (default 100).
+
+```
+flush_size 100
+```
+
+## Plugin setup examples
+
+### Sent to standalone Solr using data-driven schemaless mode.
+```
+output {
+  solr {
+    url => "http://localhost:8983/solr/collection1"
+  }
+}
+
+```
+
+### Sent to SolrCloud using data-driven schemaless mode.
+```
+output {
+  solr {
+    zk_host => "localhost:2181/solr"
+    collection => "collection1"
+  }
+}
+```
+
+## Solr setup examples
+
+### How to setup Standalone Solr using data-driven schemaless mode.
+
+1.Download and install Solr
+
+```sh
+$ mkdir $HOME/solr
+$ cd $HOME/solr
+$ wget https://archive.apache.org/dist/lucene/solr/5.4.0/solr-5.4.0.tgz
+$ tar zxvf solr-5.4.0.tgz
+$ cd solr-5.4.0
+```
+
+2.Start standalone Solr
+
+```sh
+$ ./bin/solr start -p 8983 -s server/solr
+```
+
+3.Create core
+
+```sh
+$ ./bin/solr create -c collection1 -d server/solr/configsets/data_driven_schema_configs -n collection1_configs
+```
+
+### How to setup SolrCloud using data-driven schemaless mode (shards=1 and replicationfactor=2).
+
+1.Download and install ZooKeeper
+
+```sh
+$ mkdir $HOME/zookeeper
+$ cd $HOME/zookeeper
+$ wget https://archive.apache.org/dist/zookeeper/zookeeper-3.4.6/zookeeper-3.4.6.tar.gz
+$ tar zxvf zookeeper-3.4.6.tar.gz
+$ cd zookeeper-3.4.6
+$ cp -p ./conf/zoo_sample.cfg ./conf/zoo.cfg
+```
+
+2.Start standalone ZooKeeper
+
+```sh
+$ ./bin/zkServer.sh start
+```
+
+3.Download an install Solr
+
+```sh
+$ mkdir $HOME/solr
+$ cd $HOME/solr
+$ wget https://archive.apache.org/dist/lucene/solr/5.4.0/solr-5.4.0.tgz
+$ tar zxvf solr-5.4.0.tgz
+$ cd solr-5.4.0
+$ ./server/scripts/cloud-scripts/zkcli.sh -zkhost localhost:2181 -cmd clear /solr
+$ ./server/scripts/cloud-scripts/zkcli.sh -zkhost localhost:2181 -cmd makepath /solr
+$ cp -pr server/solr server/solr1
+$ cp -pr server/solr server/solr2
+```
+
+4.Start SolrCloud
+
+```sh
+$ ./bin/solr start -h localhost -p 8983 -z localhost:2181/solr -s server/solr1
+$ ./bin/solr start -h localhost -p 8985 -z localhost:2181/solr -s server/solr2
+```
+
+5.Create collection
+
+```sh
+$ ./bin/solr create -c collection1 -d server/solr1/configsets/data_driven_schema_configs -n collection1_configs -shards 1 -replicationFactor 2
+```
 
 ## Need Help?
 
-Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+Need help? Try #logstash on freenode IRC or the [https://discuss.elastic.co/c/logstash](https://discuss.elastic.co/c/logstash) discussion forum.
 
 ## Developing
 
@@ -48,17 +201,23 @@ bundle exec rspec
 #### 2.1 Run in a local Logstash clone
 
 - Edit Logstash `Gemfile` and add the local plugin path, for example:
+
 ```ruby
-gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+gem "logstash-output-solr", :path => "/your/local/logstash-output-solr"
 ```
+
 - Install plugin
+
 ```sh
 bin/plugin install --no-verify
 ```
+
 - Run Logstash with your plugin
+
 ```sh
-bin/logstash -e 'filter {awesome {}}'
+bin/logstash -e 'output {solr {}}'
 ```
+
 At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
 
 #### 2.2 Run in an installed Logstash
@@ -66,13 +225,17 @@ At this point any modifications to the plugin code will be applied to this local
 You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
 
 - Build your plugin gem
+
 ```sh
-gem build logstash-filter-awesome.gemspec
+gem build logstash-output-solr.gemspec
 ```
+
 - Install the plugin from the Logstash home
+
 ```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+bin/plugin install /your/local/plugin/logstash-output-solr.gem
 ```
+
 - Start Logstash and proceed to test the plugin
 
 ## Contributing

data/lib/logstash/outputs/solr.rb

@@ -77,7 +77,8 @@ class LogStash::Outputs::Solr < LogStash::Outputs::Base
   def flush(events, close=false)
     documents = []
 
-    @fields = @defined_fields.nil? ? get_fields : @defined_fields
+    @fields = @defined_fields.nil? || @defined_fields.empty? ? get_fields : @defined_fields
+
     @unique_key = @unique_key_field.nil? ? get_unique_key : @unique_key_field
 
     events.each do |event|
@@ -99,21 +100,21 @@ class LogStash::Outputs::Solr < LogStash::Outputs::Base
         end
       end
 
-      @logger.info "Record: %s" % document.inspect
+      @logger.info 'Record: %s' % document.inspect
 
       documents.push(document)
     end
 
     if @mode == MODE_STANDALONE then
       @solr.add documents, :params => {:commit => true}
-      @logger.info "Added %d document(s) to Solr" % documents.count
+      @logger.info 'Added %d document(s) to Solr' % documents.count
     elsif @mode == MODE_SOLRCLOUD then
       @solr.add documents, collection: @collection, :params => {:commit => true}
-      @logger.info "Added %d document(s) to Solr" % documents.count
+      @logger.info 'Added %d document(s) to Solr' % documents.count
     end
 
     rescue Exception => e
-      @logger.warn("An error occurred while indexing: #{e.message}")
+      @logger.warn('An error occurred while indexing: #{e.message}')
   end # def flush
 
   public
@@ -134,12 +135,12 @@ class LogStash::Outputs::Solr < LogStash::Outputs::Base
     end
 
     unique_key = response['uniqueKey']
-    @logger.info "Unique key: #{unique_key}"
+    @logger.info 'Unique key: #{unique_key}'
 
     return unique_key
 
     rescue Exception => e
-      @logger.warn "Unique key: #{e.message}"
+      @logger.warn 'Unique key: #{e.message}'
   end # def get_unique_key
 
   private
@@ -156,11 +157,11 @@ class LogStash::Outputs::Solr < LogStash::Outputs::Base
     response['fields'].each do |field|
       fields.push(field['name'])
     end
-    @logger.info "Fields: #{fields}"
+    @logger.info 'Fields: #{fields}'
 
     return fields
 
     rescue Exception => e
-      @logger.warn "Fields: #{e.message}"
+      @logger.warn 'Fields: #{e.message}'
   end # def get_fields
 end # class LogStash::Outputs::Solr

data/logstash-output-solr.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-output-solr'
-  s.version = "0.2.0"
+  s.version = "0.3.0"
   s.licenses = ["Apache License (2.0)"]
   s.summary = "Logstash output plugin for sending data to Solr."
   s.description = "Logstash output plugin for sending data to Solr. It support SolrCloud not only Standalone Solr."
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "logstash-codec-plain"
   s.add_runtime_dependency 'rsolr', '~> 1.0.13'
   s.add_runtime_dependency 'zk', '~> 1.9.6'
-  s.add_runtime_dependency 'rsolr-cloud', '~> 1.0.0'
+  s.add_runtime_dependency 'rsolr-cloud', '~> 1.1.0'
   s.add_runtime_dependency 'stud', '~> 0.0.22'
 
   s.add_development_dependency "logstash-devutils", '~> 0.0.18'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-solr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Minoru Osuka
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -77,7 +77,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   name: rsolr-cloud
   prerelease: false
   type: :runtime
@@ -85,7 +85,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements: