solr_http

Milestone: 1

This is a community-contributed plugin! It does not ship with logstash by default, but it is easy to install! To use this, you must have installed the contrib plugins package.

This output lets you index&store your logs in Solr. If you want to get started quickly you should use version 4.4 or above in schemaless mode, which will try and guess your fields automatically. To turn that on, you can use the example included in the Solr archive:

tar zxf solr-4.4.0.tgz
cd example
mv solr solr_ #back up the existing sample conf
cp -r example-schemaless/solr/ .  #put the schemaless conf in place
java -jar start.jar   #start Solr

You can learn more about Solr at https://lucene.apache.org/solr/

Synopsis

This is what it might look like in your config file:
output {
  solr_http {
    codec => ... # codec (optional), default: "plain"
    document_id => ... # string (optional), default: nil
    flush_size => ... # number (optional), default: 100
    idle_flush_time => ... # number (optional), default: 1
    solr_url => ... # string (optional), default: "http://localhost:8983/solr"
    workers => ... # number (optional), default: 1
  }
}

Details

codec

  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

document_id

  • Value type is string
  • Default value is nil

Solr document ID for events. You’d typically have a variable here, like ‘%{foo}’ so you can assign your own IDs

exclude_tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

flush_size

  • Value type is number
  • Default value is 100

Number of events to queue up before writing to Solr

idle_flush_time

  • Value type is number
  • Default value is 1

Amount of time since the last flush before a flush is done even if the number of buffered events is smaller than flush_size

solr_url

  • Value type is string
  • Default value is "http://localhost:8983/solr"

URL used to connect to Solr

tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.


This is documentation from lib/logstash/outputs/solr_http.rb