Skip to main content
Sumo Logic

Install the Redis App, Alerts, and View the Dashboards

This page provides instructions for installing the Redis ULM app, as well as offering descriptions and examples for each of the pre-configured app dashboards.

This page has instructions for installing the Sumo App and Alerts for Redis ULM, as well as descriptions and examples for each of the dashboards. 

Pre-Packaged Alerts

Sumo Logic has provided out of the box alerts available via Sumo Logic monitors to help you quickly determine if the Redis database cluster is available and performing as expected. These alerts are built based on metrics datasets and have preset thresholds based on industry best practices and recommendations.

For details on the individual alerts,  please see this page.

Installing Alerts

  • To install these alerts, you need to have the Manage Monitors role capability.
  • Alerts can be installed by either importing them via a JSON or via a Terraform script.
Method 1: Install the alerts by importing a JSON file:
  1. Download a JSON file that describes the monitors. 
    1. The JSON contains the alerts that are based on Sumo Logic searches that do not have any scope filters and therefore will be applicable to all Redis clusters, the data for which has been collected via the instructions in the previous sections.,  However, if you would like to restrict these alerts to specific clusters or environments, update the JSON file by replacing the text ‘db_system=redis’ with ‘<Your Custom Filter> db_system=redis’.

      Custom filter examples:
      1. For alerts applicable only to a specific cluster, your custom filter would be:  ‘db_cluster=redis-.prod.01’.
      2. For alerts applicable to all clusters that start with redis-prod, your custom filter would be: ‘db_cluster=redis-prod*’.
      3. For alerts applicable to a specific cluster within a production environment, your custom filter would be: db_cluster=redis-1 and environment=prod (This assumes you have set the optional environment tag while configuring collection).
  2. Go to Manage Data > Alerts > Monitors.
  3. Click Add:

Add monitors page.png

  1. Click Import to import monitors from the JSON above.

Note: The monitors are disabled by default. Once you have installed the alerts via this method, navigate to the Redis folder under Monitors to configure them. See this document to enable monitors. To send notifications to teams or connections please see the instructions detailed in Step 4 of this document.

Method 2: Install the alerts via a Terraform script

Step 1: Generate a Sumo Logic access key and ID

Generate an access key and access ID for a user that has the Manage Monitors role capability in Sumo Logic using these instructions. Please identify which deployment your Sumo Logic account is in, using this link.

Step 2: Download and install Terraform 0.13 or later 

Step 3: Download the Sumo Logic Terraform package for Redis alerts

The alerts package is available in the Sumo Logic github repository. You can either download it via the “git clone” command or as a zip file. 

Step 4: Alert Configuration 

After the package has been extracted, navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/redis/

Edit the redis.auto.tfvars file and add the Sumo Logic Access Key, Access Id and Deployment from Step 1 .

access_id   = "<SUMOLOGIC ACCESS ID>"

access_key  = "<SUMOLOGIC ACCESS KEY>"

environment = "<SUMOLOGIC DEPLOYMENT>"

The Terraform script installs the alerts without any scope filters, if you would like to restrict the alerts to specific clusters or environments, update the variable’redis_cluster_filter’. Custom filter examples: 

  1. For alerts applicable only to a specific cluster, your custom filter would be:  ‘db_cluster=redis-.prod.01’
  2. For alerts applicable to all clusters that start with redis-prod, your custom filter would be: ‘db_cluster=redis-prod*’
  3. For alerts applicable to a specific cluster within a production environment, your custom filter would be: db_cluster=redis-1 and environment=prod (This assumes you have set the optional environment tag while configuring collection)

All monitors are disabled by default on installation, if you would like to enable all the monitors, set the parameter monitors_disabled to false in this file.

By default, the monitors are configured in a monitor folder called “Redis”, if you would like to change the name of the folder, update the monitor folder name in this file.

If you would like the alerts to send email or connection notifications, configure these in the file redis_notifications.auto.tfvars. For configuration examples, refer to the next section.

Step 5: Email and Connection Notification Configuration Examples

To configure notifications, modify the file redis_notifications.auto.tfvars file and fill in the connection_notifications See the examples for PagerDuty and email notifications below. See this document for creating payloads with other connection types.

Pagerduty Connection Example:
connection_notifications = [
    {
      connection_type       = "PagerDuty",
      connection_id         = "<CONNECTION_ID>",
      payload_override      = "{\"service_key\": \"your_pagerduty_api_integration_key\",\"event_type\": \"trigger\",\"description\": \"Alert: Triggered {{TriggerType}} for Monitor {{Name}}\",\"client\": \"Sumo Logic\",\"client_url\": \"{{QueryUrl}}\"}",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    },
    {
      connection_type       = "Webhook",
      connection_id         = "<CONNECTION_ID>",
      payload_override      = "",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    }
  ]

Replace <CONNECTION_ID> with the connection id of the webhook connection. The webhook connection id can be retrieved via calling the Monitors API.

For overriding payload for different connection types, refer to this document.

Email Notifications Example:
email_notifications = [
    {
      connection_type       = "Email",
      recipients            = ["abc@example.com"],
      subject               = "Monitor Alert: {{TriggerType}} on {{Name}}",
      time_zone             = "PST",
      message_body          = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    }
  ]

Step 6: Install the Alerts

  1. Navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/redis/ and run terraform init. This will initialize Terraform and will download the required components.
  2. Run terraform plan to view the monitors which will be created/modified by Terraform.
  3. Run terraform apply.

Step 7: Post Installation

If you haven’t enabled alerts and/or configured notifications via the Terraform procedure outlined above, we highly recommend enabling alerts of interest and configuring each enabled alert to send notifications to other people or services. This is detailed in Step 4 of this document.

Install the App

This section demonstrates how to install the Redis ULM App.

To install the app:

Locate and install the app you need from the App Catalog. If you want to see a preview of the dashboards included with the app before installing, click Preview Dashboards.

  1. From the App Catalog, search for and select the app. 

  2. Select the version of the service you're using and click Add to Library.

  1. To install the app, complete the following fields.

    1. App Name. You can retain the existing name, or enter a name of your choice for the app.


    2. Data Source. 
Choose Enter a Custom Data Filter, and enter a custom Redis cluster filter. Examples:

      1. For all Redis clusters
        db_cluster=*
      2. For a specific cluster:
        (db_cluster=redis.dev.01).

      3. Clusters within a specific environment:
        db_cluster=redis-1 and environment=prod 
        (This assumes you have set the optional environment tag while configuring collection)
  2. Advanced. Select the Location in Library (the default is the Personal folder in the library), or click New Folder to add a new folder.

  1. Click Add to Library.

Once an app is installed, it will appear in your Personal folder, or other folder that you specified. From here, you can share it with your organization. 

Panels will start to fill automatically. It's important to note that each panel slowly fills with data matching the time range query and received since the panel was created. Results won't immediately be available, but with a bit of time, you'll see full graphs and maps.

Dashboard Filter with Template Variables  

Template variables provide dynamic dashboards that rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you can view dynamic changes to the data for a fast resolution to the root cause. For more information, see the Filter with template variables help page.

Redis - Overview

The Redis - Overview dashboard provides an at-a-glance view of the Redis server status, error logs along with database metrics.

Use this dashboard to:

  • Gain insights into Redis cluster Master and Slave status.
  • Gain insights into your Redis health using Cache Hit Rate, Fragmentation Ratio, and Slow Queries Log.
  • Get insights into Active and rejected client connections.

Redis ULM - Overview.png

Redis - Cluster Overview

The Redis - Cluster Overview dashboard provides a high-level view of cluster infrastructure, comparisons, and trends.

Use this dashboard to:

  • Review Cluster infrastructure.
  • Manage Redis versions running on nodes.
  • Understand Master and Slave replication offsets.

Redis ULM - Cluster Overview.png

Redis - Cluster Operations

The Redis - Cluster Operations dashboard provides a high-level view of the activity and health of Master and Slaves on your network. Dashboard panels display visual graphs and detailed information on replication offsets, cache rate, and most importantly, resource usage.

Use this dashboard to:

  • To understand the Cluster resource usage.
  • Gain insights into cache hit and miss rates.

Redis ULM - Cluster Operations.png

Redis - Logs

The Redis - Logs dashboard provides a detailed analysis based on logs. The panels provide details such as RDBMemory Usage, events, RDB, and AOF events.

Use this dashboard to:

  • Review errors and warnings generated by the server. 
  • Review the RDBMemory Usage, events, RDB and AOF events.

Redis ULM - Logs.png

Redis - Command Stats Deltas

The Redis - Command Stats Deltas dashboard provides an at-a-glance view of commands running on your Redis server.

Use this dashboard to:

  • To gain insights into the commands running on your cluster.

Redis ULM - CommandStatsDeltas.png