Skip to main content

Redis plugin

The APEX AIOps Incident Management Redis plugin collects data about the Redis data structure store (used as a database, cache, message broker, and/or streaming engine). The collected metrics include data about Redis, such as uptime data, and also include data from persistent database records in real time. The Incident Management Collector ingests these metrics to enhance and refine alert correlation and to increase the context of your Redis incidents.

Install Redis

The first step toward sending data to Incident Management with the Redis plugin is to download and install Redis on the systems that you want to monitor.

Configure and enable the Redis plugin

You must have a collector installed to use the Redis plugin. See Install a Linux or MacOS collector or Install a Windows OS collector.

To configure and enable the Redis plugin, do the following:

  1. Navigate to Integrations > Inbound Integrations > Collectors and click the name of an installed Incident Management Collector to install a plugin.

    Note

    If you click on Redis in the Plugins tab or the main Inbound Integrations page, a dialog prompts you to install a collector or configure an existing collector.

  2. Click the Redis tile or name in the list.

  3. In the Configuration panel, enter the parameter configuration information.

    Redis Parameter Configuration:

    • Endpoints — The list of endpoints to monitor; enter as many as needed. To add an endpoint to monitor, enter the endpoint URL and press Enter.

      The default setting:

      redis://127.0.0.1:6379

      If you install Redis on the same system as your Incident Management Collector, you can use this default. If you install Redis on another system, you must use the IP address of that system and may also need to use a different port number.

    • Add Authentication — Click Add Authentication to require Credentials to use this plugin. You can select from an existing list of Credentials, or Add New Credentials.

      You must also set up credentials in your Redis system for authentication to work.

      Add New Credentials

      • Name — Enter a name for this Redis configuration credentials. This is a required field.

      • Password — Enter a unique password. This is a required field.

      • Save — Click Save to retain these parameters in the Incident Management Credentials Store.

    • Scrape Interval (sec) — Set the frequency with which Incident Management monitors and ingests metrics. The default is every 15 seconds.

  4. Click Enable when you are ready to start plugin data ingestion.

Validate the Redis plugin integration

To validate the integration, you have the following options:

  1. Click Inbound Integrations > Collectors > specific collector > Plugins and check the Configured and Enabled columns in the list view. Both should have a check mark in each column.

  2. Click Inbound Integrations > Collectors > specific collector >Collector Logs to view a line-by-line progress readout of your integrations.

  3. Navigate to Incidents > Metrics to check for the Redis metrics information, such as uptime, that is gathered by the Incident Management Collector and Redis plugin.

  4. In the Metric filter, you can apply a filter such as metric = redis_used_cpu_user as a litmus test to see if the plugin is running.