Http output plugin
editHttp output plugin
edit- Plugin version: v5.2.5
- Released on: 2021-05-27
- Changelog
For other versions, see the Versioned plugin docs.
Installation
editFor plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-http
. See Working with plugins for more details.
Getting Help
editFor 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
editThis output lets you send events to a generic HTTP(S) endpoint.
This output will execute up to pool_max requests in parallel for performance. Consider this when tuning this plugin for performance.
Additionally, note that when parallel execution is used strict ordering of events is not guaranteed!
Beware, this gem does not yet support codecs. Please use the format option for now.
Http Output Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
a valid filesystem path |
No |
|
a valid filesystem path |
No |
|
a valid filesystem path |
No |
|
No |
||
No |
||
No |
||
No |
||
string, one of |
No |
|
No |
||
No |
||
string, one of |
Yes |
|
No |
||
No |
||
a valid filesystem path |
No |
|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
<<,>> |
No |
|
No |
||
No |
||
No |
||
No |
||
No |
||
a valid filesystem path |
No |
|
No |
||
No |
||
Yes |
||
No |
Also see Common Options for a list of options supported by all output plugins.
automatic_retries
edit- Value type is number
-
Default value is
1
How many times should the client retry a failing URL. We highly recommend NOT setting this value
to zero if keepalive is enabled. Some servers incorrectly end keepalives early requiring a retry!
Only IO related failures will be retried, such as connection timeouts and unreachable hosts.
Valid but non 2xx HTTP responses will always be retried, regardless of the value of this setting,
unless retry_failed
is set.
Note: if retry_non_idempotent
is NOT set only GET, HEAD, PUT, DELETE, OPTIONS, and TRACE requests will be retried.
cacert
edit- Value type is path
- There is no default value for this setting.
If you need to use a custom X.509 CA (.pem certs) specify the path to that here
client_cert
edit- Value type is path
- There is no default value for this setting.
If you’d like to use a client certificate (note, most people don’t want this) set the path to the x509 cert here
client_key
edit- Value type is path
- There is no default value for this setting.
If you’re using a client certificate specify the path to the encryption key here
connect_timeout
edit- Value type is number
-
Default value is
10
Timeout (in seconds) to wait for a connection to be established. Default is 10s
content_type
edit- Value type is string
- There is no default value for this setting.
Content type
If not specified, this defaults to the following:
- if format is "json", "application/json"
- if format is "json_batch", "application/json". Each Logstash batch of events will be concatenated into a single array and sent in one request.
- if format is "form", "application/x-www-form-urlencoded"
cookies
edit- Value type is boolean
-
Default value is
true
Enable cookie support. With this enabled the client will persist cookies across requests as a normal web browser would. Enabled by default
follow_redirects
edit- Value type is boolean
-
Default value is
true
Should redirects be followed? Defaults to true
format
edit-
Value can be any of:
json
,json_batch
,form
,message
-
Default value is
"json"
Set the format of the http body.
If json_batch, each batch of events received by this output will be placed into a single JSON array and sent in one request. This is particularly useful for high throughput scenarios such as sending data between Logstash instaces.
If form, then the body will be the mapping (or whole event) converted
into a query parameter string, e.g. foo=bar&baz=fizz...
If message, then the body will be the result of formatting the event according to message
Otherwise, the event is sent as json.
headers
edit- Value type is hash
- There is no default value for this setting.
Custom headers to use
format is headers => ["X-My-Header", "%{host}"]
http_compression
edit- Value type is boolean
-
Default value is
false
Enable request compression support. With this enabled the plugin will compress http requests using gzip.
http_method
edit- This is a required setting.
-
Value can be any of:
put
,post
,patch
,delete
,get
,head
- There is no default value for this setting.
The HTTP Verb. One of "put", "post", "patch", "delete", "get", "head"
ignorable_codes
edit- Value type is number
- There is no default value for this setting.
If you would like to consider some non-2xx codes to be successes enumerate them here. Responses returning these codes will be considered successes
keepalive
edit- Value type is boolean
-
Default value is
true
Turn this on to enable HTTP keepalive support. We highly recommend setting automatic_retries
to at least
one with this to fix interactions with broken keepalive implementations.
keystore
edit- Value type is path
- There is no default value for this setting.
If you need to use a custom keystore (.jks
) specify that here. This does not work with .pem keys!
keystore_password
edit- Value type is password
- There is no default value for this setting.
Specify the keystore password here. Note, most .jks files created with keytool require a password!
keystore_type
edit- Value type is string
-
Default value is
"JKS"
Specify the keystore type here. One of JKS
or PKCS12
. Default is JKS
mapping
edit- Value type is hash
- There is no default value for this setting.
This lets you choose the structure and parts of the event that are sent.
For example:
mapping => {"foo" => "%{host}" "bar" => "%{type}"}
pool_max
edit- Value type is number
-
Default value is
50
Max number of concurrent connections. Defaults to 50
pool_max_per_route
edit- Value type is number
-
Default value is
25
Max number of concurrent connections to a single host. Defaults to 25
proxy
edit- Value type is string
- There is no default value for this setting.
If you’d like to use an HTTP proxy . This supports multiple configuration syntaxes:
-
Proxy host in form:
http://proxy.org:1234
-
Proxy host in form:
{host => "proxy.org", port => 80, scheme => 'http', user => 'username@host', password => 'password'}
-
Proxy host in form:
{url => 'http://proxy.org:1234', user => 'username@host', password => 'password'}
request_timeout
edit- Value type is number
-
Default value is
60
This module makes it easy to add a very fully configured HTTP client to logstash based on [Manticore](https://github.com/cheald/manticore). For an example of its usage see https://github.com/logstash-plugins/logstash-input-http_poller Timeout (in seconds) for the entire request
retry_failed
edit- Value type is boolean
-
Default value is
true
Set this to false if you don’t want this output to retry failed requests
retry_non_idempotent
edit- Value type is boolean
-
Default value is
false
If automatic_retries
is enabled this will cause non-idempotent HTTP verbs (such as POST) to be retried.
This only affects connectivity related errors (see related automatic_retries
setting).
retryable_codes
edit- Value type is number
-
Default value is
[429, 500, 502, 503, 504]
If encountered as response codes this plugin will retry these requests
socket_timeout
edit- Value type is number
-
Default value is
10
Timeout (in seconds) to wait for data on the socket. Default is 10s
truststore
edit- Value type is path
- There is no default value for this setting.
If you need to use a custom truststore (.jks
) specify that here. This does not work with .pem certs!
truststore_password
edit- Value type is password
- There is no default value for this setting.
Specify the truststore password here. Note, most .jks files created with keytool require a password!
truststore_type
edit- Value type is string
-
Default value is
"JKS"
Specify the truststore type here. One of JKS
or PKCS12
. Default is JKS
url
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
URL to use
validate_after_inactivity
edit- Value type is number
-
Default value is
200
How long to wait before checking if the connection is stale before executing a request on a connection using keepalive. You may want to set this lower, possibly to 0 if you get connection errors regularly Quoting the Apache commons docs (this client is based Apache Commmons): Defines period of inactivity in milliseconds after which persistent connections must be re-validated prior to being leased to the consumer. Non-positive value passed to this method disables connection validation. This check helps detect connections that have become stale (half-closed) while kept inactive in the pool. See these docs for more info
Common Options
editThe following configuration options are supported by all output plugins:
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.
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 outputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { http { id => "my_plugin_id" } }