Redis
Collect observability data from Redis.
status: beta
role: aggregator
delivery: best effort
acknowledgements: no
egress: stream
state: stateless
output: log
Configuration
Example configurations
{
"sources": {
"my_source_id": {
"type": "redis",
"url": "redis://127.0.0.1:6379/0",
"key": "vector"
}
}
}
[sources.my_source_id]
type = "redis"
url = "redis://127.0.0.1:6379/0"
key = "vector"
---
sources:
my_source_id:
type: redis
url: redis://127.0.0.1:6379/0
key: vector
{
"sources": {
"my_source_id": {
"type": "redis",
"url": "redis://127.0.0.1:6379/0",
"key": "vector",
"data_type": "list",
"list": null,
"framing": null,
"redis_key": "redis_key",
"decoding": null
}
}
}
[sources.my_source_id]
type = "redis"
url = "redis://127.0.0.1:6379/0"
key = "vector"
data_type = "list"
redis_key = "redis_key"
---
sources:
my_source_id:
type: redis
url: redis://127.0.0.1:6379/0
key: vector
data_type: list
list: null
framing: null
redis_key: redis_key
decoding: null
data_type
optional string literal enumThe Redis data type (
list
or channel
) to use.Enum options
string
literal
Option | Description |
---|---|
channel | Use the Redis channel data type. |
list | Use the Redis list data type. |
default:
list
decoding
optional objectConfigures how events are decoded from raw bytes.
decoding.codec
common optional string literal enumThe codec to use for decoding events.
Enum options
Option | Description |
---|---|
bytes | Uses the raw bytes as-is. |
gelf | Decodes the raw bytes as a GELF message. |
json | Decodes the raw bytes as JSON. |
native | Decodes the raw bytes as Vector’s native Protocol Buffers format. This codec is experimental. |
native_json | Decodes the raw bytes as Vector’s native JSON format. This codec is experimental. |
syslog | Decodes the raw bytes as a Syslog message. Will decode either as the RFC 3164-style format (“old” style) or the more modern RFC 5424-style format (“new” style, includes structured data). |
default:
bytes
framing
optional objectConfigures in which way incoming byte sequences are split up into byte frames.
framing.character_delimited
required objectOptions for
character_delimited
framing.Relevant when:
method = `character_delimited`
framing.character_delimited.delimiter
required 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
common 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 which are prefixed by an unsigned big-endian 32-bit integer indicating the length. |
newline_delimited | Byte frames which are delimited by a newline character. |
octet_counting | Byte frames according to the octet counting format. |
default:
bytes
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.list
optional objectOptions for the Redis
list
data type.list.method
optional string literal enumThe method (
rpop
or lpop
) to pop messages when data_type
is list.Enum options
Option | Description |
---|---|
lpop | Pop messages from the head of the list. |
rpop | Pop messages from the tail of the list. |
default:
lpop
redis_key
optional string literalThe log field name to use for the redis key. If set to an empty string or null, the key is not added to the log event.
url
required string literalThe Redis URL to connect to. The url must take the form of
protocol://server:port/db
where the protocol can either be redis
or rediss
for connections secured via TLS.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
Record
An individual Redis record
host
required
string
literal
The local hostname, equivalent to the
gethostname
command.Examples
my-host.local
message
required
string
literal
The raw line, unparsed.
Examples
2019-02-13T19:48:34+00:00 [info] Started GET "/" for 127.0.0.1
redis_key
optional
string
literal
The Redis key the event came from
Examples
some_key
source_type
required
string
literal
The name of the source type.
Examples
redis
timestamp
required
timestamp
The exact time the event was ingested into Vector.
Examples
2020-10-10T17:07:36.452332Z
Telemetry
Metrics
linkcomponent_sent_event_bytes_total
counterThe total number of event bytes emitted by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
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
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
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
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
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
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
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.
processed_bytes_total
counterThe number of bytes processed by the component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
The Vector component type.
container_name
optional
The name of the container from which the bytes originate.
file
optional
The file from which the bytes originate.
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 bytes originate.
peer_path
optional
The pathname from which the bytes originate.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the bytes originate.
uri
optional
The sanitized URI from which the bytes originate.
processing_errors_total
counterThe total number of processing errors encountered by this component. This metric is deprecated in favor of
component_errors_total
.component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
The Vector component type.
error_type
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.
source_lag_time_seconds
histogramThe difference between the timestamp recorded in each event and the time when it was ingested, expressed as fractional seconds.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
The Vector component type.
host
optional
The hostname of the system Vector is running on.
pid
optional
The process ID of the Vector instance.
How it works
redis-rs
The
redis
source uses redis-rs
under the hood, which is a high level Redis library
for Rust. It provides convenient access to all Redis functionality through a very flexible but low-level
API.