http
edithttp
edit
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
http { http_method => ... url => ... }
Available configuration options:
Setting | Input type | Required | Default value |
---|---|---|---|
No |
|
||
a valid filesystem path |
No |
||
a valid filesystem path |
No |
||
a valid filesystem path |
No |
||
No |
|
||
No |
|
||
No |
|||
No |
|
||
No |
|
||
string, one of |
No |
|
|
No |
|||
string, one of |
Yes |
||
No |
|
||
a valid filesystem path |
No |
||
No |
|||
No |
|
||
No |
|||
No |
|||
No |
|
||
No |
|
||
<<,>> |
No |
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
a valid filesystem path |
No |
||
No |
|||
No |
|
||
Yes |
|||
No |
|
Details
edit
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.
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 "form", "application/x-www-form-urlencoded"
format
edit-
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.
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_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"
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}"}
proxy
edit<li> Value type is <<string,string>> * There is no default value for this setting.
url
edit- 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