index.asciidoc

Http_poller input plugin

../../../../logstash/docs/include/plugin_header.asciidoc

Description

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.

Example

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
        user => "AzureDiamond"
        password => "hunter2"
        url => "http://localhost:9200/_cluster/health"
        headers => {
          Accept => "application/json"
        }
     }
    }
    request_timeout => 60
    # Supports "cron", "every", "at" and "in" schedules by rufus scheduler
    schedule => { cron => "* * * * * UTC"}
    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
  }
}

Using the HTTP poller with custom a custom CA or self signed cert.

If you have a self signed cert you will need to convert your server’s certificate to a valid# .jks or .p12 file. An easy way to do it is to run the following one-liner, substituting your server’s URL for the placeholder MYURL and MYPORT.

openssl s_client -showcerts -connect MYURL:MYPORT </dev/null 2>/dev/null|openssl x509 -outform PEM > downloaded_cert.pem; keytool -import -alias test -file downloaded_cert.pem -keystore downloaded_truststore.jks

The above snippet will create two files downloaded_cert.pem and downloaded_truststore.jks. You will be prompted to set a password for the jks file during this process. To configure logstash use a config like the one that follows.

 http_poller {
   urls => {
     myurl => "https://myhostname:1234"
   }
   truststore => "/path/to/downloaded_truststore.jks"
   truststore_password => "mypassword"
   schedule => { cron => "* * * * * UTC"}
 }

Using Http_poller to query Elasticsearch

This plugin can be used to send a request body to Elasticsearch then process the response. This is especially useful for getting aggregation results.

http_poller {
  urls => {
    myESurl => {
      url => "http://localhost:9200/metricbeat-*/_search"
      body => '{"aggs":{"1":{"avg":{"field":"system.cpu.total.pct"}}},"size":0,"query":{"bool":{"must":[{"range":{"@timestamp":{"gte":"now-10m/m","lte":"now/m"}}}]}}}'
      method => post
      headers => {
        "Content-Type" => "application/json"
      }
    }
  }
  schedule => { every => "10m" }
}

Http_poller Input Configuration Options

This plugin supports the following configuration options plus the [plugins-inputs-http_poller-common-options] described later.

Setting	Input type	Required
user	string	no
password	password	No
automatic_retries	number	No
[plugins-inputs-http_poller-body]	string	no
cacert	a valid filesystem path	No
client_cert	a valid filesystem path	No
client_key	a valid filesystem path	No
connect_timeout	number	No
cookies	boolean	No
follow_redirects	boolean	No
keepalive	boolean	No
keystore	a valid filesystem path	No
keystore_password	password	No
keystore_type	string	No
metadata_target	string	No
pool_max	number	No
pool_max_per_route	number	No
proxy	<<,>>	No
request_timeout	number	No
retry_non_idempotent	boolean	No
schedule	hash	Yes
socket_timeout	number	No
target	string	No
truststore	a valid filesystem path	No
truststore_password	password	No
truststore_type	string	No
urls	hash	Yes
validate_after_inactivity	number	No

Also see [plugins-inputs-http_poller-common-options] for a list of options supported by all input plugins.

 

user

• Value type is string

• There is no default value for this setting.

Username to use with HTTP authentication for ALL requests. Note that you can also set this per-URL. If you set this you must also set the password option.

password

• Value type is password

• There is no default value for this setting.

Password to be used in conjunction with the username for HTTP authentication.

automatic_retries

• 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! Note: if retry_non_idempotent is set only GET, HEAD, PUT, DELETE, OPTIONS, and TRACE requests will be retried.

id="plugins-inputs-http_poller-body"] ===== body

• Value type is string

• There is no default value for this setting.

Request body to send with each request. Note that you must set this per-URL.

cacert

• 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

• 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

• 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

• Value type is number

• Default value is 10

Timeout (in seconds) to wait for a connection to be established. Default is 10s

cookies

• 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

• Value type is boolean

• Default value is true

Should redirects be followed? Defaults to true

keepalive

• 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

• 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

• 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

• Value type is string

• Default value is "JKS"

Specify the keystore type here. One of JKS or PKCS12. Default is JKS

metadata_target

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

pool_max

• Value type is number

• Default value is 50

Max number of concurrent connections. Defaults to 50

pool_max_per_route

• Value type is number

• Default value is 25

Max number of concurrent connections to a single host. Defaults to 25

proxy

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

1. Proxy host in form: http://proxy.org:1234

2. Proxy host in form: {host ⇒ "proxy.org", port ⇒ 80, scheme ⇒ 'http', user ⇒ 'username@host', password ⇒ 'password'}

3. Proxy host in form: {url ⇒ 'http://proxy.org:1234', user ⇒ 'username@host', password ⇒ 'password'}

request_timeout

• Value type is number

• Default value is 60

Timeout (in seconds) for the entire request.

retry_non_idempotent

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

schedule

• Value type is hash

• There is no default value for this setting.

Schedule of when to periodically poll from the urls Format: A hash with + key: "cron" | "every" | "in" | "at" + value: string Examples: a) { "every" ⇒ "1h" } b) { "cron" ⇒ "* * * * * UTC" } See: rufus/scheduler for details about different schedule options and value string format

socket_timeout

• Value type is number

• Default value is 10

Timeout (in seconds) to wait for data on the socket. Default is 10s

target

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

truststore

• 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

• 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

• Value type is string

• Default value is "JKS"

Specify the truststore type here. One of JKS or PKCS12. Default is JKS

urls

• This is a required setting.

• Value type is hash

• There is no default value for this setting.

A Hash of urls in this format : "name" ⇒ "url". The name and the url will be passed in the outputed event

validate_after_inactivity

• Value type is number

• Default value is 200

How long to wait before checking for a stale connection to determine if a keepalive request is needed. Consider setting this value lower than the default, possibly to 0, if you get connection errors regularly.

This client is based on Apache Commons' HTTP implementation. Here’s how the Apache Commons documentation describes this option: "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."

../../../../logstash/docs/include/input.asciidoc