Http output plugin
editHttp output plugin
edit- Plugin version: v5.7.0
- Released on: 2024-06-19
- Changelog
For other versions, see the Versioned plugin docs.
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.
Retry policy
editThis output has two levels of retry: library and plugin.
Library retry
editThe library retry applies to IO related failures. Non retriable errors include SSL related problems, unresolvable hosts, connection issues, and OS/JVM level interruptions happening during a request.
The options for library retry are:
-
automatic_retries
. Controls the number of times the plugin should retry after failures at the library level. -
retry_non_idempotent
. When set tofalse
, GET, HEAD, PUT, DELETE, OPTIONS, and TRACE requests will be retried.
Plugin retry
editThe options for plugin level retry are:
-
retry_failed
. When set totrue
, the plugin retries indefinitely for HTTP error response codes defined in theretryable_codes
option (429, 500, 502, 503, 504) and retryable exceptions (socket timeout/ error, DNS resolution failure and client protocol exception). -
retryable_codes
. Sets http response codes that trigger a retry.
The retry_failed
option does not control the library level retry.
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 |
Deprecated |
|
a valid filesystem path |
Deprecated |
|
a valid filesystem path |
Deprecated |
|
No |
||
No |
||
No |
||
No |
||
string, one of |
No |
|
No |
||
No |
||
string, one of |
Yes |
|
No |
||
No |
||
a valid filesystem path |
Deprecated |
|
Deprecated |
||
Deprecated |
||
No |
||
No |
||
No |
||
No |
||
<<,>> |
No |
|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
list of path |
No |
|
list of string |
No |
|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
string, one of |
No |
|
a valid filesystem path |
Deprecated |
|
Deprecated |
||
Deprecated |
||
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 recommend setting this option
to a value other than zero if the keepalive
option is enabled.
Some servers incorrectly end keepalives early, requiring a retry.
See Retry Policy for more information.
cacert
editDeprecated in 5.6.0.
Replaced by ssl_certificate_authorities
- 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
editDeprecated in 5.6.0.
Replaced by ssl_certificate
- 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
editDeprecated in 5.6.0.
Replaced by ssl_key
- 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
editDeprecated in 5.6.0.
Replaced by ssl_keystore_path
- 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
editDeprecated in 5.6.0.
Replaced by ssl_keystore_password
- 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
editDeprecated in 5.6.0.
Replaced by ssl_keystore_type
- 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
Note that this option controls plugin-level retries only. It has no affect on library-level retries.
Set this option to false
if you want to disable infinite retries for HTTP error response codes defined in the retryable_codes
or
retryable exceptions (Timeout, SocketException, ClientProtocolException, ResolutionFailure and SocketTimeout).
See Retry policy for more information.
retry_non_idempotent
edit- Value type is boolean
-
Default value is
false
When this option is set to false
and automatic_retries
is enabled, GET, HEAD, PUT, DELETE, OPTIONS, and TRACE requests will be retried.
When set to true
and automatic_retries
is enabled, this will cause non-idempotent HTTP verbs (such as POST) to be retried.
See Retry Policy for more information.
retryable_codes
edit- Value type is number
-
Default value is
[429, 500, 502, 503, 504]
If the plugin encounters these response codes, the plugin will retry indefinitely. See Retry Policy for more information.
socket_timeout
edit- Value type is number
-
Default value is
10
Timeout (in seconds) to wait for data on the socket. Default is 10s
ssl_certificate
edit- Value type is path
- There is no default value for this setting.
SSL certificate to use to authenticate the client. This certificate should be an OpenSSL-style X.509 certificate file.
This setting can be used only if ssl_key
is set.
ssl_certificate_authorities
edit- Value type is a list of path
- There is no default value for this setting
The .cer or .pem CA files to validate the server’s certificate.
ssl_cipher_suites
edit- Value type is a list of string
- There is no default value for this setting
The list of cipher suites to use, listed by priorities. Supported cipher suites vary depending on the Java and protocol versions.
ssl_enabled
edit- Value type is boolean
-
Default value is
true
Enable SSL/TLS secured communication. It must be true
for other ssl_
options
to take effect.
ssl_key
edit- Value type is path
- There is no default value for this setting.
OpenSSL-style RSA private key that corresponds to the ssl_certificate
.
This setting can be used only if ssl_certificate
is set.
ssl_keystore_password
edit- Value type is password
- There is no default value for this setting.
Set the keystore password
ssl_keystore_path
edit- Value type is path
- There is no default value for this setting.
The keystore used to present a certificate to the server.
It can be either .jks
or .p12
ssl_keystore_type
edit-
Value can be any of:
jks
,pkcs12
- If not provided, the value will be inferred from the keystore filename.
The format of the keystore file. It must be either jks
or pkcs12
.
ssl_supported_protocols
edit- Value type is string
-
Allowed values are:
'TLSv1.1'
,'TLSv1.2'
,'TLSv1.3'
-
Default depends on the JDK being used. With up-to-date Logstash, the default is
['TLSv1.2', 'TLSv1.3']
.'TLSv1.1'
is not considered secure and is only provided for legacy applications.
List of allowed SSL/TLS versions to use when establishing a connection to the HTTP endpoint.
For Java 8 'TLSv1.3'
is supported only since 8u262 (AdoptOpenJDK), but requires that you set the
LS_JAVA_OPTS="-Djdk.tls.client.protocols=TLSv1.3"
system property in Logstash.
If you configure the plugin to use 'TLSv1.1'
on any recent JVM, such as the one packaged with Logstash,
the protocol is disabled by default and needs to be enabled manually by changing jdk.tls.disabledAlgorithms
in
the $JDK_HOME/conf/security/java.security configuration file. That is, TLSv1.1
needs to be removed from the list.
ssl_truststore_password
edit- Value type is password
- There is no default value for this setting.
Set the truststore password
ssl_truststore_path
edit- Value type is path
- There is no default value for this setting.
The truststore to validate the server’s certificate.
It can be either .jks
or .p12
.
ssl_truststore_type
edit-
Value can be any of:
jks
,pkcs12
- If not provided, the value will be inferred from the truststore filename.
The format of the truststore file. It must be either jks
or pkcs12
.
ssl_verification_mode
edit- Value type is string
-
Supported values are:
full
,none
-
Default value is
full
Controls the verification of server certificates.
The full
option verifies that the provided certificate is signed by a trusted authority (CA)
and also that the server’s hostname (or IP address) matches the names identified within the certificate.
The none
setting performs no verification of the server’s certificate.
This mode disables many of the security benefits of SSL/TLS and should only be used after cautious consideration.
It is primarily intended as a temporary diagnostic mechanism when attempting to resolve TLS errors.
Using none
in production environments is strongly discouraged.
truststore
editDeprecated in 5.6.0.
Replaced by ssl_truststore_path
- 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
editDeprecated in 5.6.0.
Replaced by ssl_truststore_password
- 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
editDeprecated in 5.6.0.
Replaced by ssl_truststore_type
- 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
editThese 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" } }
Variable substitution in the id
field only supports environment variables
and does not support the use of values from the secret store.