IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Heartbeat input plugin Http_poller input plugin »

› ›

Http input plugin

edit

Http input plugin

edit

Plugin version: v3.3.7
Released on: 2021-01-27
Changelog

For other versions, see the Versioned plugin docs.

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

Using this input you can receive single or multiline events over http(s). Applications can send an HTTP request 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.

Blocking Behavior

edit

The HTTP protocol doesn’t deal well with long running requests. This plugin will either return a 429 (busy) error when Logstash is backlogged, or it will time out the request.

If a 429 error is encountered clients should sleep, backing off exponentially with some random jitter, then retry their request.

This plugin will block if the Logstash queue is blocked and there are available HTTP input threads. This will cause most HTTP clients to time out. Sent events will still be processed in this case. This behavior is not optimal and will be changed in a future release. In the future, this plugin will always return a 429 if the queue is busy, and will not time out in the event of a busy queue.

Security

edit

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 multiple options such as validating the client’s certificate.

Codec settings

edit

This plugin has two configuration options for codecs: codec and additional_codecs.

Values in additional_codecs are prioritized over those specified in the codec option. That is, the default codec is applied only if no codec for the request’s content-type is found in the additional_codecs setting.

Http Input Configuration Options

edit

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

Setting	Input type	Required
`additional_codecs`	hash	No
`cipher_suites`	array	No
`host`	string	No
`keystore`	path	No
`keystore_password`	password	No
`password`	password	No
`port`	number	No
`max_pending_requests`	number	No
`response_headers`	hash	No
`response_code`	number, one of `[200, 201, 202, 204]`	No
`ssl`	boolean	No
`ssl_certificate`	a valid filesystem path	No
`ssl_certificate_authorities`	array	No
`ssl_handshake_timeout`	number	No
`ssl_key`	a valid filesystem path	No
`ssl_key_passphrase`	password	No
`ssl_verify_mode`	string, one of `["none", "peer", "force_peer"]`	No
`threads`	number	No
`tls_max_version`	number	No
`tls_min_version`	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_codecs`

edit

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

`cipher_suites`

edit

Value type is array
Default value is java.lang.String[TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256]@459cfcca

The list of ciphers suite to use, listed by priorities.

`host`

edit

Value type is string
Default value is "0.0.0.0"

The host or ip to bind

`keystore`

edit

Value type is path
There is no default value for this setting.
This option is deprecated

The JKS keystore to validate the client’s certificates

Note: This option is deprecated and it will be removed in the next major version of Logstash. Use ssl_certificate and ssl_key instead.

`keystore_password`

edit

Value type is password
There is no default value for this setting.
This option is deprecated

Set the truststore password

Note: This option is deprecated and it will be removed in the next major version of Logstash. Use ssl_certificate and ssl_key instead.

`password`

edit

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

Password for basic authorization

`port`

edit

Value type is number
Default value is 8080

The TCP port to bind to

`max_content_length`

edit

Value type is number
Default value is 104857600

The max content of an HTTP request in bytes. It defaults to 100mb.

`max_pending_requests`

edit

Value type is number
Default value is 200

Maximum number of incoming requests to store in a temporary queue before being processed by worker threads. If a request arrives and the queue is full a 429 response will be returned immediately. This queue exists to deal with micro bursts of events and to improve overall throughput, so it should be changed very carefully as it can lead to memory pressure and impact performance. If you need to deal both periodic or unforeseen spikes in incoming requests consider enabling the Persistent Queue for the logstash pipeline.

`response_code`

edit

Value can be any of: 200, 201, 202, 204
Default value is 200

The HTTP return code if the request is processed successfully.

Other return codes may happen in the case of an error condition, such as invalid credentials (401), internal errors (503) or backpressure (429).

If 204 (No Content) is set, the response body will not be sent in the response.

`response_headers`

edit

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

specify a custom set of response headers

`remote_host_target_field`

edit

Value type is string
Default value is "host"

specify a target field for the client host of the http request

`request_headers_target_field`

edit

Value type is string
Default value is "headers"

specify target field for the client host of the http request

`ssl`

edit

Value type is boolean
Default value is false

Events are by default sent in plain text. You can enable encryption by setting ssl to true and configuring the ssl_certificate and ssl_key options.

`ssl_certificate`

edit

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

SSL certificate to use.

`ssl_certificate_authorities`

edit

Value type is array
Default value is []

Validate client certificates against these authorities. You can define multiple files or paths. All the certificates will be read and added to the trust store. You need to configure the ssl_verify_mode to peer or force_peer to enable the verification.

`ssl_handshake_timeout`

edit

Value type is number
Default value is 10000

Time in milliseconds for an incomplete ssl handshake to timeout

`ssl_key`

edit

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

SSL key to use. NOTE: This key need to be in the PKCS8 format, you can convert it with OpenSSL for more information.

`ssl_key_passphrase`

edit

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

SSL key passphrase to use.

`ssl_verify_mode`

edit

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

By default the server doesn’t do any client verification.

peer will make the server ask the client to provide a certificate. If the client provides a certificate, it will be validated.

force_peer will make the server ask the client to provide a certificate. If the client doesn’t provide a certificate, the connection will be closed.

This option needs to be used with ssl_certificate_authorities and a defined list of CAs.

`threads`

edit

Value type is number
Default value is number of processors

Number of threads to use for both accepting connections and handling requests

`tls_max_version`

edit

Value type is number
Default value is 1.2

The maximum TLS version allowed for the encrypted connections. The value must be the one of the following: 1.0 for TLS 1.0, 1.1 for TLS 1.1, 1.2 for TLS 1.2

`tls_min_version`

edit

Value type is number
Default value is 1

The minimum TLS version allowed for the encrypted connections. The value must be one of the following: 1.0 for TLS 1.0, 1.1 for TLS 1.1, 1.2 for TLS 1.2

`user`

edit

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

Username for basic authorization

`verify_mode`

edit

Value can be any of: none, peer, force_peer
Default value is "none"
This option is deprecated

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

Note: This option is deprecated and it will be removed in the next major version of Logstash. Use ssl_verify_mode instead.

Common Options

edit

The following configuration options are supported by all input plugins:

Setting	Input type	Required
`add_field`	hash	No
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No
`tags`	array	No
`type`	string	No

Details

edit

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`codec`

edit

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_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.

`id`

edit

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

input {
  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.

`tags`

edit

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.

`type`

edit

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.

« Heartbeat input plugin Http_poller input plugin »