Configuration and Discovery

Download this manual as a PDF file

The following sections describe how to configure and discover NGINX services for monitoring by SL1 using the "NGINX: Open Source and Plus" PowerPack:

Prerequisites for Monitoring NGINX Services

To configure the SL1 system to monitor NGINX services using the "NGINX: Open Source and Plus" PowerPack, note the following for monitoring the NGINX Open Source Software (OSS): 

  • The status module must be included when NGINX is instantiated.

  • The status stub must be configured in the NGINX configuration.

    NOTE: Restart NGINX after editing the configuration.

To learn more about the setup of the status module, see the following NGINX resources:

Creating a SOAP/XML Credential for NGINX

To configure SL1 to monitor NGINX web services, you must create a SOAP/XML credential. This credential allows the Dynamic Applications in the "NGINX: Open Source and Plus" PowerPack to communicate with your NGINX web server.

  1. Go to the Credentials page (Manage > Credentials).
  2. Locate the "Nginx: Open Src and Plus Example" credential sample credential, click its Actions icon () and select Duplicate. A copy of the credential appears.
  3. Click the Actions icon () for the "Nginx: Open Src and Plus... copy" credential copy and select Edit. The Edit Credential modal page appears.

    4. Editing a SOAP/XML credential.

  4. Enter the following values:
  • Name. Type a new name for the credential.
  • 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 (ms). Keep the default 10000.
  • URL. Type the URL for the NGINX: Open Source and Plus account controller.
  • HTTP Auth User. Type the username of an NGINX user account.
  • HTTP Auth Password. Type the NGINX user account password.
  • Embed Value [%1]. Leave blank by default.
  • Embed Value [%2]. Type a specific API endpoint name to connect to if you want to override the default/nginx_status endpoint for the "Nginx: Open Source Status Stats" Dynamic Application.
  • CURL Options. Edit the following field:
    • SSLVERIFYPEER=1. Enables the SSL verification. Entering 0 disables SSL verification.
  1. Click Save & Close.

Creating a SOAP/XML Credential in the SL1 Class User Interface

To configure SL1 to monitor NGINX web services in the classic user interface, you must create a SOAP/XML credential. This credential allows the Dynamic Applications in the "NGINX: Open Source and Plus" PowerPack to communicate with your NGINX web server.

To configure a SOAP/XML credential to access NGINX:

  1. Go to the Credential Management page (System > Manage > Credentials).
  2. Locate the NGINX: Open Src and Plus Example credential, and then click its wrench icon (). The Edit SOAP/XML Credential modal page appears.
  3. Enter values in the following fields:
  • Profile Name. Type a new name for the credential.
  • URL. Leave this field as the default.
  • Embed Value [%1]. Leave blank.
  • Embed Value [%2]. Type a specific API endpoint name to connect to if you want to override the default /nginx_status endpoint for the Nginx: Open Source Status Stats Dynamic Application.
  1. For all other fields, use the default values.
  2. Click the Save As button.

Discovering NGINX Devices with Guided Discovery

On the Devices page () or the Discovery Sessions page (Devices > Discovery Sessions), you can add or "discover" new devices for monitoring in SL1. You add devices by creating a discovery session, which searches for devices on the network you specify.

The guided discovery process lets you select a discovery type specific to the type of devices you want to monitor. The guided discovery wizard provides a filtered list of relevant credentials, the ability to create new credentials, and a reduced set of application-specific fields to help you efficiently discover the devices you need.

To run a guided discovery:

  1. On the Devices page () or the Discovery Sessions page (Devices > Discovery Sessions), click the Add Devices button. The Select page appears.
  2. Select the Nginx: Open Source And Plus button. Additional information regarding the requirements for device discovery appears in the General Information pane on the right.

    3. Selection page for Nginx:Open Source And Plus Guided Discovery

  3. Click Select. The Credential Selection page appears.

    4. Select your Nginx credential to edit

  4. Select the radio button for the "Nginx: Open Src and Plus Example" credential and click its Action icon (). Select Duplicate from the drop-down menu and the "Nginx: Open Src and Plus...copy" credential appears. Click its Action icon () and select Edit. The Edit Credential page appears.

    5. Edit the Nginx credential you created

  5. Complete the following fields:
  • Name. Type a new name for the credential.
  • 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 (ms). Keep the default 10000.
  • URL. Type the URL for the NGINX: Open Source and Plus account controller.
  • HTTP Auth User. Type the username of an NGINX user account.
  • HTTP Auth Password. Type the NGINXuser account password.
  • Embed Value [%1]. Leave blank by default.
  • Embed Value [%2]. Type a specific API endpoint name to connect to if you want to override the default/nginx_status endpoint for the "Nginx: Open Source Status Stats" Dynamic Application.
  • CURL Options. Edit the following field:
    • SSLVERIFYPEER=1. Enables the SSL verification. Entering 0 disables SSL verification.
  1. Click Save & Close to return to the Credential Selection page.
  2. On the Credential Selection page, select the credential you created and saved in steps 5 and 6, and then click Next. The Discovery Session Name page appears.
  3. Complete the following fields:
  • Root Device Name. Type the name of the server you want to monitor. Ensure you provide a unique server name to help identify the specific server being monitored, especially if you have multiple servers. does not recommend that you use the default name provided by the guided discovery.
  • Select the organization to add discovered devices. Select the name of the organization to which you want to add the discovered device.
  • Collector Group Name.Select an existing collector group to communicate with the discovered device.
  1. Click Next. SL1 creates the root device with the appropriate Device Class assigned to it and aligns the relevant Dynamic Applications. The Final Summary page appears.

    2. Final summary for Nginx guided discovery.

  2. Click Close.

The results of a guided discovery do not display on the Discovery Sessionspage (Devices> Discovery SessionsSessions).

Discovering NGINX Component Devices in the SL1 Classic User Interface

To model and monitor your NGINX services in the classic user interface, you must run a discovery session to discover your NGINX services. The following diagram illustrates the way the discovery process works for NGINX.

Several minutes after the discovery session has completed, the Dynamic Applications in the "NGINX: Open Source and Plus" PowerPack should automatically align to the services and then discover, model, and monitor the remaining NGINX component devices.

To discover the NGINX service that you want to monitor in the classic user interface, perform the following steps:

  1. Go to the Discovery Control Panel page (System > Manage > Classic Discovery).
  2. 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:
  • Name. Type a name for the discovery session.
  • IP Address/Hostname Discovery List. Type the IP address or hostname of your NGINX server.

  • Other Credentials. Select the SOAP/XML credentials you created for the NGINX service.
  • Initial Scan Level. Select 5. Deep discovery.
  • Detection Method & Port. Select TCP 80 - http and TCP 443 - https.
  • Discover Non-SNMP. Select this checkbox.
  • Model Devices. Select this checkbox.
  • Log All. Select this checkbox.
  1. Optionally, you can enter values in the other fields on this page.
  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 each device.

Verifying Discovery and Dynamic Application Alignmentin the SL1 Classic User Interface

To verify that SL1 has automatically aligned the correct Dynamic Applications during discovery in the classic user interface:

  • After discovery has completed, click the device icon for the NGINX service. From the Device Properties page for the NGINX service, click the Collections tab. The Dynamic Application Collections page appears.
  • All applicable Dynamic Applications for the service 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.


You should see the following Dynamic Applications aligned to the NGINX service:

  • Nginx: Plus Connection Stats
  • Nginx: Plus SSL Stats
  • Nginx: Plus Caches Discovery
  • Nginx: Plus Server Zones Discovery
  • Nginx: Plus Upstream Server Group Discovery

If the listed Dynamic Applications have not been automatically aligned during discovery, or you want to align more Dynamic Applications, 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 SOAP/XML credential you created for NGINX.
  • Click the Save button.
  • Repeat steps 1-4 for any other unaligned Dynamic Applications.

Viewing NGINX Component Devices

In addition to the Device Manager page (Devices > Classic Devices, or Registry > Devices > Device Manager in the classic SL1 user interface), you can view the NGINX service and all associated component devices in the following places in the user interface:

  • The Device View modal page (click the bar-graph icon [] for a device, then click the Topology tab) displays a map of a particular device and all of the devices with which it has parent-child relationships. Double-click to select any listed device. This reloads the page to make the selected device the primary device.

  • The Device Components page (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 an NGINX web server, find the server 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 an NGINX service, 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.