http

Synopsys

http {
    # This output lets you send events to a generic HTTP(S) endpoint
    # This setting can be dynamic using the %{foo} syntax.
    url => ""

}

Available settings

Setting Type Info Default value
codec codec "json", "line", "pp" or "rubydebug" "json"
add_field hash {}
url string required ""
headers hash {"Content-Type" => "application/json"}
http_method string "post"
keepalive bool true
pool_max int 1
connect_timeout uint 5
request_timeout uint 30
retryable_codes array [429, 500, 502, 503, 504]
ignorable_codes array []
batch_interval uint 5
batch_size uint 100
retry_interval uint 10

Details

codec

  • Value type is codec
  • Possible values : "json", "line", "pp" or "rubydebug"
  • 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 bitfan pipeline

    add_field

  • Value type is hash
  • Default value is {}
  • Add a field to an event. Default value is {}

    url

  • This is a required setting
  • Value type is string
  • Default value is ""
  • This output lets you send events to a generic HTTP(S) endpoint This setting can be dynamic using the %{foo} syntax.

    headers

  • Value type is hash
  • Default value is {"Content-Type" => "application/json"}
  • Custom headers to use format is headers => {“X-My-Header”, “%{host}”}. Default value is {} This setting can be dynamic using the %{foo} syntax.

    http_method

  • Value type is string
  • Default value is "post"
  • The HTTP Verb. One of “put”, “post”, “patch”, “delete”, “get”, “head”. Default value is “post”

    keepalive

  • Value type is bool
  • Default value is true
  • Turn this on to enable HTTP keepalive support. Default value is true

    pool_max

  • Value type is int
  • Default value is 1
  • Max number of concurrent connections. Default value is 1

    connect_timeout

  • Value type is uint
  • Default value is 5
  • Timeout (in seconds) to wait for a connection to be established. Default value is 10

    request_timeout

  • Value type is uint
  • Default value is 30
  • Timeout (in seconds) for the entire request. Default value is 60

    retryable_codes

  • Value type is array
  • Default value is [429, 500, 502, 503, 504]
  • If encountered as response codes this plugin will retry these requests

    ignorable_codes

  • Value type is array
  • Default value is []
  • If you would like to consider some non-2xx codes to be successes enumerate them here. Responses returning these codes will be considered successes

    batch_interval

  • Value type is uint
  • Default value is 5
  • batch_size

  • Value type is uint
  • Default value is 100
  • retry_interval

  • Value type is uint
  • Default value is 10
  • Full configuration blueprint

    Expand me...