File
Output observability events into files
Configuration
Example configurations
{
"sinks": {
"my_sink_id": {
"type": "file",
"inputs": [
"my-source-or-transform-id"
],
"compression": "none",
"encoding": {
"codec": "json"
},
"path": "/tmp/vector-%Y-%m-%d.log"
}
}
}
[sinks.my_sink_id]
type = "file"
inputs = [ "my-source-or-transform-id" ]
compression = "none"
path = "/tmp/vector-%Y-%m-%d.log"
[sinks.my_sink_id.encoding]
codec = "json"
---
sinks:
my_sink_id:
type: file
inputs:
- my-source-or-transform-id
compression: none
encoding:
codec: json
path: /tmp/vector-%Y-%m-%d.log
{
"sinks": {
"my_sink_id": {
"type": "file",
"inputs": [
"my-source-or-transform-id"
],
"idle_timeout_secs": 30,
"compression": "none",
"encoding": {
"codec": "json"
},
"path": "/tmp/vector-%Y-%m-%d.log"
}
}
}
[sinks.my_sink_id]
type = "file"
inputs = [ "my-source-or-transform-id" ]
idle_timeout_secs = 30
compression = "none"
path = "/tmp/vector-%Y-%m-%d.log"
[sinks.my_sink_id.encoding]
codec = "json"
---
sinks:
my_sink_id:
type: file
inputs:
- my-source-or-transform-id
idle_timeout_secs: 30
compression: none
encoding:
codec: json
path: /tmp/vector-%Y-%m-%d.log
acknowledgements
common optional objectacknowledgement
settings.acknowledgements.enabled
common optional boolfalse
buffer
optional objectConfigures the buffering behavior for this sink.
More information about the individual buffer types, and buffer behavior, can be found in the Buffering Model section.
buffer.max_events
optional uinttype = "memory"
500
buffer.max_size
required uintThe maximum size of the buffer on disk.
Must be at least ~256 megabytes (268435488 bytes).
type = "disk"
buffer.type
optional string literal enumOption | Description |
---|---|
disk | Events are buffered on disk. (version 2) This is less performant, but more durable. Data that has been synchronized to disk will not be lost if Vector is restarted forcefully or crashes. Data is synchronized to disk every 500ms. |
memory | Events are buffered in memory. This is more performant, but less durable. Data will be lost if Vector is restarted forcefully or crashes. |
memory
buffer.when_full
optional string literal enumOption | Description |
---|---|
block | Wait for free space in the buffer. This applies backpressure up the topology, signalling that sources should slow down the acceptance/consumption of events. This means that while no data is lost, data will pile up at the edge. |
drop_newest | Drops the event instead of waiting for free space in buffer. The event will be intentionally dropped. This mode is typically used when performance is the highest priority, and it is preferable to temporarily lose events rather than cause a slowdown in the acceptance/consumption of events. |
block
compression
common optional string literal enumThe compression strategy used to compress the encoded event data before transmission.
The default compression level of the chosen algorithm is used. Some cloud storage API clients and browsers will handle decompression transparently, so files may not always appear to be compressed depending how they are accessed.
none
encoding
required objectencoding.codec
required string literal enumOption | Description |
---|---|
json | Encodes an event as JSON. |
text | Plaintext encoding. This “encoding” simply uses the Users should take care if they’re modifying their log events (such as by using a |
encoding.except_fields
optional [string]encoding.only_fields
optional [string]encoding.timestamp_format
optional string literal enumOption | Description |
---|---|
rfc3339 | Formats as a RFC3339 string |
unix | Formats as a unix timestamp |
rfc3339
framing
optional objectframing.character_delimited
required objectcharacter_delimited
framing.method = `character_delimited`
framing.character_delimited.delimiter
required ascii_charframing.method
common optional string literal enumOption | Description |
---|---|
bytes | Byte frames are concatenated. |
character_delimited | Byte frames are delimited by a chosen character. |
length_delimited | Byte frames are prefixed by an unsigned big-endian 32-bit integer indicating the length. |
newline_delimited | Byte frames are delimited by a newline character. |
A suitable default is chosen depending on the sink type and the selected codec.
healthcheck
optional objecthealthcheck.enabled
optional booltrue
idle_timeout_secs
optional uint30
inputs
required [string]A list of upstream source or transform IDs.
Wildcards (*
) are supported.
See configuration for more info.
path
required string templateTelemetry
Metrics
linkbuffer_byte_size
gaugecomponent_id
instead. The value is the same as component_id
.buffer_discarded_events_total
countercomponent_id
instead. The value is the same as component_id
.buffer_events
gaugecomponent_id
instead. The value is the same as component_id
.buffer_received_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.buffer_received_events_total
countercomponent_id
instead. The value is the same as component_id
.buffer_sent_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.buffer_sent_events_total
countercomponent_id
instead. The value is the same as component_id
.component_received_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_received_events_count
histogramA histogram of the number of events passed in each internal batch in Vector’s internal topology.
Note that this is separate than sink-level batching. It is mostly useful for low level debugging performance issues in Vector due to small internal batches.
component_id
instead. The value is the same as component_id
.component_received_events_total
countercomponent_id
instead. The value is the same as component_id
.component_sent_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_sent_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_sent_events_total
countercomponent_id
instead. The value is the same as component_id
.events_discarded_total
counterevents_in_total
countercomponent_received_events_total
instead.component_id
instead. The value is the same as component_id
.processing_errors_total
countercomponent_errors_total
.component_id
instead. The value is the same as component_id
.utilization
gaugecomponent_id
instead. The value is the same as component_id
.How it works
File & Directory Creation
Durability of Created Files
Health checks
Require health checks
If you’d like to exit immediately upon a health check failure, you can pass the
--require-healthy
flag:
vector --config /etc/vector/vector.toml --require-healthy
Disable health checks
healthcheck
option to
false
.