http_polleredit
This Logstash input plugin allows you to call an HTTP API, decode the output of it into event(s), and send them on their merry way. The idea behind this plugins came from a need to read springboot metrics endpoint, instead of configuring jmx to monitor my java application memory/gc/ etc.
Exampleedit
Reads from a list of urls and decodes the body of the response with a codec. The config should look like this:
input {
http_poller {
urls => {
test1 => "http://localhost:9200"
test2 => {
# Supports all options supported by ruby's Manticore HTTP client
method => get
url => "http://localhost:9200/_cluster/health"
headers => {
Accept => "application/json"
}
auth => {
user => "AzureDiamond"
password => "hunter2"
}
}
}
request_timeout => 60
interval => 60
codec => "json"
# A hash of request metadata info (timing, response headers, etc.) will be sent here
metadata_target => "http_poller_metadata"
}
}
output {
stdout {
codec => rubydebug
}
}
Synopsisedit
This plugin supports the following configuration options:
Required configuration options:
http_poller {
interval => ...
urls => ...
}
Available configuration options:
| Setting | Input type | Required | Default value |
|---|---|---|---|
No |
|
||
No |
|
||
a valid filesystem path |
No |
||
a valid filesystem path |
No |
||
a valid filesystem path |
No |
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
Yes |
|||
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 |
|
||
No |
|||
Yes |
|||
No |
|
Detailsedit
codecedit
- Value type is codec
-
Default value is
"json"
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.
intervaledit
- This is a required setting.
- Value type is number
- There is no default value for this setting.
How often (in seconds) the urls will be called
metadata_targetedit
- Value type is string
-
Default value is
"@metadata"
If you’d like to work with the request/response metadata. Set this value to the name of the field you’d like to store a nested hash of metadata.
proxyedit
<li> Value type is <<string,string>> * There is no default value for this setting.
tagsedit
- 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.
targetedit
- Value type is string
- There is no default value for this setting.
Define the target field for placing the received data. If this setting is omitted, the data will be stored at the root (top level) of the event.
typeedit
- 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.