Solr_http output plugin

edit
  • Plugin version: v3.0.5
  • Released on: 2018-04-06
  • Changelog

For other versions, see the Versioned plugin docs.

Installation

edit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-solr_http. See Working with plugins for more details.

Getting help

edit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

edit

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 at the Solr home page

Solr_http Output Configuration Options

edit

This plugin supports the following configuration options plus the Common options described later.

Setting Input type Required

document_id

string

No

flush_size

number

No

idle_flush_time

number

No

solr_url

string

No

Also see Common options for a list of options supported by all output plugins.

 

document_id

edit
  • 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

flush_size

edit
  • Value type is number
  • Default value is 100

Number of events to queue up before writing to Solr

idle_flush_time

edit
  • 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

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

URL used to connect to Solr

Common options

edit

These configuration options are supported by all output plugins:

Setting Input type Required

codec

codec

No

enable_metric

boolean

No

id

string

No

codec

edit
  • 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.

enable_metric

edit
  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 solr_http outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  solr_http {
    id => "my_plugin_id"
  }
}

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.