Redis inputedit

Warning

This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Use the redis input to read entries from Redis slowlogs.

Example configuration:

filebeat.inputs:
- type: redis
  hosts: ["localhost:6379"]
  password: "${redis_pwd}"

Configuration optionsedit

The redis input supports the following configuration options plus the Common options described later.

hostsedit

The list of Redis hosts to connect to.

passwordedit

The password to use when connecting to Redis.

scan_frequencyedit

How often Filebeat reads entries from Redis slowlogs. Specify 1s to scan Redis as frequently as possible without causing Filebeat to scan too frequently. Do not set this value to less than 1s.

The default is 10s.

Important

Redis slowlogs are not permanent. To ensure that all slowlog entries are collected, set scan_frequency to a value that allows Filebeat sufficient time to connect to Redis, query the logs, and buffer them to the output within the specified interval.

timeoutedit

How long to wait for a response from Redis before the input returns an error. The default is 1s.

networkedit

The network type to use for the Redis connection. Valid settings include: tcp, tcp4, tcp6, and unix. The default is tcp.

maxconnedit

The maximum number of concurrent connections. The default is 10.

Common optionsedit

The following configuration options are supported by all inputs.

enablededit

Use the enabled option to enable and disable inputs. By default, enabled is set to true.

tagsedit

A list of tags that Filebeat includes in the tags field of each published event. Tags make it easy to select specific events in Kibana or apply conditional filtering in Logstash. These tags will be appended to the list of tags specified in the general configuration.

Example:

filebeat.inputs:
- type: redis
  . . .
  tags: ["json"]
fieldsedit

Optional fields that you can specify to add additional information to the output. For example, you might add fields that you can use for filtering log data. Fields can be scalar values, arrays, dictionaries, or any nested combination of these. By default, the fields that you specify here will be grouped under a fields sub-dictionary in the output document. To store the custom fields as top-level fields, set the fields_under_root option to true. If a duplicate field is declared in the general configuration, then its value will be overwritten by the value declared here.

filebeat.inputs:
- type: redis
  . . .
  fields:
    app_id: query_engine_12
fields_under_rootedit

If this option is set to true, the custom fields are stored as top-level fields in the output document instead of being grouped under a fields sub-dictionary. If the custom field names conflict with other field names added by Filebeat, then the custom fields overwrite the other fields.

processorsedit

A list of processors to apply to the input data.

See Filter and enhance the exported data for information about specifying processors in your config.

pipelineedit

The Ingest Node pipeline ID to set for the events generated by this input.

Note

The pipeline ID can also be configured in the Elasticsearch output, but this option usually results in simpler configuration files. If the pipeline is configured both in the input and output, the option from the input is used.