httpedit

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

http {
    http_method => ...
    url => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

automatic_retries

number

No

1

cacert

a valid filesystem path

No

client_cert

a valid filesystem path

No

client_key

a valid filesystem path

No

codec

codec

No

"plain"

connect_timeout

number

No

10

content_type

string

No

cookies

boolean

No

true

follow_redirects

boolean

No

true

format

string, one of ["json", "form", "message"]

No

"json"

headers

hash

No

http_method

string, one of ["put", "post", "patch", "delete", "get", "head"]

Yes

keepalive

boolean

No

true

keystore

a valid filesystem path

No

keystore_password

password

No

keystore_type

string

No

"JKS"

mapping

hash

No

message

string

No

pool_max

number

No

50

pool_max_per_route

number

No

25

proxy

<<,>>

No

request_timeout

number

No

60

retry_non_idempotent

boolean

No

false

socket_timeout

number

No

10

ssl_certificate_validation

boolean

No

true

truststore

a valid filesystem path

No

truststore_password

password

No

truststore_type

string

No

"JKS"

url

string

Yes

workers

number

No

1

Detailsedit

 

automatic_retriesedit

  • Value type is number
  • Default value is 1

cacertedit

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

client_certedit

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

client_keyedit

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

codecedit

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

connect_timeoutedit

  • Value type is number
  • Default value is 10

content_typeedit

  • 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 "form", "application/x-www-form-urlencoded"

cookiesedit

  • Value type is boolean
  • Default value is true

follow_redirectsedit

  • Value type is boolean
  • Default value is true

formatedit

  • Value can be any of: json, form, message
  • Default value is "json"

Set the format of the http body.

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.

headersedit

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

Custom headers to use format is headers => ["X-My-Header", "%{host}"]

http_methodedit

  • 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"

keepaliveedit

  • Value type is boolean
  • Default value is true

keystoreedit

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

keystore_passwordedit

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

keystore_typeedit

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

mappingedit

  • 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}"}

messageedit

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

pool_maxedit

  • Value type is number
  • Default value is 50

pool_max_per_routeedit

  • Value type is number
  • Default value is 25

proxyedit

<li> Value type is <<string,string>>
* There is no default value for this setting.

request_timeoutedit

  • Value type is number
  • Default value is 60

retry_non_idempotentedit

  • Value type is boolean
  • Default value is false

socket_timeoutedit

  • Value type is number
  • Default value is 10

ssl_certificate_validationedit

  • Value type is boolean
  • Default value is true

truststoreedit

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

truststore_passwordedit

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

truststore_typeedit

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

urledit

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

This 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. URL to use

verify_ssl (DEPRECATED)edit

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is boolean
  • Default value is true

DEPRECATED. Set ssl_certificate_validation instead

workersedit

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.