Synadia Connect

HTTP

NAMERUNTIMETYPEVERSION
http_clientwombatsourcelatest

Connects to a server and continuously performs requests for a single message.

If you enable streaming then the connector will consume the body of the response as a continuous stream of data, breaking messages out following a chosen scanner. This allows you to consume APIs that provide long lived streamed data feeds (such as Twitter).


Configuration

NameTypeOptionalSecretDescription
urlstringnonoThe URL to connect to.
verbstringyesnoA verb to connect with. The value defaults to "GET".
headersheadersyesnoA map of headers to add to the request. The value defaults to {}.
metadatametadatanonoSpecify optional matching rules to determine which metadata keys should be added to the HTTP request as headers.
dump_request_log_levelstringyesnoEXPERIMENTAL: Optionally set a level at which the request and response payload of each request made will be logged. The value should be one of TRACE, DEBUG, INFO, WARN, ERROR, FATAL or ``. The value defaults to "".
oauthoauthnonoAllows you to specify open authentication via OAuth version 1.
oauth2oauth2nonoAllows you to specify open authentication via OAuth version 2 using the client credentials token flow.
basic_authbasic_authnonoAllows you to specify basic authentication.
tlstlsnonoCustom TLS settings can be used to override system defaults.
extract_headersextract_headersnonoSpecify which response headers should be added to resulting messages as metadata. Header keys are lowercased before matching, so ensure that your patterns target lowercased versions of the header keys that you expect.
timeoutstringyesnoA static timeout to apply to requests. The value defaults to "5s".
retry_periodstringyesnoThe base period to wait between failed requests. The value defaults to "1s".
max_retry_backoffstringyesnoThe maximum period to wait between failed requests. The value defaults to "300s".
retriesintyesnoThe maximum number of retry attempts to make. The value defaults to 3.
follow_redirectsboolyesnoWhether or not to transparently follow redirects, i.e. responses with 300-399 status codes. If disabled, the response message will contain the body, status, and headers from the redirect response and the processor will not make a request to the URL set in the Location header of the response. The value defaults to true.
backoff_on[]intyesnoA list of status codes whereby the request should be considered to have failed and retries should be attempted, but the period between them should be increased gradually. The value defaults to [429].
drop_on[]intyesnoA list of status codes whereby the request should be considered to have failed but retries should not be attempted. This is useful for preventing wasted retries for requests that will never succeed. Note that with these status codes the request is dropped, but message that caused the request will not be dropped. The value defaults to [].
successful_on[]intyesnoA list of status codes whereby the attempt should be considered successful, this is useful for dropping requests that return non-2XX codes indicating that the message has been dealt with, such as a 303 See Other or a 409 Conflict. All 2XX codes are considered successful unless they are present within backoff_on or drop_on, regardless of this field. The value defaults to [].
proxy_urlstringnonoAn optional HTTP proxy URL.
disable_http2boolyesnoWhether or not to disable disable HTTP/2. The value defaults to false.
payloadstringnonoAn optional payload to deliver for each request.
drop_empty_bodiesboolyesnoWhether empty payloads received from the target server should be dropped. The value defaults to true.
streamstreamnonoAllows you to set streaming mode, where requests are kept open and messages are processed line-by-line.
auto_replay_nacksboolyesnoWhether messages that are rejected (nacked) at the output level should be automatically replayed indefinitely, eventually resulting in back pressure if the cause of the rejections is persistent. If set to false these messages will instead be deleted. Disabling auto replays can greatly improve memory efficiency of high throughput streams as the original shape of the data can be discarded immediately upon consumption and mutation. The value defaults to true.

Headers

NameTypeOptionalSecretDescription

Metadata

NameTypeOptionalSecretDescription
include_prefixes[]stringyesnoProvide a list of explicit metadata key prefixes to match against. The value defaults to [].
include_patterns[]stringyesnoProvide a list of explicit metadata key regular expression (re2) patterns to match against. The value defaults to [].

OAuth

NameTypeOptionalSecretDescription
enabledboolyesnoWhether to use OAuth version 1 in requests. The value defaults to false.
consumer_keystringyesnoA value used to identify the client to the service provider. The value defaults to "".
consumer_secretstringyesyesA secret used to establish ownership of the consumer key. The value defaults to "".
access_tokenstringyesnoA value used to gain access to the protected resources on behalf of the user. The value defaults to "".
access_token_secretstringyesyesA secret provided in order to establish ownership of a given access token. The value defaults to "".
enabledboolyesnoWhether to use OAuth version 2 in requests. The value defaults to false.
client_keystringyesnoA value used to identify the client to the token provider. The value defaults to "".
client_secretstringyesyesA secret used to establish ownership of the client key. The value defaults to "".
token_urlstringyesnoThe URL of the token provider. The value defaults to "".
scopes[]stringyesnoA list of optional requested permissions. The value defaults to [].
endpoint_paramsendpoint_paramsyesnoA list of optional endpoint parameters, values should be arrays of strings. The value defaults to {}.

OAuth2

NameTypeOptionalSecretDescription
enabledboolyesnoWhether to use OAuth version 2 in requests. The value defaults to false.
client_keystringyesnoA value used to identify the client to the token provider. The value defaults to "".
client_secretstringyesyesA secret used to establish ownership of the client key. The value defaults to "".
token_urlstringyesnoThe URL of the token provider. The value defaults to "".
scopes[]stringyesnoA list of optional requested permissions. The value defaults to [].
endpoint_paramsendpoint_paramsyesnoA list of optional endpoint parameters, values should be arrays of strings. The value defaults to {}.

Basic Auth

NameTypeOptionalSecretDescription
enabledboolyesnoWhether to use basic authentication in requests. The value defaults to false.
usernamestringyesnoA username to authenticate as. The value defaults to "".
passwordstringyesyesA password to authenticate with. The value defaults to "".

TLS Configuration

NameTypeOptionalSecretDescription
enabledboolyesnoWhether custom TLS settings are enabled. The value defaults to false.
skip_cert_verifyboolyesnoWhether to skip server side certificate verification. The value defaults to false.
enable_renegotiationboolyesnoWhether to allow the remote server to repeatedly request renegotiation.
Enable this option if you're seeing the error message local error: tls: no renegotiation. The value defaults to false.
root_casstringyesyesAn optional root certificate authority to use.
This is a string, representing a certificate chain from the parent trusted root certificate,
to possible intermediate signing certificates, to the host certificate. The value defaults to "".
client_certs[]client_certsyesnoA list of client certificates to use. . The value defaults to [].

Extract Headers

NameTypeOptionalSecretDescription
include_prefixes[]stringyesnoProvide a list of explicit metadata key prefixes to match against. The value defaults to [].
include_patterns[]stringyesnoProvide a list of explicit metadata key regular expression (re2) patterns to match against. The value defaults to [].

Stream

NameTypeOptionalSecretDescription
enabledboolyesnoEnables streaming mode. The value defaults to false.
reconnectboolyesnoSets whether to re-establish the connection once it is lost. The value defaults to true.
scannerscanneryesnoThe scanner by which the stream of bytes consumed will be broken out into individual messages. Scanners are useful for processing large sources of data without holding the entirety of it within memory. For example, the csv scanner allows you to process individual CSV rows without loading the entire CSV file in memory at once. The value defaults to {"lines":{}}.
Previous
HDFS