Logstash Plugin
This is a plugin for Logstash. It support SolrCloud not only Standalone Solr.
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.
Config parameters
url
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
$ 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
$ ./bin/solr start -p 8983 -s server/solr
3.Create core
$ ./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
$ 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
$ ./bin/zkServer.sh start
3.Download an install Solr
$ 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
$ ./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
$ ./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.
Developing
1. Plugin Developement and Testing
Code
-
To get started, you'll need JRuby with the Bundler gem installed.
-
Create a new plugin or clone and existing from the GitHub logstash-plugins organization. We also provide example plugins.
-
Install dependencies
bundle install
Test
- Update your dependencies
bundle install
- Run tests
bundle exec rspec
2. Running your unpublished Plugin in Logstash
2.1 Run in a local Logstash clone
- Edit Logstash
Gemfile
and add the local plugin path, for example:
gem "logstash-output-solr", :path => "/your/local/logstash-output-solr"
- Install plugin
bin/plugin install --no-verify
- Run Logstash with your plugin
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
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
gem build logstash-output-solr.gemspec
- Install the plugin from the Logstash home
bin/plugin install /your/local/plugin/logstash-output-solr.gem
- Start Logstash and proceed to test the plugin
Contributing
All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.
It is more important to the community that you are able to contribute.
For more information about contributing, see the CONTRIBUTING file.