Configuration and Discovery

Download this manual as a PDF file

The following sections describe how to configure Couchbase servers for monitoring by SL1 using the CouchBase PowerPack:

Prerequisites for Monitoring Couchbase

To configure SL1 to monitor Couchbase servers and component devices using the CouchBase PowerPack, you must have the login credentials for a user with administrative access to the Couchbase server.

Creating a Couchbase Credential

To use the Dynamic Applications in the CouchBase PowerPack, you must first define a credential in SL1. This credential enables the Dynamic Applications in the CouchBase PowerPack to monitor your Couchbase component devices. The PowerPack includes a sample SOAP/XML credential (Couchbase Sample Credential) that you can use as a template.

To define a Couchbase credential:

  1. Go to the Credential Management page (System > Manage > Credentials).

  1. Click the wrench icon () for the Couchbase Sample Credential. The Credential Editor modal page appears:

  1. Enter values in the following fields:
  • Profile Name. Type a new name for your Couchbase credential.

  • URL. Type the URL for the Couchbase server, or use the default value.
  • HTTP Auth User. Type the username for a user with administrative access to the Couchbase server.
  • HTTP Auth Password. Type the Couchbase administrator user's password.

Use the default values for the remaining fields.

  1. Click the Save As button, and then click OK.

Discovering Couchbase Devices

To discover Couchbase devices, you must create and run a discovery session that will discover the Couchbase server. You must then manually align the "Couchbase: Pool Discovery" Dynamic Application to the Couchbase server device.

To discover Couchbase devices:

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

  1. Click the Create button to create a new discovery session. The Discovery Session Editor window appears:

  1. Edit the following fields in the Discovery Session Editor window:
  • Name. Type a name for the discovery session.

  • IP Address/Hostname Discovery List. Type the IP address for the Couchbase server.
  • Other Credentials. Select the SOAP/XML credential you created for Couchbase.
  • 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 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 Couchbase is discovered, click its device icon () to view the Device Properties page for the Couchbase server.
  5. From the Device Properties page, click the Collections tab. The Dynamic Application Collections page appears.

  1. On theDynamic Application Collections page, click the Actions button and then select Add Dynamic Application. The Dynamic Application Alignment pane appears.

  1. In the Dynamic Applications field, select Couchbase: Pool Discovery.
  2. In the Credentials field, select the SOAP/XML credential you created for Couchbase.
  3. Click Save. The Dynamic Application appears on the Dynamic Application Collections page.

  1. To run the "Couchbase: Pool Discovery" Dynamic Application immediately, click its lightning bolt icon ().

Viewing Couchbase Component Devices

In addition to the Device Manager page (Registry > Devices > Device Manager), you can view Couchbase component devices in the following places in the user interface:

  • The Device View modal page displays a map of a particular device and all of the devices with which it has parent-child relationships. Double-clicking any of the devices listed reloads the page to make the selected device the primary device:

  • The Device Components page (Registry > Devices > Device Components) displays a list of all root devices and component devices discovered by SL1 in an indented view, so you can easily view the hierarchy and relationships between child devices, parent devices, and root devices. To view the component devices associated with Couchbase, find the Couchbase device and click its plus icon (+):

  • The Component Map page (Classic Maps > Device Maps > Components) allows you to view devices by root node and view the relationships between root nodes, parent components, and child components in a map. This makes it easy to visualize and manage root nodes and their components. SL1 automatically updates the Component Map as new component devices are discovered. The platform also updates each map with the latest status and event information. To view the map for Couchbase, go to the Component Map page and select the map from the list in the left NavBar. To learn more about the Component Map page, see the section on Views.