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 Basic/Snippet 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 and save for your own use.

To create a Basic/Snippet credential:

  1. Go to the Credentials page (Manage > Credentials).
  2. Locate the "RabbitMQ - Example" credential, then click its Actions icon () and select Duplicate from the drop-down field. The "RabbitMQ - Example copy" credential appears.
  3. Click the Actions icon () for the "RabbitMQ - Example copy" credential, then select Edit. The Edit Credential page appears.

    4. Edit the RabbitMQ Basic/Snippet credential

  4. Enter values in the following fields:
  • Name. Enter a new name for the credential. This field is required.
  • All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the Select the organizations the credential belongs to drop-down field to align the credential with those specific organizations.
  • Timeout. Enter the time, in milliseconds, after which SL1 will stop trying to communicate with the RabbitMQdevice. The default value is 30. This field is required.
  • Hostname/IP. Enter the RabbitMQ url. The default value is http://%D.
  • Port. Type "15672".
  • Username. Enter the username associated with the RabbitMQ administrator account.
  • Password. Enter the password associated with the RabbitMQ administrator account.
  1. Click Save & Close.

 

Creating a Basic/Snippet Credential for RabbitMQ in the SL1 Classic User Interface

To configure SL1 to monitor a RabbitMQ system in the SL1 classic user interface, 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 and save 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 create and run a discovery session that will discover a RabbitMQ appliance:

  1. Go to the Devices page () or the Discovery Sessions page (Devices > Discovery Sessions) and click the Add Devices button.
  2. Click the Unguided Network Discovery Workflow button. Additional information about that requirements for discovery appears in the General Information pane to the right.

    3. RabbitMQ Unguided Network Discovery Workflow

  3. Click Select. The three-step wizard appears starting with the Step 1 Basic Information tab.
  4. Complete the following fields:
  • Discovery Session Name. Type a unique name for this discovery session. This name is displayed in the list of discovery sessions on the Discovery Sessions tab.
  • Description.Optional. Type a short description of the discovery session. You can use the text in this description to search for the discovery session on the Discovery Sessions tab.
  • Select the organization to add discovered devices to. Select the name of the organization to which you want to add the discovered devices.
  1. Click Next. The Step 2 Credential Selection tab of the wizard appears.
  2. On the Credential Selection tab, locate and select the Basic/Snippet credential you created for RabbitMQ appliances.
  3. Click Next. The Step 3 Discovery Session Details tab of the wizard appears.
  4. Complete the following fields:
  • List of IP/Hostnames. Type the IP address for the RabbitMQ appliance.
  • Which collector will discover these devices?. Required. Select an existing collector to monitor the discovered devices.
  • Run after save. Toggle on (blue) to run this discovery session as soon as you save the session.
  • Advanced options. Click the down arrow () to complete the following fields:
    • Discover Non-SNMP. Toggle on (blue) to enable this setting.
    • Model Devices. Toggle on (blue) to enable this setting.
    • Select Device Template. If you configured a RabbitMQ device template, select it here. Otherwise, leave the default selection.
  1. If you enabled the Run after save option, click the Save and Run button. The discovery session will run and the Discovery Logs page will display any relevant log messages. If the discovery session locates and adds any devices, the Discovery Logs page will include a link to the Device Investigator page for the discovered device.
  2. If you did not enable the Run after save option, click the Save and Close button. The Discovery Sessions page (Devices > Discovery Sessions) will display the new discovery session.

 

Discovering RabbitMQ Devices in the SL1 Classic User Interface

To monitor your RabbitMQ system in the SL1 classic user interface, 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 or System > Manage > Discovery in the classic user interface).

  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:

  1. Go to the Device Manager page (Devices > Classic Devices, or Registry > Devices > Device Manager in the classic SL1 user interface).
  2. Find the device you want to edit. Click its wrench icon ().
  3. In the Device Properties page, find the Device Class field. Click the toolbox icon ().
  4. In the Select New Device Class modal page, select the AMQP | RabbitMQ device class.
  5. Click the Apply button.
  6. In the Device Properties page, deselect the Auto-Update checkbox.
  7. Click the Save button.