Http Client
🔐 Authentication (auth)
Specify how the HTTP source authenticates incoming requests.
- strategy (required):
Choose between basic or bearer.
- user (required for basic):
Username for basic auth.
- password (required for basic):
Password for basic auth.
- token (required for bearer):
Bearer token for authentication.
📥 Decoding (decoding)
Configure how to interpret the incoming payload.
- codec (default: bytes):
Choose how the payload should be decoded.
Options: bytes, avro, gelf, influxdb, json, native, native_json, protobuf, syslog, vrl.
Codec-specific settings:
- avro:
schema: Avro schema string (required).
strip_schema_id_prefix: Remove Confluent-style schema ID prefix.
- gelf, influxdb, json, native_json, syslog:
lossy: Replace invalid UTF-8 sequences.
- protobuf:
desc_file: Path to the descriptor set.
message_type: Fully qualified message type.
- vrl:
source: VRL program to decode the message (required).
timezone: Timezone used for timestamp parsing (local by default).
🧱 Framing (framing)
Control how byte streams are split into messages.
- method (default: bytes):
Select the framing strategy.
Options: bytes, character_delimited, chunked_gelf, length_delimited, newline_delimited, octet_counting.
Framing-specific settings:
- character_delimited:
delimiter: ASCII character that separates frames (required).
- max_length: Max size of a frame.
chunked_gelf:
- decompression: How to decompress chunks (Auto, Gzip, Zlib, None; default: Auto).
- max_length, pending_messages_limit, timeout_secs (default: 5).
length_delimited:
- length_field_is_big_endian (default: true)
- length_field_length, length_field_offset, max_frame_length
newline_delimited and octet_counting:
- max_length: Max size of a frame.
🌐 Endpoint & Request Details
- endpoint (required):
Full URL path to receive incoming requests.
- method (default: GET):
HTTP method accepted (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD).
- headers:
Optional HTTP headers to expect.
- query:
Optional query parameters to expect.
📡 Scraping Settings
Use when pulling data from an HTTP endpoint.
- scrape_interval_secs (default: 15):
Time between scrape attempts.
- scrape_timeout_secs (default: 5):
Max time allowed per scrape.
🌍 Proxy (proxy)
Control proxy behavior for outgoing HTTP(S) requests.
- enabled (default: true):
Turn proxying on or off.
- http, https:
URIs of the proxy servers.
- no_proxy:
List of domains or CIDRs that bypass the proxy.
🔒 TLS Settings (tls)
Secure the connection with TLS.
- enabled:
Enable TLS encryption.
- crt_file, key_file, key_pass:
TLS certificate, key, and optional passphrase.
- ca_file:
Additional trusted CA cert.
- server_name:
Override for SNI.
- alpn_protocols:
List of supported ALPN protocols.
- verify_certificate:
Validate the client or server certificate.
- verify_hostname:
Ensure the hostname matches the certificate.
