Documentation is now available for the Fall 2020 Update release!

Monitoring Integration Failures

Describes how to monitor events arising out of integration failures.

Leave Feedback


Events generated from integration failures (both inbound and outbound configurations) can be monitored. 

  • Alerts are generated when an integration failures occur.
  • Metrics are provided to monitor integration failures.
  • Templates are available to create and assign to the integration.

Monitoring integration failures are applicable to the following types of integrations:

  • Monitoring integration
  • Collaboration integration
  • Email Alert
  • Email Incident
  • Custom Integration (Only for client-based API’s)

Monitoring integration failures

Monitoring integration failures involves the following:

  1. Viewing metrics
  2. Creating a monitor
  3. Creating a template
  4. Assigning a template to integration
  5. Viewing alerts

Step 1: View metrics

To view the metrics, from the console:

  1. From All Clients, select a client.
  2. Go to Setup > Monitor Management > Metrics.
  3. From Collector Type, select Integration.

The following metrics are available for monitoring integration failures:

Metric Descriptions
MetricDescription the metric used to count the email failures.
integration.inbound.failures.countDefines the metric used to count the failures raised during the inbound data flow.
integration.inbound.reqs.throttledDefines the metric used to throttle the inbound requests.
integration.outbound.failures.countDefines the metric used to count the failures raised during the outbound data flow.
integration.outbound.timeoutsDefines the metric used to count the timeouts caused during outbound data flow.

Step 2: Create monitor

To create a monitor with integration failure metrics:

  1. Select Setup > Monitoring > Monitors and click +.
  2. Enter the following information and click Save.
    • Monitor Scope: Partner Monitor or Client Specific Monitor
    • Partner: (auto-populated)
    • Client: <select_client>
    • Adaptor Type: Integration
    • Name: <monitoring_name>
    • Description:
    • To add the integration failure metrics, click Add Metrics.
    • Select all the metrics and click Add Metrics.

Step 3: Create template

To create a template:

  1. Go to Monitor Management > Templates and click +.
  2. Enter the following information:
    1. From the Select Template Scope, select Global Template.
    2. From the Collector Type, select Integration.
    3. Select Monitor as Monitor Type.
    4. Provide Template Name and Description.
    5. In the Monitors section, click +Add.
      1. In the Frequency drop-down list, select the required frequency of polling to monitor selected metrics.
      2. In the Monitor Definition drop-down list, select the monitor created in the earlier step.
      3. Select the Alert checkbox for all parameters.
      4. Select the Warning Operator and define value for Warning Threshold.
      5. Select the Critical Operator and define value for Critical Threshold.
      6. Click Add. The monitors are added to the template.
  3. Click Save.

Step 4: Assign template to integration

To assign the template to an existing integration:

  1. Go to Integrations > Integrations.
  2. Select a client for the selected partner. All the installed integrations for the client are displayed.
  3. Select the integration and click the Monitoring tab to assign the template.
  4. Click +Assign Template. The list of templates are displayed.
  5. Select the template to be assigned to the client and click Assign Templates.
  6. The template gets assigned to the integration.

Step 5: View alerts

To view alerts created by integration failures:

  1. Go to Alerts, click Edit Criteria and select the Partner, Client.
  2. Select Alert Type > Monitoring and click Apply. All alerts raised from integration failure for the selected partner and client are displayed.
  3. Click the alert to view the details and click the Alert History tab to view complete details of the alert.