httpedit

  • Version: 3.0.3
  • Released on: 2016-07-14
  • Changelog
  • Compatible: 5.1.2, 5.1.1, 5.0.0, 2.4.1, 2.4.0

We keep the redefined method in a new http server class, this is because in other parts of logstash we might be using puma as webserver, for example in the sinatra part we need this method to actually return the REQUEST_PATH, so it can actually infer the right resource to use. Fixes https://github.com/logstash-plugins/logstash-input-http/issues/51

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

http {
}

Available configuration options:

Setting Input typeRequiredDefault value

add_field

hash

No

{}

additional_codecs

hash

No

{"application/json"=>"json"}

codec

codec

No

"plain"

enable_metric

boolean

No

true

host

string

No

"0.0.0.0"

id

string

No

keystore

a valid filesystem path

No

keystore_password

password

No

password

password

No

port

number

No

8080

response_headers

hash

No

{"Content-Type"=>"text/plain"}

ssl

boolean

No

false

tags

array

No

threads

number

No

4

type

string

No

user

string

No

verify_mode

string, one of ["none", "peer", "force_peer"]

No

"none"

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

additional_codecsedit

  • Value type is hash
  • Default value is {"application/json"=>"json"}

Apply specific codecs for specific content types. The default codec will be applied only after this list is checked and no codec for the request’s content-type is found

codecedit

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

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

enable_metricedit

  • Value type is boolean
  • Default value is true

Disable or enable metric collection and reporting for this specific plugin instance. By default we record metrics from all plugins, but you can disable metrics collection for a specific plugin.

hostedit

  • Value type is string
  • Default value is "0.0.0.0"

Codec used to decode the incoming data. This codec will be used as a fall-back if the content-type is not found in the "additional_codecs" hash The host or ip to bind

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

Add a unique named ID to the plugin instance. This ID is used for tracking information for a specific configuration of the plugin and will be useful for debugging purposes.

output {
 stdout {
   id => "debug_stdout"
 }
}

If you don’t explicitly set this field, Logstash will generate a unique name.

keystoreedit

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

The JKS keystore to validate the client’s certificates

keystore_passwordedit

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

Set the truststore password

passwordedit

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

Password for basic authorization

portedit

  • Value type is number
  • Default value is 8080

The TCP port to bind to

response_headersedit

  • Value type is hash
  • Default value is {"Content-Type"=>"text/plain"}

specify a custom set of response headers

ssledit

  • Value type is boolean
  • Default value is false

SSL Configurations

Enable SSL

tagsedit

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

Add any number of arbitrary tags to your event.

This can help with processing later.

threadsedit

  • Value type is number
  • Default value is 4

Maximum number of threads to use

typeedit

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

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

useredit

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

Username for basic authorization

verify_modeedit

  • Value can be any of: none, peer, force_peer
  • Default value is "none"

Set the client certificate verification method. Valid methods: none, peer, force_peer