HTTP
Collect logs emitted by an HTTP server
status: beta
role: aggregator
role: sidecar
delivery: at-least-once
acknowledgements: yes
egress: batch
state: stateless
output: log
Configuration
Example configurations
{
"sources": {
"my_source_id": {
"type": "http",
"acknowledgements": null,
"address": "0.0.0.0:80",
"encoding": "text"
}
}
}
[sources.my_source_id]
type = "http"
address = "0.0.0.0:80"
encoding = "text"
---
sources:
my_source_id:
type: http
acknowledgements: null
address: 0.0.0.0:80
encoding: text
{
"sources": {
"my_source_id": {
"type": "http",
"acknowledgements": null,
"address": "0.0.0.0:80",
"encoding": "text",
"headers": [
"User-Agent"
],
"auth": null,
"query_parameters": [
"application"
],
"path": "/",
"strict_path": true,
"path_key": "path",
"framing": null,
"tls": null,
"method": "POST",
"decoding": null
}
}
}
[sources.my_source_id]
type = "http"
address = "0.0.0.0:80"
encoding = "text"
headers = [ "User-Agent" ]
query_parameters = [ "application" ]
path = "/"
strict_path = true
path_key = "path"
method = "POST"
---
sources:
my_source_id:
type: http
acknowledgements: null
address: 0.0.0.0:80
encoding: text
headers:
- User-Agent
auth: null
query_parameters:
- application
path: /
strict_path: true
path_key: path
framing: null
tls: null
method: POST
decoding: null
acknowledgements
common optional objectControls how acknowledgements are handled by this source. These settings override the global
acknowledgement
settings. This setting is deprecated in favor of enabling acknowledgements
in the destination sink.acknowledgements.enabled
optional boolControls if the source will wait for destination sinks to deliver the events before acknowledging receipt.
default:
false
address
required string literalThe address to accept connections on. The address must include a port.
auth
optional objectOptions for HTTP Basic Authentication.
auth.password
optional string literalThe basic authentication password.
auth.username
optional string literalThe basic authentication user name.
decoding
optional objectConfigures in which way frames are decoded into events.
decoding.codec
optional string literal enumThe decoding method.
Enum options
Option | Description |
---|---|
bytes | Events containing the byte frame as-is. |
json | Events being parsed from a JSON string. |
native | Events being parsed from Vector’s native protobuf format (EXPERIMENTAL). |
native_json | Events being parsed from Vector’s native JSON format (EXPERIMENTAL). |
syslog | Events being parsed from a Syslog message. |
default:
bytes
encoding
common optional string literal enumThe expected encoding of received data. Note that for
json
and ndjson
encodings, the fields of the JSON objects are output as separate fields.Enum options
string
literal
Option | Description |
---|---|
binary | Binary or text, whole http request body is considered as one message. |
json | Array of JSON objects, which must be a JSON array containing JSON objects. |
ndjson | Newline-delimited JSON objects, where each line must contain a JSON object. |
text | Newline-delimited text, with each line forming a message. |
default:
text
framing
optional objectConfigures in which way incoming byte sequences are split up into byte frames.
framing.character_delimited
optional objectOptions for
character_delimited
framing.Relevant when:
method = `character_delimited`
framing.character_delimited.delimiter
optional ascii_charThe character used to separate frames.
framing.character_delimited.max_length
optional uintThe maximum frame length limit. Any frames longer than
max_length
bytes will be discarded entirely.framing.method
optional string literal enumThe framing method.
Enum options
Option | Description |
---|---|
bytes | Byte frames are passed through as-is according to the underlying I/O boundaries (e.g. split between messages or stream segments). |
character_delimited | Byte frames which are delimited by a chosen character. |
length_delimited | Byte frames whose length is encoded in a header. |
newline_delimited | Byte frames which are delimited by a newline character. |
octet_counting | Byte frames according to the octet counting format. |
default:
`newline_delimited` for codecs other than `native`, which defaults to `length_delimited`
framing.newline_delimited
optional objectOptions for
newline_delimited
framing.Relevant when:
method = `newline_delimited`
framing.newline_delimited.max_length
optional uintThe maximum frame length limit. Any frames longer than
max_length
bytes will be discarded entirely.framing.octet_counting
optional objectOptions for
octet_counting
framing.Relevant when:
method = `octet_counting`
framing.octet_counting.max_length
optional uintThe maximum frame length limit. Any frames longer than
max_length
bytes will be discarded entirely.headers
optional [string]A list of HTTP headers to include in the log event. These will override any values included in the JSON payload with conflicting names.
method
optional string literal enumSpecifies the action of the HTTP request.
Enum options
string
literal
Option | Description |
---|---|
DELETE | HTTP DELETE method. |
GET | HTTP GET method. |
HEAD | HTTP HEAD method. |
PATCH | HTTP PATCH method. |
POST | HTTP POST method. |
PUT | HTTP PUT method. |
default:
POST
path_key
optional string literalThe event key in which the requested URL path used to send the request will be stored.
default:
path
query_parameters
optional [string]A list of URL query parameters to include in the log event. These will override any values included in the body with conflicting names.
strict_path
optional boolIf set to
true
, only requests using the exact URL path specified in path
will be accepted;
otherwise requests sent to a URL path that starts with the value of path
will be accepted.
With strict_path
set to false
and path
set to ""
, the configured HTTP source will
accept requests from any URL path.default:
true
tls
optional objectConfigures the TLS options for incoming connections.
tls.ca_file
optional string literalAbsolute path to an additional CA certificate file, in DER or PEM format (X.509), or an in-line CA certificate in PEM format.
tls.crt_file
optional string literalAbsolute path to a certificate file used to identify this server, in DER or PEM format (X.509) or PKCS#12, or an in-line certificate in PEM format. If this is set, and is not a PKCS#12 archive,
key_file
must also be set. This is required if enabled
is set to true
.tls.enabled
optional boolRequire TLS for incoming connections. If this is set, an identity certificate is also required.
default:
false
tls.key_file
optional string literalAbsolute path to a private key file used to identify this server, in DER or PEM format (PKCS#8), or an in-line private key in PEM format.
tls.key_pass
optional string literalPass phrase used to unlock the encrypted key file. This has no effect unless
key_file
is set.tls.verify_certificate
optional boolIf
true
, Vector will require a TLS certificate from the connecting host and terminate the connection if the certificate is not valid. If false
(the default), Vector will not request a certificate from the client.default:
false
Outputs
<component_id>
Default output stream of the component. Use this component’s ID as an input to downstream transforms and sinks.
Output Data
Logs
Structured
An individual line from an
application/json
request*
optional
*
Any field contained in your JSON payload
path
required
string
literal
The HTTP path the event was received from. The key can be changed using the
path_key
configuration settingExamples
/
/logs/event712
timestamp
required
timestamp
The exact time the event was ingested into Vector.
Examples
2020-10-10T17:07:36.452332Z
Text
An individual line from a
text/plain
requestmessage
required
string
literal
The raw line line from the incoming payload.
Examples
Hello world
path
required
string
literal
The HTTP path the event was received from. The key can be changed using the
path_key
configuration settingExamples
/
/logs/event712
timestamp
required
timestamp
The exact time the event was ingested into Vector.
Examples
2020-10-10T17:07:36.452332Z
Telemetry
Metrics
linkcomponent_errors_total
counterThe total number of errors encountered by this component.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
error_type
required
The type of the error
host
optional
The hostname of the system Vector is running on.
pid
optional
The process ID of the Vector instance.
stage
required
The stage within the component at which the error occurred.
component_received_bytes_total
counterThe number of raw bytes accepted by this component from source origins.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the data originated.
file
optional
The file from which the data originated.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the data originated.
peer_path
optional
The pathname from which the data originated.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the data originated.
uri
optional
The sanitized URI from which the data originated.
component_received_event_bytes_total
counterThe number of event bytes accepted by this component either from
tagged origins like file and uri, or cumulatively from other origins.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the data originated.
file
optional
The file from which the data originated.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the data originated.
peer_path
optional
The pathname from which the data originated.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the data originated.
uri
optional
The sanitized URI from which the data originated.
component_received_events_total
counterThe number of events accepted by this component either from tagged
origins like file and uri, or cumulatively from other origins.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the data originated.
file
optional
The file from which the data originated.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the data originated.
peer_path
optional
The pathname from which the data originated.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the data originated.
uri
optional
The sanitized URI from which the data originated.
component_sent_event_bytes_total
counterThe total number of event bytes emitted by this component.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
output
optional
The specific output of the component.
pid
optional
The process ID of the Vector instance.
component_sent_events_total
counterThe total number of events emitted by this component.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
output
optional
The specific output of the component.
pid
optional
The process ID of the Vector instance.
events_in_total
counterThe number of events accepted by this component either from tagged
origins like file and uri, or cumulatively from other origins.
This metric is deprecated and will be removed in a future version.
Use
component_received_events_total
instead.component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the data originated.
file
optional
The file from which the data originated.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the data originated.
peer_path
optional
The pathname from which the data originated.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the data originated.
uri
optional
The sanitized URI from which the data originated.
events_out_total
counterThe total number of events emitted by this component.
This metric is deprecated and will be removed in a future version.
Use
component_sent_events_total
instead.component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
output
optional
The specific output of the component.
pid
optional
The process ID of the Vector instance.
Examples
text/plain
Given this event...POST / HTTP/1.1
Content-Type: text/plain
User-Agent: my-service/v2.1
X-Forwarded-For: my-host.local
Hello world
[sources.my_source_id]
type = "http"
address = "0.0.0.0:80"
encoding = "text"
headers = [ "User-Agent" ]
---
sources:
my_source_id:
type: http
address: 0.0.0.0:80
encoding: text
headers:
- User-Agent
{
"sources": {
"my_source_id": {
"type": "http",
"address": "0.0.0.0:80",
"encoding": "text",
"headers": [
"User-Agent"
]
}
}
}
[{"log":{"User-Agent":"my-service/v2.1","host":"my-host.local","message":"Hello world","path":"/","timestamp":"2020-10-10T17:07:36.452332Z"}}]
application/json
Given this event...POST /events HTTP/1.1
Content-Type: application/json
User-Agent: my-service/v2.1
X-Forwarded-For: my-host.local
{"key": "val"}
[sources.my_source_id]
type = "http"
address = "0.0.0.0:80"
encoding = "json"
headers = [ "User-Agent" ]
path_key = "vector_http_path"
---
sources:
my_source_id:
type: http
address: 0.0.0.0:80
encoding: json
headers:
- User-Agent
path_key: vector_http_path
{
"sources": {
"my_source_id": {
"type": "http",
"address": "0.0.0.0:80",
"encoding": "json",
"headers": [
"User-Agent"
],
"path_key": "vector_http_path"
}
}
}
[{"log":{"User-Agent":"my-service/v2.1","host":"my-host.local","key":"val","timestamp":"2020-10-10T17:07:36.452332Z"}}]
How it works
Decompression
Received body is decompressed according to
Content-Encoding
header.
Supported algorithms are gzip
, deflate
, and snappy
.Transport Layer Security (TLS)
Vector uses OpenSSL for TLS protocols. You can
adjust TLS behavior via the
tls.*
options.