Redis

Collect observability data from Redis.

status: beta role: aggregator delivery: best effort acknowledgements: no egress: stream state: stateless output: log
Page source Edit this page

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 enum
The Redis data type (list or channel) to use.
Enum options string literal
OptionDescription
channelUse the Redis channel data type.
listUse the Redis list data type.
default: list

decoding

optional object
Configures in which way frames are decoded into events.

decoding.codec

optional string literal enum
The decoding method.
Enum options
OptionDescription
bytesEvents containing the byte frame as-is.
jsonEvents being parsed from a JSON string.
syslogEvents being parsed from a Syslog message.
default: bytes

framing

optional object
Configures in which way incoming byte sequences are split up into byte frames.

framing.character_delimited

optional object
Options for character_delimited framing.
Relevant when: method = `character_delimited`
framing.character_delimited.delimiter
optional ascii_char
The character used to separate frames.
Examples 
"\n"
"\t"
framing.character_delimited.max_length
optional uint
The maximum frame length limit. Any frames longer than max_length bytes will be discarded entirely.
Examples 
65535
102400

framing.method

optional string literal enum
The framing method.
Enum options
OptionDescription
bytesByte frames are passed through as-is according to the underlying I/O boundaries (e.g. split between messages or stream segments).
character_delimitedByte frames which are delimited by a chosen character.
length_delimitedByte frames whose length is encoded in a header.
newline_delimitedByte frames which are delimited by a newline character.
octet_countingByte frames according to the octet counting format.
default: bytes

framing.newline_delimited

optional object
Options for newline_delimited framing.
Relevant when: method = `newline_delimited`
framing.newline_delimited.max_length
optional uint
The maximum frame length limit. Any frames longer than max_length bytes will be discarded entirely.
Examples 
65535
102400

framing.octet_counting

optional object
Options for octet_counting framing.
Relevant when: method = `octet_counting`
framing.octet_counting.max_length
optional uint
The maximum frame length limit. Any frames longer than max_length bytes will be discarded entirely.
Examples 
65535
102400

key

required string literal
The Redis key to read messages from.
Examples 
"vector"

list

optional object
Options for the Redis list data type.

list.method

optional string literal enum
The method (rpop or lpop) to pop messages when data_type is list.
Enum options
OptionDescription
lpopPop messages from the head of the list.
rpopPop messages from the tail of the list.
default: lpop

redis_key

optional string literal
The 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.
Examples 
"redis_key"

url

required string literal
The 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.
Examples 
"redis://127.0.0.1:6379/0"

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
Fields
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
timestamp required timestamp
The exact time the event was ingested into Vector.
Examples
2020-10-10T17:07:36.452332Z

Telemetry

Metrics

link

component_sent_event_bytes_total

counter
The 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

counter
The 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

counter
The 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

counter
The 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.

processed_bytes_total

counter
The number of bytes processed by the 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.
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

counter
The total number of processing 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.

How it works

Context

By default, the redis source augments events with helpful context keys.

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.

State

This component is stateless, meaning its behavior is consistent across each input.
Sidebar