Apps and integrations are how you would describe the necessary configuration that a gateway collector should use to authenticate itself, discover and monitor various types of IT assets in your environment. Since each distinct asset class in your environment is unique and requires unique configuration, OpsRamp allows you to onboard only those IT assets of interest to you.

Configure and Install Integrations

For the first-time login, the following screen is displayed under Apps and Integrations.

First time user screen

Follow these steps to configure and install an integration:

  1. Click ADD. The Available Integrations and Apps page is displayed with all the available integrations.

    List of Available integrations

  2. Search for the integration using the Search option.
    Alternatively click the All Categories drop-down located in the upper-right corner, and then select the appropriate category.

  3. Click ADD on the tile.

  4. Follow the steps to configure the integration. Note that the configuration steps for each integration may vary:

    • Name: Configuration name
    • IP Address: IP Address of the vCenter
    • CredentialSet: You can select a credential from the list or to add a credential, follow the below steps:
      • Click the +ADD option available in the CredentialSet dropdown. The ADD CREDENTIAL window is displayed.
        Enter the following information:
        • Name: Credential name.
        • Description: Brief description of the credential.
        • User Name: User name. If you use a domain account to access vCenter, specify the domain with the username in the format domain\username.
        • Password: Password of the vCenter
        • Confirm Password: Confirm password
        • Port: Port of the vCenter. Set 443 for a secure connection.
        • Secure: Select the Secure checkbox for encryption.
        • Connection Timeout (ms): Timeout in milliseconds.
      • Click ADD to add the credential to the credential list.

  5. vCenter Plug-ins Configurations (optional): Enable the vSAN checkbox.

  6. FILTER BY RESOURCE TAG: Click Any or All of the rules below to match any one or all of the conditions you define for filtering.
    Enter/select the values in the Key, Operator, and Value fields for filtering the resources.

  7. FILTER BY RESOURCE TYPE:
    ALL: All the existing and future resources will be discovered.
    SELECT: You can select one or multiple resources to be discovered.

  8. PERFORM ACTIONS: Select the Manage Device option, if you want the discovered devices to be managed.

  9. DISCOVERY SCHEDULE: Discovery is triggered based on the scheduled time. New resources added to the environment are automatically discovered.
    Choose one of the following Recurrence Patterns:

    • Hourly
    • Daily
    • Weekly
    • Monthly
    • None (On-demand discovery)

  10. Click NEXT.

Add a collector profile option
  1. Enter the collector profile name.
    • The Installation page displays a list of existing collector profiles, if collector profiles have been installed already.
    • Select a gateway collector profile.
    • If you want to add a new gateway collector profile, click ADD option available at the upper-right corner of the page, and then enter the collector profile name.
  2. Click FINISH.

The integration is installed and displayed under Apps and Integrations.

Actions on an Installed App

Click the three dots on the right side of the installed app and perform the following actions:

Options on an installed App
  • Customize Monitors: This option helps you to quickly modify the alerting thresholds, enable alerting for the metrics, and mark the metrics for availability computation.
  • Edit: This option allows you to edit the configuration.
  • Uninstall: The App will be uninstalled. The uninstall action on an integration will impact the metrics, resources, alerts, and incidents that depend on the integration, and is not reversible.
  • Copy Id: This option allows you to copy the installed App Id.
  • Rescan: This option allows you to rescan and discover the resources.

Customize Monitors

Monitoring customization helps you to quickly modify the alerting thresholds, enable alerting for the metrics, and mark the metrics for availability computation. The improved flow for monitoring customization is achieved from the INSTALLED INTEGRATIONS page as described below.

Follow these steps to customize monitors:

  1. Click on the installed App.

  2. The integration will show the list of installed apps.

  3. Click the three dots on the right side of installed apps.

  4. Click Customize Monitors from the popup. The Customize Monitors page is displayed, along with the list of applicable monitors for the respective integration, on the left hand side.

customize monitors option
  1. Click on the required monitor. The list of metrics will be displayed on the right hand side.

  2. Hover over the metric and click on the Edit icon.
    A popup window will be displayed.

metric popup window
  1. Modify the thresholds for the metrics as per the requirement: Select the warning operator and enter a value for the warning threshold and the Repeat Count. Follow this step for the critical expression.

  2. To receive alerts on a resource metric, select the Alert check box. To know the state of a resource, select the Apply Availability Monitor check box.

  3. Click DONE.

  4. Click SAVE to save the changes.

Following is a table that has information about the parameters in the metric popup: Note: The parameters in the metric popup may vary based on the App.

ParameterDescription
FrequencyIt is the rate at which the Gateway collector checks the metric data.
Frequency is defined in minutes (mins).
Warning ThresholdIf the metric value meets the defined warning threshold and the operator condition, then a notification is sent to the user.
Critical ThresholdIf the metric value meets the defined critical threshold and the operator condition, then a notification is sent to the user.
Repeat CountIt indicates the number of times the Repeat Frequency action should be performed. Example: If the Repeat Frequency is defined as 1 (mins) and Repeat Count is set to 3, it means whenever the CPU utilization is equal to or greater than the threshold value, the agent repeats capturing the CPU utilization details for the next three minutes.
AlertTo receive alerts on a resource metric, select the Alert check box.
Availability MonitorTo know the state of a resource, select the Apply Availability Monitor check box.

Modify an Installed Integration or Application

  1. Click the name of the integration or application. A list of configurations is displayed with the following information:

    • Name - Displays the name of the integration or application.

    • Version - Displays the version details of the integration.

    • Collector Profile - Displays the name of the collector profile.

    • Status - Displays the status of the collector profile. The status is a combination of both the gateway and application. Example: If the gateway status is up and the application status is installed, then the status is shown as Running.

      Note: The following statuses are applicable to SNMP, Linux, and discovery apps/integrations.

    Gateway StatusApplication Status
    InstalledEnabled
    UpRunningRunning
    DownStoppedStopped
    Not Installed/Deployed/RegisteredConfiguredConfigured
    • Added On - Displays the date and time details of the added integration or application. The user icon next to the time indicates the user who added the application.
    Modify the integration
    • The following options are available when you click the action icon (three dots):

      • Edit: To edit an integration, click this button.
      • Copy Id: To copy an integration id, click this button.
      • Uninstall: To uninstall an integration, click this button.

      Note: Based on the integration type, the options for each app may vary.

Modify the integration

Edit an integration

  1. Click Edit from the three dots or click the name of the integration. The Configurations page is displayed with a list of available configurations specific to the selected integration.
  2. Click the three dots available for the configuration and click Edit.
  3. In the Edit Configuration window that appears, edit the configuration and click Update.

Copy an integration id

  • Click the three dots available for the integration and click Copy Id. The integration id is copied.

Uninstall an integration

  1. Click the three dots available for the integration and click Uninstall.

  2. In the Uninstall Integration window that appears, mention the reason for uninstalling and click UNINSTALL. The configuration is uninstalled.

    Note: When you uninstall an integration, the resources associated with all configurations are also deleted.

Modify a configuration

Configurations are available for each integration. The following actions can be performed on the configurations from the three dots next to each configuration:

  • Edit: To edit a configuration, click this button.
  • Remove: To remove a configuration, click this button.
  • Discover: To discover a configuration, click this button.
Modify the integration

Edit a configuration

  1. Click Edit from the three dot menu of a configuration.

  2. In the Edit Configuration window, edit the configuration and click Update.

    Notes:

    • You may also uninstall multiple configurations at the same time. Select configurations from the list in the Edit page and click UNINSTALL at the top right.
    • You may also add a new configuration from the Edit page by clicking + ADD.
Modify the integration

Remove a configuration

  1. Click Remove from the three dots of a configuration that you want to remove. A confirmation message appears.

  2. Click Delete to remove the configuration. Click Cancel to go back.

    Note: When you remove a configuration, the resources associated with that configuration are also deleted.

Discover a configuration

  • Click the three dot menu available for the configuration and click Discover. A discovery is initiated and the status is displayed under the Discovery status column.