Http input pluginedit

  • Plugin version: v3.0.5
  • Released on: 2017-06-23
  • Changelog

Getting Helpedit

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.

Descriptionedit

Using this input you can receive single or multiline events over http(s). Applications can send an HTTP POST request with a body to the endpoint started by this input and Logstash will convert it into an event for subsequent processing. Users can pass plain text, JSON, or any formatted data and use a corresponding codec with this input. For Content-Type application/json the json codec is used, but for all other data formats, plain codec is used.

This input can also be used to receive webhook requests to integrate with other services and applications. By taking advantage of the vast plugin ecosystem available in Logstash you can trigger actionable events right from your application.

Securityedit

This plugin supports standard HTTP basic authentication headers to identify the requester. You can pass in a username, password combination while sending data to this input

You can also setup SSL and send data securely over https, with an option of validating the client’s certificate. Currently, the certificate setup is through Java Keystore format

Http Input Configuration Optionsedit

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

Setting Input typeRequired

additional_codecs

hash

No

host

string

No

keystore

a valid filesystem path

No

keystore_password

password

No

password

password

No

port

number

No

response_headers

hash

No

ssl

boolean

No

threads

number

No

user

string

No

verify_mode

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

No

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

 

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

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

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

threadsedit

  • Value type is number
  • Default value is 4

Maximum number of threads to use

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

Common Optionsedit

The following configuration options are supported by all input plugins:

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

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 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 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

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.

typeedit

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

This is the base class for Logstash inputs. 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.