What is SDK Application

OpsRamp’s SDK is a collection of software development kits that enable developers to create custom applications for discovery, monitoring, and integration within an IT environment. These applications can be developed using various programming languages, offering flexibility in tool selection. Using OpsRamp’s SDK allows for the creation of automated and tailored solutions through interaction with its APIs, facilitating infrastructure management, incident resolution, workflow automation, and seamless integration with other tools or services.

Note: Not all existing integrations are SDK applications, see [Supported Apps] section for further details on which applications fall under this category.

How SDK Applications Work

SDK integration functions similarly to other discovery and monitoring integrations. The distinction lies in the following facts:

  • You need not manually assign templates to resources discovered within the applications. The OpsRamp platform automatic assigns the respective templates to resources based on their native type upon creation. To accomplish this,

  • Global data management policies (DMP) are created. These policies handle the task of assigning the right template to the right resource.

Note: You can either use default templates or customize them according to business requirements. For information on customization, refer to [How to customize device management policies (DMP) and Templates].

Install an SDK Application

  1. To select your client, navigate to All Clients, and click the Client/Partner dropdown menu.

Note

You may either type your client's name in the search bar or select your client from the list.


  1. Navigate to Setup > Account. The Account Details screen is displayed.
  2. Click Integrations. The Installed Integrations screen is displayed with all the installed applications.

Note

If you do not have any installed applications, you will be navigated to the Available Integrations and Apps page with all the available applications along with the newly created application with the version.



  1. Click + ADD on the Installed Integrations page.

Note

  • Search for the integration either by entering the name of the integration in the search bar or by selecting the category of the integration from the All Categories dropdown list.
  • You can export and then import an integration from one client to another.
To Export:
  1. Click the action menu (three dots) against the integration and click Export to download the JSON file onto your computer. This file has all the data related to the integration.
  • You can now import the downloaded JSON file.
To import:
  1. Click the import icon available at the upper-right corner of the page.
  2. Click Upload File from the popup window.
  3. Select the JSON file.
  4. Click Open and then click Import. The Integration is imported.
Note: You can import an integration into another client under the same partner or select another partner and a client.



  1. Click ADD on the required integration and select its latest version.

Note

For example, let us consider HPE SimpliVity integration.

  1. In the Configuration screen, click + ADD. The Add Configuration screen appears.
  2. Enter the following BASIC INFORMATION:

Note

The basic information will change for each application. See the Configuration Settings section of the specific integration to know the details of the configuration. For example, if you selected HPE SimpliVity, see Configure and Install the HPE SimpliVity Integration to configure the integration.



Field NameDescriptionField Type
NameEnter the name for the configuration.String
Virtual controller IP AddressVirtual controller IP address of the HPE SimpliVity.String
API PortAPI Port

Note: By default 443 is the port value.		Integer
Is SecureSelect this checkbox if you want the communication between your system and the specified endpoint to be secured using protocols such as HTTPS (HTTP over SSL/TLS).

Default Selection: Selected

When selected, it signifies that the connection is encrypted, providing an added layer of security to the data being transmitted.v		Checkbox
HPE SimpliVity Virtual Controller CredentialSelect the credential associated with your HPE SimpliVity account. If you want to use the existing credentials, select them from the Select Credentials dropdown. Else, click + Add to create credentials. The ADD CREDENTIAL window is displayed. Enter the following information.
  • Name: Credential name.
  • Description: Brief description of the credential.
  • User Name: User name.
  • Password: Password.
  • Confirm Password: Confirm password
Dropdown
App Failure NotificationsWhen selected, you will be notified in case of an application failure such as Connectivity Exception, Authentication Exception.Checkbox
  1. CUSTOM ATTRIBUTES: Custom attributes are the user-defined data fields or properties that can be added to the preexisting attributes to configure the integration.
Field NameDescriptionField Type
Custom AttributeSelect the custom attribute from the dropdown. You can add attributes by clicking the Add icon (+).Dropdown
ValueSelect the value from the dropdown.Dropdown

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  1. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select recurrence pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.


Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.
12. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.
Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.
13. Click NEXT. The Select Collector Profile screen appears. 14. (Optional) Click +ADD to create a new collector. You can either use the pre-populated name or give the name to your collector.
15. Select an existing registered profile.


  1. Click FINISH.

  2. The application is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

    • CONFIGURED: The installation request has been sent.
    • RUNNING: The installation was successful.
    • INSTALL FAILED: The installation has failed.
    • STOPPED: The gateway profile is down.


How to check SDK application status

Application Validation

  • Once the integration is installed and configured:
    • Discovery action is initiated.
    • Discovered resources are showcased in the OpsRamp portal.
  • Connections between different resources are established as per the specifications provided in the individual integration document.
  • Upon resource creation:
    • Monitoring templates are automatically assigned based on predefined policies set in the Device Management Policy.
    • Monitoring of the newly created resource begins, and data metrics are collected according to the specified monitoring intervals.

Discovery of Resources

Resource discovery ensures that OpsRamp can identify all relevant resources within the environment of another application. This allows OpsRamp to automatically monitor and manage these resources, providing users with comprehensive visibility and control over their IT infrastructure. For example, let us consider HPE SimpliVity as a new integration. Once the integration is complete, OpsRamp can identify all the relevant resources within the HPE SimpliVity environment.

Note

For example, let us consider HPE SimpliVity as a new integration in the following procedure:

To verify the resources, relationships and to monitor metrics of the integration:

  1. Navigate to Infrastructure > Search.
  2. Select the Resource Categories and expand the relevant category.

Note

The sub-category details will be mentioned in the individual application document.

  1. Select HYPERCONVERGED INFRASTRUCTURE > HPE SimpliVity.
  2. The HPE SimpliVity page is displayed.


  1. Resource grouping is available based on Availability State, Native Type and Installed App Name.

Note

  • By default, Group by Native Type is selected.
  • You may also use the Filters dropdown to search with the following filters:
    • Installed App Name
    • Resource Type
    • Native Type
    • Operating System
    • Make


  1. Select any resource, the RESOURCE page appears from the right.

Note

  • Resource relationships are formed according to the hierarchy outlined in the application document.
  • Click the root native type resource, to view resource details displayed on the right side of the same window.
  • Components are displayed in RELATED RESOURCES.


  1. Navigate to the Attributes tab to view the basic resource details.


  1. Click the Monitors tab to view the assigned template on the resource.

Note

Click the Get Latest Metric Values against the template name to check the latest metric data.


  1. Click the Metrics tab to view the metric details for HPE SimpliVity.


Upgrade SDK application

  1. From All Clients, select a client.
  2. Navigate to Setup > Account.
  3. In the Account Details page, select the Integrations tab.
  4. In the Search bar, enter the application name you want to upgrade and click Search.

Note

If a new upgrade is available, you will observe an Update option within the application.

  1. Click Update and select the desired version.

Note

OpsRamp adheres to semantic versioning. There are three types of upgrade versions.

  • Patch: Patch upgrades typically involve changes only in the application code, such as bug fixes. There are no modifications to the application configuration or metric definitions. The last digit is incremented in the version number. For example, from 1.0.0 to 1.0.1.
  • Minor: Minor upgrades include changes from patch upgrades, if any, and modifications to the application configuration, like adding new parameters. You will be prompted to update configurations during the upgrade, ensuring compatibility with changes. For example, if new mandatory parameters are added, you must upgrade all configurations for the application. This increases the middle digit in the version number, e.g., from 1.0.0 to 1.1.0.
  • Major: Major upgrades include changes from minor upgrades, if any, and updates to metric definitions, like adding new metrics or revising existing ones. Users may need to adjust configurations during the upgrade process to accommodate these changes. For instance, if new mandatory configuration parameters are introduced, users must update all configurations for the specific app accordingly. This upgrade increases the first digit in the version number, such as from 1.0.0 to 2.0.0.
  • Status changes as follows:
    • UPDATING: Upgrade request sent and in progress.
    • RUNNING: Successfully updated.
    • UPDATE FAILED: Application upgrade failed.
    • STOPPED: Gateway profile is offline.

Alerting

App Failure Notifications

App Failure Notification alerts users when data collection fails due to device reachability issues or incorrect credentials. This feature prompts users to take immediate action to minimize metric graph gaps and ensure continuous monitoring.

During the application installation, users can enable App Failure Notifications on the configuration page. Enabling this option sends alerts with relevant exception messages.

If initial discovery fails (typically due to authentication issues) and App Failure Notifications is on, alerts appear on the selected “Gateway” resource. Successful root resource creation triggers subsequent exception alerts on the root resource.

Both discovery and monitoring processes generate application failure alerts for exceptions. Users may receive Critical/Recovery failure notifications for the below two cases:

  • Connectivity exception.
  • Authentication exceptions.

Alert Recovery: If subsequent discovery or monitoring processes operate smoothly, the alert will be resolved.

Note

The application will send duplicate or repeat failure alert notifications every 6 hours.

Clone Device Management Policies (DMP) and Templates

The process of publishing the applications will create device management policies (DMP) & Templates for each native Type with global scope.

As soon as the resource gets created through the application, the DMP is triggered, and templates are auto assigned.

Follow the steps below to clone and customize both DMPs & Templates before or after installing the application.

  1. Navigate to Setup > Resources > Device Management Policies

  2. Click the Advanced search dropdown menu and select Global Policies.

  3. Search for the DMP using its name. Each DMP adheres to the following naming convention:
    {appName nativeType - version}

    Example: hpe-alletra HPE Alletra Port - 1

  4. Click the clone icon against the DMP name to clone the global DMP.


  1. The Device Management Policy page appears.
  2. Select the following information:
Field NameDescription
ScopeSelect either Partner or Client.
Note:
  • You must choose a client from the dropdown list when you select Client as the Scope.
  • You may select Include All Clients, Include Clients, or Exclude clients when Partner is the Scope.
NameProvide the name for cloned DMP.
  1. In the Add Using Query section, the default query filter is available.
  2. The default assigned template details are provided in the Perform Actions section.
  3. In the Assigned Templates column, click the template clone icon.


  1. In the Monitor Templates page, you can perform the below customization:
  1. Enter the Template Name for the cloned template.
  2. In the Breach a Threshold section, double-click on any metric that requires customization. You can modify the below information:
      • Frequency
      • Warning Operator
      • Warning Thresholds
      • Warning RepeatCount
      • Critical Operator
      • Critical Threshold
      • Critical RepeatCount
  3. You may select the Alert, Apply Availability Monitor, and Alerts on Missing Components checkbox.
  4. Click Save.
  1. Click Save & Run Now.