{
  "schema_version": 2,
  "id": "integrate/nagios-with-redis-enterprise",
  "title": "Nagios with Redis Software",
  "url": "https://redis.io/docs/latest/integrate/nagios-with-redis-enterprise/",
  "summary": "The Redis Software (RS) Nagios plugin enables you to monitor the status of RS related objects and alerts. The RS alerts can be related to the cluster, nodes, or databases.",
  "tags": [
    "docs",
    "integrate",
    "rs"
  ],
  "last_updated": "2026-09-17T14:54:30+01:00",
  "children": [],
  "page_type": "content",
  "content_hash": "d7591a4a3b947548a56272fe2d7381be10b44fd9a9ebadd17ae12f56fcead5f9",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "The Nagios plugin has been retired as of Redis Software version 7.2.4.\n\n\nThe Redis Software (RS) Nagios plugin enables you to monitor the status of RS related\nobjects and alerts. The RS alerts can be related to the cluster, nodes,\nor databases.\n\nThe alerts that can be monitored via Nagios are the same alerts that can\nbe configured in the RS UI in the Settings ­\\> Alerts page, or the\nspecific Database ­\\> Configuration page.\n\nAll alert configurations (active / not active, setting thresholds, etc')\ncan only be done through the RS UI, they cannot be configured in Nagios.\nThrough Nagios you can only view the status and information of the\nalerts.\n\nThe full list of alerts can be found in the plugin package itself (in\n\"/rlec_obj/rlec_services.cfg\" file, more details below).\n\nRS Nagios plugin support API password retrieval from Gnome keyring,\nKWallet, Windows credential vault, Mac OS X Keychain, if present, or\notherwise Linux Secret Service compatible password store. With no\nkeyring service available, the password is saved with base64 encoding,\nunder the user home directory."
    },
    {
      "id": "configuring-the-nagios-plugin",
      "title": "Configuring the Nagios plugin",
      "role": "configuration",
      "text": "In order to configure the Nagios plugin you need to copy the files that\ncome with the package into your Nagios environment and place them in a\nNagios configuration directory. Or, alternatively you can copy parts of\nthe package configuration into your existing Nagios configuration.\n\nIf Keyring capabilities are needed to store the password, python keyring\npackage should be installed and used by following the below steps from\nthe operating system CLI on Nagios machine:\n\n1. pip install keyring ­to install the package (See\n    https://pip.pypa.io/en/stable/installing/ on how to install python\n    pip if needed).\n1. keyring set RS-Nagios ­\\<RS user email\\> to set the password.\n    User email should be identical to the email used in Nagios\n    configuration and the password should be set using the same user\n    that run the Nagios server.\n\nThen, you need to update the local parameters, such as hostnames,\naddresses, and object IDs, to the values relevant for your\nRS deployment.\n\nFinally, you need to set the configuration for each node and database\nyou would like to monitor. More details below.\n\nThe RS Nagios package includes two components:\n\n- The plugin itself ­- with suffix \"rlec_nagios_plugin\"\n- Configuration files - with suffix \"rlec_nagios_conf\"\n\nBelow is the list of files included in these packages and instructions\nregarding what updates need to be made to these flies.\n\nNote : The instructions below assume you are running on Ubuntu, have a\nclean Nagios installation, and the base Nagios directory is\n\"/usr/local/nagios/\""
    },
    {
      "id": "step-1",
      "title": "Step 1",
      "role": "content",
      "text": "Copy the folder named \"libexec\" from the plugin folder and its contents\nto \"/usr/local/nagios/\"\n\nThese files included in it are:\n\n- check_rlec_alert\n- check_rlec_node\n- check_rlec_bdb\n- email_stub\n- rlecdigest.py\n\nNote : The check_rlec_alert, check_rlec_node, check_rlec_bdb files\nare the actual plugin implementation. You can run each of them with a\n\"­h\" switch in order to retrieve their documentation and their expected\nparameters."
    },
    {
      "id": "step-2",
      "title": "Step 2",
      "role": "content",
      "text": "Add the following lines to your \"nagios.cfg\":\n\n- cfg_dir=/usr/local/nagios/etc/rlec_obj\n- cfg_dir=/usr/local/nagios/etc/rlec_local\n- resource_file=/usr/local/nagios/etc/rlec_resource.cfg"
    },
    {
      "id": "step-3",
      "title": "Step 3",
      "role": "content",
      "text": "Copy the configuration files along with their folders to\n\"/usr/local/nagios/etc\" and make the required updates, as detailed\nbelow.\n\n1. Under the \"/etc\" folder:\n    1. \"rlec_resource.cfg \" ­ holds global variables definitions for\n        the user and password to use to connect to RS. You should update\n        the variables to the relevant user and password for your\n        deployment.\n    1. \"rlec_local \" folder\n    1. \"rlec_obj\" folder\n1. Under the \"/rlec_local\" folder:\n    1. \"cluster.cfg \" ­ holds configuration details at the cluster\n        level. If you would like to monitor more than one cluster then\n        you need to duplicate the two existing entries in the file for\n        each cluster.\n        1. The first \"define host\" section defines a variable for the\n            IP address of the cluster that is used in other\n            configuration files.\n            1. Update the \"address\" to the Cluster Name (FQDN) as\n                defined in DNS, or the IP address of one of the nodes in\n                the cluster.\n            1. If you are configuring more than one RS then when\n                duplicating this section you should make sure:\n                1. The \"name\" is unique.\n        1. In the second \"define host\" section:\n            1. The \"host_name \" in each entry must be unique.\n            1. The \"display_name\" in each entry can be updated to a\n                user-friendly name that are shown in Nagios UI.\n    1. \"contacts.cfg \" ­ holds configuration details who to send emails\n        to. It should be updated to values relevant for your deployment.\n        If this file already exists in your existing Nagios environment\n        then you should update it accordingly.\n    1. \"databases.cfg\" ­ holds configuration details of the databases\n        to monitor. The \"define host\" section should be duplicated for\n        every database to monitor.\n        1. \"host_name\" should be a unique value.\n        1. \"display_name \" should be updated to a user-friendly name\n            to show in the UI.\n        1. \"_RLECID \" should be the database's internal ID that can\n            be retrieved from\n            [`rladmin status`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/status) command output.\n    1. \"nodes.cfg \" ­ holds configuration details of the nodes in the\n        cluster. The \"define host\" section should be duplicated for\n        every node in the cluster.\n        1. \"host_name\" should be a unique value.\n        1. \"display_name \" should be updated to a user-friendly name\n            to show in the UI.\n        1. \"address\" should be updated to the DNS name mapped to the\n            IP address of the node, or to the IP address itself.\n        1. \"_RLECID \" should be the node's internal ID that can be\n            retrieved\n            from [`rladmin status`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/status) command output.\n    1. Under the \"/rlec_obj\" folder:\n        1. \"rlec_cmd.cfg\" ­ holds configuration details of how to\n            activate the plugin. No need to make any updates to it.\n        1. \"rlec_groups.cfg\" holds definitions of host groups. No need\n            to make any updates to it.\n        1. \"rlec_services.cfg\" holds definitions of all alerts that\n            are monitored. No need to make any updates to it.\n        1. \"rlec_templates.cfg\" holds general RS Nagios definitions.\n            No need to make any updates to it."
    }
  ],
  "examples": []
}