Credentials and Discovery

Download this manual as a PDF file

The following sections describe how to configure and discover a RabbitMQ system for monitoring by SL1 using the AMQP: RabbitMQ PowerPack:

Prerequisites for Monitoring RabbitMQ

To configure SL1 to monitor a RabbitMQ system using the AMQP: RabbitMQ PowerPack, you must first have the following information: 

  • The IP address of the server running the RabbitMQ system
  • The username and password for a RabbitMQ user that has read permission to the RabbitMQ API. For information about configuring users in RabbitMQ, see https://www.rabbitmq.com/management.html.

Creating a Credential for RabbitMQ

To configure SL1 to monitor a RabbitMQ system, you must first create a Basic/Snippet credential. This credential allows the Dynamic Applications in the AMQP: RabbitMQ PowerPack to communicate with your RabbitMQ system.

The PowerPack includes an example Basic/Snippet credential that you can edit for your own use.

To configure a Basic/Snippet credential to access a RabbitMQ system:

  1. Go to the Credential Management page (System > Manage > Credentials).
  2. Locate the RabbitMQ - EXAMPLE credential, then click its wrench icon (). The Edit Basic/Snippet Credential modal page appears.

  1. Enter values in the following fields:
  • Profile Name. Enter a name for the RabbitMQ credential.

  • Hostname/IP. Use the provided "http://%D".

NOTE: The IP address in the Hostname/IP field must be preceded by "http://".

  • Username. Enter the username for a RabbitMQ user that has read permission to the RabbitMQ API.
  • Password. Enter the password for the user you entered in the Username field.
  1. Leave all other fields set to the default values. Click the Save As button.

Discovering RabbitMQ Devices

To monitor your RabbitMQ system, you must run a discovery session to discover the server on which RabbitMQ is installed.

To discover the server on which RabbitMQ is installed, perform the following steps:

  1. Go to the Discovery Control Panel page (System > Manage > Classic Discovery).

  1. In the Discovery Control Panel, click the Create button.

  1. The Discovery Session Editor page appears. In the Discovery Session Editor page, define values in the following fields:
  • IP Address/Hostname Discovery List. Enter the IP address for the server on which RabbitMQ is installed.

  • SNMP Credentials. Optionally, select the SNMP credential for the Linux or Windows server you are discovering.
  • Other Credentials. Select the Basic/Snippet credential you created for the RabbitMQ API.
  • Discover Non-SNMP. Select this checkbox.
  1. Optionally, you can enter values in the other fields on this page. For more information about the other fields on this page, see the Discovery & Credentials section.
  2. Click the Save button to save the discovery session and then close the Discovery Session Editor window.
  3. The discovery session you created appears at the top of the Discovery Control Panel page. Click its lightning-bolt icon () to run the discovery session.
  4. The Discovery Session window appears. When the device is discovered, click the device icon () to view the Device Properties page for the device.

Verifying Discovery and Dynamic Application Alignment

To verify that SL1 automatically aligned the correct Dynamic Applications during discovery:

  1. From the Device Properties page for the server on which RabbitMQ is installed, click the Collections tab. The Dynamic Application Collections page appears.

  1. All applicable Dynamic Applications for RabbitMQ are automatically aligned during discovery.

    It can take several minutes after the discovery session has completed for Dynamic Applications to appear in the Dynamic Application Collections page.

The following Dynamic Applications should be aligned to the device:

  • AMQP: RabbitMQ Configuration
  • AMQP: RabbitMQ Performance

If the listed Dynamic Applications have not been automatically aligned during discovery, you can align them manually. To do so, perform the following steps:

  • Click the Action button and then select Add Dynamic Application. The Dynamic Application Alignment page appears.

  • In the Dynamic Applications field, select the Dynamic Application you want to align.
  • In the Credentials field, select the Basic/Snippet credential you created for the RabbitMQ API.
  • Click the Save button.
  • Repeat steps 1-4 for the other unaligned Dynamic Applications.

Aligning the RabbitMQ Device Class

By default, SL1 discovers the server running the RabbitMQ system as a Linux, Windows, or Pingable device. Optionally, you can align the AMQP | RabbitMQ device class to the device.

To align the device class:

  • Go to the Device Manager page (Registry > Devices > Device Manager).

  • Find the device you want to edit. Click its wrench icon ().

  • In the Device Properties page, find the Device Class field. Click the toolbox icon ().

  • In the Select New Device Class modal page, select the AMQP | RabbitMQ device class.

  • Click the Apply button.
  • In the Device Properties page, deselect the Auto-Update checkbox.
  • Click the Save button.