Install & Configure Redis MQ

The Redis MQ (RDMQ) Data Collector is a Go-based monitoring agent designed to collect operational and performance metrics from Redis instances participating in Redis MQ deployments. It computes derived metrics and reports them to the Rakuten SixthSense backend for centralized visibility and analytics.

note

For Redis MQ monitoring support, ensure that the Database Monitoring Agent is upgraded to version 5.0.0 or higher if you are currently running an earlier versions.

Pre-requisites

  • For prerequisite checks for agent installation, see Prerequisite checks for agent installation.
  • URL/IP of the SixthSense collector (your tenant URL, which will be provided by Customer Support).
  • Access token from the SixthSense portal. For accessing the token, see Accessing your Access Token under Getting started with the Observability Portal.
  • Package token to download the agent (which will be provided by Customer Support).
  • For information about supported agent versions and framework, see Supported agents.

Download the Database Monitoring Agent

  • Download latest meter-agent.zip. For Windows and Linux based servers, use the following link.
curl --header "PRIVATE-TOKEN:<TOKEN>" --output meter-agent.zip "https://artifacts-observability.sixthsense.rakuten.com/api/v4/projects/32/packages/generic/Meter-Agent/v5.0.0/meter-agent.zip"

Install the Database Monitoring Agent

  • Unzip the meter-agent.zip and go to the agent directory.
unzip meter-agent.zip
cd Meter-Agent-v5.0.0
chmod 755 -R < path to Meter Agent >/Meter-Agent-v5.0.0

Configure the Database Monitoring Agent

  1. Open the config file

< path to Meter Agent >/Meter-Agent-v5.0.0/Configs/ss-redismq-config.yaml

  1. Update ss-redismq-config.yaml as per the instructions mentioned in the configuration file.
sixthsense:
# Identifier for this Redis MQ instance in SixthSense
service_name: <SERVICE_NAME>
# Login to Sixthsense UI --> Go to Settings on Side Navbar --> Copy Access Token
authentication: <ACCESS_TOKEN>
# debug|error|info
logging: info
sixthsense_backend: grpc-collector-observability.sixthsense.rakuten.com:443
# SSL connection with backend true|false
secure: true
# RDMQ ( Redis MQ )
type: RDMQ
# Used to configure polling frequency (optional), default polling frequency is 60 sec.
# cron: "* * * * *"
# Hostname & Port of the Redis Instance
hostname: 127.0.0.1
port: 6379
# User credentials which is used to poll the data from Redis MQ
user: default
password: password
# log file path
logPath: < path to downloaded database monitoring Agent >/Meter-Agent-v5.0.0/logs/redis_logs.log
# No of queries
queryLimit: 10
# millisecond
queryThresholdTime: 0
# Maximum time allowed for a single query (seconds)
queryTimeOut: 10
# Set "true" to skip Custom Queries data ingestion.
disableCDQ: true
  1. Save and close the file.

Run/Start the Agent

  • Run the Database Monitoring Agent manually with below command to monitor RedisMQ
./< path to Meter Agent >/Meter-Agent-v5.0.0/Linux/meter-agent-v5.0.0 < path to Meter Agent >/Meter-Agent-v5.0.0/Configs/ss-redismq-config.yaml
  • In case of network restrictions, pass proxy to the meter-agent process to be able to connect to sixthsense-backend. ( Linux Based Hosts )
HTTPS_PROXY=proxy-server:port ./< path to Meter Agent >/Meter-Agent-v5.0.0/Linux/meter-agent-v5.0.0 < path to Meter Agent >/Meter-Agent-v5.0.0/Configs/ss-redismq-config.yaml

Add the agent as a Service ( Windows )

  1. Register Meter Agent as a service in Windows with following command to moitor RedisMQ
sc create "Sixthsense RedisMQ Agent" binPath= "\"< path to Meter Agent >\Meter-Agent-v5.0.0\Windows\meter-agent-v5.0.0.exe\" -config \"< path to Meter Agent >\Meter-Agent-v5.0.0\ss-redismq-config.yaml\"" start= auto

  1. Confirm whether the service is registered by opening Services and search for the Service Name - Sixthsense RedisMQ Agent with which you've registered.

  2. Run the service by opening the Services again and look for Service name - Sixthsense RedisMQ Agent > Start OR sc start <service_name>.

Example: sc start "Sixthsense RedisMQ Agent"
note
  • ( Windows based Hosts ) - Edit your host file on Redis Host to configure proxy OR you can use below command to configure proxy via administrator command prompt.
netsh winhttp set proxy <proxy>:<port>
  • One Meter Agent can monitor one Redis Host.

Validate Database Monitoring Agent is running on Host

  • On Linux based Hosts, use
ps -ef | grep meter-agent
  • On Windows Hosts

open the Services window OR open command prompt and run following command

sc query "Sixthsense RedisMQ Agent"

Visualise RedisMQ data

Once Agent is installed & configured successfully, data can be visualised in RedisMQ Dashboard.