Integrations

OpsRamp provides a common platform to integrate different tools and applications used by an organization and provides a single interface to view and monitor all the events arising out of the IT infrastructure. The Integrations page contains information about the Integrations and Apps.

The main objective of integration is to ingest and integrate third-party events. During the integration process, you can define the integration events that you want to monitor. Integration Events are configured for Monitoring and Collaboration integration types. Using the Outbound configuration, you can define the integration events.

OpsRamp categorizes the tools and applications that are used to generate and monitor the events of a resource in an IT infrastructure.

View integrations

1. Click All Clients and select a client.
2. Select Setup > Integrations and Apps.

The Integrations page displays the Installed Apps.

Install an integration

To install an integration from:
Installed Apps

1. Select an app from the list.
2. Click + Account on the app card and follow the instructions on the screen.
   

Available Apps

1. Click +Add and select an app from the list.
2. Click Add on the app card and follow the instructions on the screen.

Notes

• The + Account on the card indicates that multiple integrations can be created.
• If the + Account is not present on the card, it indicates that multiple integrations cannot be created.
  For example, the Linux Patch Feed app as seen in the Integrations page illustration.
• The count next to the user icon indicates the number of integrations that have already been installed.

View app information

To view information about the app, click anywhere on the card. The options slide-out screen is expanded. To collapse the slide-out, click anywhere on the card.

The following information is available:

• Account - Name of the account.
• Added On - Date and time details of the added account.
• Added By - Information about the user who added the account.
• Status - Status of the account. Available only for some accounts.
• Enabled - Indicates whether the integration is enabled or disabled. Available only for some accounts.
  

The following actions can be performed:

• Action
  • Edit - allows you to edit the integration.
  • Uninstall - allows you to uninstall the integration. Mention the reason for uninstalling the integration and click Uninstall.
  • Rescan - allows you to rescan the resource.

    Note

    Uninstalling the integration cannot be reversed. Once uninstalled, the metrics, resources, alerts, and incidents related to that particular integration are impacted.

Search for apps

To search for an app, do the following:

Search from installed apps

1. Click Search and enter the search text. The apps that match the search text are displayed.
2. Additionally, you can select apps in a specific category. Click All Categories and select one or more options to view the integrations specific to that category.

Search from available apps

1. Click +Add. The Available Apps page is displayed.
2. Click Search and enter the search text. The apps that match the search text are displayed.
   • Additionally, you can select apps in a specific category. Click All Categories and select one or more options to view the integrations specific to that category.

Client and partner integrations

Clients and partners can directly install and configure integrations. However, clients and partners have different access:

• Clients can install all the supported integrations.

• Clients can edit integration configurations installed directly by a partner.

  • Every change creates a separate copy for the client.
  • After a change, the partner configuration does not apply to the client for the modified configuration.

• Partners can install only some of the integrations for clients (for example, monitoring and collaboration).

• Custom Integration is an exception where providing configuration details for every client is required when assigning integration to every client.

Multiple client integration

Partners can install and configure an integration without selecting a client and apply the same configuration to multiple clients selecting one client at a time. As a result, multiple clients can be assigned the installed and configured integration without repeating the same effort.

In the following scenario, a partner has six clients and wants to install a collaboration integration with the same configuration for five clients, but a different configuration for the sixth client.

Solution: A partner performs the following steps:

1. Install and configure the integration without selecting a client.
2. Select the name of one client.
3. Search for the configured integration by name and click to open the integration.
4. Then, from that integration screen, click the Install button. A click Install takes care of both installation and configuration.
5. Repeat steps 2-4 for the other four clients. All five clients get integration installed with the same configuration.
6. Repeat steps 2-4 for the sixth client.
7. Change the configuration. The sixth client receives the same installed integration but with a different configuration.

Authentication type

OpsRamp uses the following industry-standard authentication to establish a connection between OpsRamp platform and the third-party:

• OAuth 2.0:

  • OAuth 2.0 is a protocol that allows an application to authenticate against the server as a user.
    • OAuth 2.0 relies on HTTPS for security and provides secured delegate access to a resource based on the user.
    • OAuth 2.0 provides security by allowing a token to be issued by the Identity Provider to these third-party applications, with the approval of the user. The client then uses the token to access the resource on behalf of that user.

• Webhook:

  • Webhook is a token-based REST API.
    • Webhook enables third-party services to send real-time updates to OpsRamp .
    • Updates are triggered by some event or action by the Webhook provider and pushed to OpsRamp using HTTP requests. OpsRamp handles the request with custom logic, such as sending an email or storing the data in a database.

Connection direction

After the connection is established using the authentication type, you need to define the direction of the integration between OpsRamp platform and the third-party. OpsRamp supports the bi-directional flow of information between the third-party and OpsRamp .

OpsRamp supports the following types of integration directions:

Select the Integration Direction depending on the integration category.

Attribute maps

The attributes or properties of the third-party and OpsRamp are not uniform in nature. They differ in their naming structure and format. To have a uniform structure and to process the information exchange, you need to map the attributes of a third-party with those of OpsRamp . Depending on the type of integration, OpsRamp supports an extensive list of attributes and properties which can be configured/mapped as per the requirements.

After the attributes are mapped, OpsRamp processes the information received from the third-party and displays them in the portal.

For some webhook-based Integration, default attributes are already configured during installation. You do not need to map attributes manually. For example, Pingdom, Stackdriver, New Relic, OMS,

Integration events

The main objective of integration is to ingest and integrate third-party events into OpsRamp . During the integration process, you can define the integration events that you want OpsRamp to monitor. Integration Events are configured for Monitoring and Collaboration integration types. Using the utbound configuration, you can define the Integration Events.

OpsRamp supports creating/adding integration events for ServiceDesk and Resource entities. For each of these entities, you can define the required entity types and for each entity type, you can define an entity type event. For every event, placeholders are defined. You can select these placeholders (attributes) for the API payload.

Example: Concatenate and Substring under Functions attribute of placeholders help to define the entity types. If you want to create an incident:

• using Concatenate, add two strings in the same string.
• using Substring, add a delimiter to the main string.

Audit logs

OpsRamp captures all communication events between the third-party and the OpsRamp platform. Log information includes payloads events and their corresponding status.