Redis Metrics

Collect and ship Redis server metrics to Logstash and Elasticsearch.

Metricbeat is a lightweight shipper that helps you monitor your Redis servers by collecting metrics running on the Redis server. Configure Metricbeat using the pre-defined examples below to collect and ship Redis service metrics and statistics to Logstash or Elasticsearch.

Step 1 - Install Metricbeat

deb (Debian/Ubuntu/Mint)

curl -L -O https://artifacts.elastic.co/downloads/beats//-oss-7.15.1-amd64.deb
sudo dpkg -i -oss-7.15.1-amd64.deb

rpm (CentOS/RHEL/Fedora)

curl -L -O https://artifacts.elastic.co/downloads/beats//-oss-7.15.1-x86_64.rpm
sudo rpm -vi -oss-7.15.1-x86_64.rpm

macOS

curl -L -O https://artifacts.elastic.co/downloads/beats//-oss-7.15.1-darwin-x86_64.tar.gz
tar xzvf -oss-7.15.1-darwin-x86_64.tar.gz

Windows

Download and extract the Windows zip file.
Rename the -<version>-windows directory to ``.
Open a PowerShell prompt as an Administrator.
Run the following to install as a Windows service:

.\install-service-.ps1

If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example: PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-.ps1.

My OS isn't here! Chat to support now

Step 2 - Copy configuration file

The configuration file below is pre-configured to send data to your Logit.io Stack via Logstash.

Copy the configuration file below and overwrite the contents of metricbeat.yml.

###################### Metricbeat Configuration Example #######################
# =========================== Modules configuration ============================

metricbeat.config.modules:
  # Glob pattern for configuration loading
  path: ${path.config}/modules.d/*.yml

  # Set to true to enable config reloading
  reload.enabled: false

  # Period on which files under path should be checked for changes
  #reload.period: 10s
# ======================= Elasticsearch template setting =======================
setup.template.settings:
  index.number_of_shards: 1
  index.codec: best_compression
  #_source.enabled: false

# ================================== Outputs ===================================
# ------------------------------ Logstash Output -------------------------------
<div class="sw-warning">
    <b>No input available! </b> Your stack is missing the required input for this data source <a href="#" onclick="Intercom('showNewMessage')" class="btn btn-info btn-sm">Talk to support to add the input</a>
</div>

Step 3 - Enable module

There are several built in metricbeat modules you can use. To enable the Apache module, run the following:

deb/rpm

metricbeat modules list
metricbeat modules enable redis

macOS

./metricbeat modules list
./metricbeat modules enable redis

Step 4 - Configure module

Each module has its own configuration file where different metricsets can be enabled / disabled. Locate the configuration file for the Redis module.

deb/rpm /etc/metricbeat/modules.d/redis.yml

macOS ~/<EXTRACTED_ARCHIVE>/modules.d/redis.yml

By default the metricsets are disabled. To enable or disable a metric simply comment or uncomment the line out.

- module: redis
  metricsets:
  # - info
  # - keyspace
  period: 10s

Step 5 - Start Metricbeat

Ok, time to start gathering metrics!

deb/rpm

sudo systemctl enable metricbeat
sudo systemctl start metricbeat

macOS

./metricbeat

Step 6 - how to diagnose no data in Stack

If you don't see data appearing in your Stack after following the steps, visit the Help Centre guide for steps to diagnose no data appearing in your Stack or Chat to support now.

Step 7 - Compatibility

The Redis metricsets were tested with Redis 3.2.12, 4.0.11 and 5.0-rc4, and are expected to work with all versions >= 3.0.

Expand View