Azure Blob Storage
Store your observability data in Azure Blob Storage
Configuration
Example configurations
{
"sinks": {
"my_sink_id": {
"type": "azure_blob",
"inputs": [
"my-source-or-transform-id"
],
"connection_string": "DefaultEndpointsProtocol=https;AccountName=mylogstorage;AccountKey=storageaccountkeybase64encoded;EndpointSuffix=core.windows.net",
"storage_account": "mylogstorage",
"container_name": "my-logs",
"blob_prefix": "blob/%F/",
"acknowledgements": null,
"batch": null,
"compression": "gzip",
"encoding": {
"codec": "json"
}
}
}
}
[sinks.my_sink_id]
type = "azure_blob"
inputs = [ "my-source-or-transform-id" ]
connection_string = "DefaultEndpointsProtocol=https;AccountName=mylogstorage;AccountKey=storageaccountkeybase64encoded;EndpointSuffix=core.windows.net"
storage_account = "mylogstorage"
container_name = "my-logs"
blob_prefix = "blob/%F/"
compression = "gzip"
[sinks.my_sink_id.encoding]
codec = "json"
---
sinks:
my_sink_id:
type: azure_blob
inputs:
- my-source-or-transform-id
connection_string: DefaultEndpointsProtocol=https;AccountName=mylogstorage;AccountKey=storageaccountkeybase64encoded;EndpointSuffix=core.windows.net
storage_account: mylogstorage
container_name: my-logs
blob_prefix: blob/%F/
acknowledgements: null
batch: null
compression: gzip
encoding:
codec: json
{
"sinks": {
"my_sink_id": {
"type": "azure_blob",
"inputs": [
"my-source-or-transform-id"
],
"connection_string": "DefaultEndpointsProtocol=https;AccountName=mylogstorage;AccountKey=storageaccountkeybase64encoded;EndpointSuffix=core.windows.net",
"storage_account": "mylogstorage",
"container_name": "my-logs",
"blob_prefix": "blob/%F/",
"blob_append_uuid": true,
"buffer": null,
"acknowledgements": null,
"batch": null,
"compression": "gzip",
"encoding": {
"codec": "json"
},
"request": null,
"framing": null,
"blob_time_format": "%s",
"healthcheck": null
}
}
}
[sinks.my_sink_id]
type = "azure_blob"
inputs = [ "my-source-or-transform-id" ]
connection_string = "DefaultEndpointsProtocol=https;AccountName=mylogstorage;AccountKey=storageaccountkeybase64encoded;EndpointSuffix=core.windows.net"
storage_account = "mylogstorage"
container_name = "my-logs"
blob_prefix = "blob/%F/"
blob_append_uuid = true
compression = "gzip"
blob_time_format = "%s"
[sinks.my_sink_id.encoding]
codec = "json"
---
sinks:
my_sink_id:
type: azure_blob
inputs:
- my-source-or-transform-id
connection_string: DefaultEndpointsProtocol=https;AccountName=mylogstorage;AccountKey=storageaccountkeybase64encoded;EndpointSuffix=core.windows.net
storage_account: mylogstorage
container_name: my-logs
blob_prefix: blob/%F/
blob_append_uuid: true
buffer: null
acknowledgements: null
batch: null
compression: gzip
encoding:
codec: json
request: null
framing: null
blob_time_format: "%s"
healthcheck: null
acknowledgements
common optional objectacknowledgement
settings.acknowledgements.enabled
common optional boolfalse
batch
common optional objectbatch.max_bytes
common optional uintbatch.max_events
common optional uintbatch.timeout_secs
common optional float300
(seconds)blob_append_uuid
optional booltrue
blob_prefix
common optional string template/
if you want this to be the root azure storage “folder”."date/%F/"
"date/%F/hour/%H/"
"year=%Y/month=%m/day=%d/"
"kubernetes/{{ metadata.cluster }}/{{ metadata.application_name }}/"
blob/%F/
blob_time_format
optional string strftimestrftime
specifiers are supported.%s
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_v1" or 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. |
disk_v1 | Events are buffered on disk. (version 1) 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. |
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.
Option | Description |
---|---|
gzip | Gzip standard DEFLATE compression. Compression level is 6 unless otherwise specified. |
none | No compression. |
gzip
connection_string
common optional string literalcontainer_name
required string literalencoding
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
inputs
required [string]A list of upstream source or transform IDs.
Wildcards (*
) are supported.
See configuration for more info.
request
optional objectrequest.adaptive_concurrency
optional objectrequest.adaptive_concurrency.decrease_ratio
optional float0.9
request.adaptive_concurrency.ewma_alpha
optional float0.7
request.adaptive_concurrency.rtt_deviation_scale
optional float2
request.concurrency
common optional uintrequest.rate_limit_duration_secs
common optional uintrate_limit_num
option.1
(seconds)request.rate_limit_num
common optional uintrate_limit_duration_secs
time window.250
request.retry_attempts
optional uint1.8446744073709552e+19
request.retry_initial_backoff_secs
optional uint1
(seconds)request.retry_max_duration_secs
optional uint3600
(seconds)request.timeout_secs
common optional uint60
(seconds)storage_account
common optional string literalTelemetry
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_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
.http_error_response_total
counterhttp_request_errors_total
counterprocessed_bytes_total
countercomponent_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
Buffers and batches
This component buffers & batches data as shown in the diagram above. You’ll notice that Vector treats these concepts differently, instead of treating them as global concepts, Vector treats them as sink specific concepts. This isolates sinks, ensuring services disruptions are contained and delivery guarantees are honored.
Batches are flushed when 1 of 2 conditions are met:
- The batch age meets or exceeds the configured
timeout_secs
. - The batch size meets or exceeds the configured
max_bytes
ormax_events
.
Buffers are controlled via the buffer.*
options.
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
.Object naming
By default, Vector names your blobs different based on whether or not the blobs are compressed.
Here is the format without compression:
<key_prefix><timestamp>-<uuidv4>.log
Here’s an example blob name without compression:
blob/2021-06-23/1560886634-fddd7a0e-fad9-4f7e-9bce-00ae5debc563.log
And here is the format with compression:
<key_prefix><timestamp>-<uuidv4>.log.gz
An example blob name with compression:
blob/2021-06-23/1560886634-fddd7a0e-fad9-4f7e-9bce-00ae5debc563.log.gz
Vector appends a UUIDV4 token to ensure there are no name conflicts in the unlikely event that two Vector instances are writing data at the same time.
You can control the resulting name via the blob_prefix
,
blob_time_format
, and blob_append_uuid
options.
Rate limits & adaptive concurrency
Adaptive Request Concurrency (ARC)
Adaptive Request Concurrency is a feature of Vector that does away with static concurrency limits and automatically optimizes HTTP concurrency based on downstream service responses. The underlying mechanism is a feedback loop inspired by TCP congestion control algorithms. Checkout the announcement blog post,
We highly recommend enabling this feature as it improves performance and reliability of Vector and the systems it communicates with. As such, we have made it the default, and no further configuration is required.
Static concurrency
If Adaptive Request Concurrency is not for you, you can manually set static concurrency
limits by specifying an integer for request.concurrency
:
[sinks.my-sink]
request.concurrency = 10
Rate limits
In addition to limiting request concurrency, you can also limit the overall request
throughput via the request.rate_limit_duration_secs
and request.rate_limit_num
options.
[sinks.my-sink]
request.rate_limit_duration_secs = 1
request.rate_limit_num = 10
These will apply to both adaptive
and fixed request.concurrency
values.