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 APEX AIOps Incident Management Collector ingests these metrics to enhance and refine alert correlation, and to increase the context of your Redis incidents.

Install Redis

To have the Redis plugin send data to Incident Management, download and install Redis on the systems that you want to monitor.

Install an Incident Management Collector

To use the Incident Management Redis plugin, you need to install an Incident Management collector and select the Redis plugin:

  1. Install the Incident Management Collector on a host within your secure network.

  2. Navigate to the Integrations > Ingestion Services > Collector tab to configure and enable collector plugins.

    Do not go directly to the Plugins tab to configure the plugin, as the plugin needs to be associated with a specific collector to work properly.

You can set up a collector plugin when you download a new Incident Management Collector, or any time afterwards when configuring an existing collector. For more information about how to select a plugin to enable, see the topic, Install the Incident Management Collector.

Configure and enable the Redis plugin

To configure and enable the Redis plugin do the following:

  1. Navigate to the Ingestion Services > Collector tab and click on the name of an installed Incident Management Collector to install a plugin.

    Note

    If you click on Redis in the Plugins tab, a display panel prompts you to install a collector or configure an existing collector.

  2. Click on the Redis tile or list name.

  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 endpointURL and press Enter. The default is as follows: 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 need to use the IP address of that system and may also need to use a different port number.

    • Add Authentication — Click Add Authentication, if you want to require Credentials to use this plugin. You can select from an existing list of Credentials or Add New Credentials. You also need to 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 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 Ingestion Services > 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 Ingestion Services > Collectors > specific collector >Collector Logs to view a line-by-line progress readout of your integrations.

  3. Click Metrics in the left navigation bar 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 might want to apply a filter such as metric = redis_used_cpu_user as a litmus test to see if the plugin is running.

In this section: