redis module parses logs and slowlogs created by
When you run the module, it performs a few tasks under the hood:
- Sets the default paths to the log files (but don’t worry, you can override the defaults)
- Makes sure each multiline log event gets sent as a single event
- Uses ingest node to parse and process the log lines, shaping the data into a structure suitable for visualizing in Kibana
- Deploys dashboards for visualizing the log data
redis module has two filesets:
logfileset collects and parses the logs that Redis writes to disk.
slowlogfileset connects to Redis via the network and retrieves the slow logs by using the
log fileset, make sure the
logfile option, from the Redis
configuration file, is set to
slowlog fileset, make sure the
slowlog-log-slower-than option, from
the Redis configuration file, is set to a lower value than the default one.
log fileset was tested with logs from Redis versions 1.2.6, 2.4.6, and 3.0.2, so we
expect compatibility with any version 1.x, 2.x, or 3.x.
On Windows, the default paths assume that Redis was installed from the Chocolatey repository.
slowlog fileset was tested with Redis 3.0.2 and 2.4.6. We expect compatibility with any
Redis version newer than 2.2.12, when the SLOWLOG command was added.
Set up and run the moduleedit
Before doing these steps, verify that Elasticsearch and Kibana are running and that Elasticsearch is ready to receive data from Filebeat.
If you’re running our hosted Elasticsearch Service on Elastic Cloud, or you’ve enabled security in Elasticsearch and Kibana, you need to specify additional connection information before setting up and running the module. See Quick start: modules for common log formats for the complete setup.
To set up and run the module:
Enable the module:
deb and rpm:
filebeat modules enable redis
./filebeat modules enable redis
PS > .\filebeat.exe modules enable redis
This command enables the module config defined in the
modules.ddirectory. See Specify which modules to run for other ways to enable modules.
To see a list of enabled and disabled modules, run:
deb and rpm:
filebeat modules list
./filebeat modules list
PS > .\filebeat.exe modules list
Set up the initial environment:
deb and rpm:
filebeat setup -e
./filebeat setup -e
PS > .\filebeat.exe setup -e
setupcommand loads the recommended index template for writing to Elasticsearch and deploys the sample dashboards for visualizing the data in Kibana. This is a one-time setup step.
-eflag is optional and sends output to standard error instead of syslog.
If your logs aren’t in the default location, see Configure the module, then run Filebeat after you’ve set the paths variable.
deb and rpm:
service filebeat start
PS > Start-Service filebeat
If the module is configured correctly, you’ll see
INFO Harvester startedmessages for each file specified in the config.
Depending on how you’ve installed Filebeat, you might see errors related to file ownership or permissions when you try to run Filebeat modules. See Config File Ownership and Permissions in the Beats Platform Reference for more information.
Explore your data in Kibana:
Open your browser and navigate to the Dashboard overview in Kibana:
localhostwith the name of the Kibana host. If you’re using an Elastic Cloud instance, log in to your cloud account, then navigate to the Kibana endpoint in your deployment.
- If necessary, log in with your Kibana username and password.
Enter the module name in the search box, then open a dashboard and explore the visualizations for your parsed logs.
If you don’t see data in Kibana, try changing the date range to a larger range. By default, Kibana shows the last 15 minutes.
- Open your browser and navigate to the Dashboard overview in Kibana: http://localhost:5601/app/kibana#/dashboards. Replace
This module comes with a sample dashboard. For example:
Configure the moduleedit
You can further refine the behavior of the
redis module by specifying
variable settings in the
modules.d/redis.yml file, or overriding settings at the command line.
The following example shows how to set paths in the
file to override the default paths for Redis logs. It also shows how to set the
host and password to retrieve slow logs:
- module: redis log: enabled: true var.paths: ["/path/to/log/redis/redis-server.log*"] slowlog: enabled: true var.hosts: ["localhost:6378"] var.password: "YOUR_PASSWORD"
To specify the same settings at the command line, you use:
-M "redis.log.var.paths=[/path/to/log/redis/redis-server.log*]" -M "redis.slowlog.var.hosts=[localhost:6378]" -M "redis.slowlog.var.password=[YOUR_PASSWORD]"
Each fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the
redis module uses
When you specify a setting at the command line, remember to prefix the
setting with the module name, for example,
log fileset settingsedit
- An array of paths that specify where to look for the log files. If left empty, Filebeat will choose the paths depending on your operating systems.
slowlog fileset settingsedit
An array of hosts to which Filebeat should connect to retrieve the slow logs. If
The password to use to connect to Redis, in case Redis authentication is enabled
requirepassoption in the Redis configuration).
For a description of each field in the module, see the exported fields section.