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

  • Alerts are generated when 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 APIs)
  • Integration failure details are not captured.
  • Integration failure monitoring is implemented only at the client-level.

Step 1: View metrics

  1. Navigate to Setup > Monitoring > Metrics.
  2. Use the search option to search for metric(s).
  3. From Collector Type, select Integration.

The following metrics are available for monitoring integration failures:

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.time-outsDefines the metric used to count the time-outs caused during outbound data flow.

Step 2: Create monitor

  1. Navigate to Setup > Monitoring > Monitors and click on +Add.

  2. Enter the following information:

    • Monitor Scope: Partner Monitor or Client Specific Monitor
    • Partner: (auto-populated)
    • Client: select_client
    • Adapter Type: Integration
    • Name: monitoring_name
    • Description: short-description
    • To add the integration failure metrics, click Add Metrics.
    • Select all the metrics and click Add Metrics.

  3. Click Save.

Step 3: Create template

  1. Navigate to Setup > Monitoring > Templates and click +Add.
  2. From the Select Template Scope, select Service Provider Template.
  3. From the Collector Type, select Integration.
  4. Select Monitors as Monitor Type.
  5. Enter Template Name and Description.
  6. In the Monitors section, click +Add.
  7. In the Frequency drop-down list, select the required frequency of polling to monitor selected metrics.
  8. In the Monitor Definition drop-down list, select the monitor created in the earlier step.
  9. Select the Alert checkbox for all parameters.
  10. Select the Warning Operator and define the value for the Warning Threshold.
  11. Select the Critical Operator and define the value for the Critical Threshold.
  12. Click Add. The monitors are added to the template.
  13. Click Save.

Step 4: Assign template to integration

You can assign templates, at the partner and client levels, to the integration for monitoring the integration failures.

Follow these steps to assign a template:

At the client level:

  1. Click on the Actions (three dots) icon for the integration and click on Assign template.
  2. From the Assign template window, use the search option to search for the template.
  3. Select the template and click on Assign Template. The template is assigned successfully.
    Note: If you are at the partner level, then a check box is displayed in the Assign template window. If you select the check box, then the template is inherited to all the child integrations.
  • To unassign a template:
    1. Follow steps 1 and 2 above.
    2. Click on Unassign.
      Note: Alternatively, you can select any other template and click on Reassign. The template that was previously assigned is automatically unassigned and the selected template is assigned.

Step 5: View alerts

  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.

An alert is triggered when there is an integration failure. The alert description includes a timestamp and an error message.

Timestamp format: Day + Month + Date + time (hours,minutes,seconds) +
time zone + year.

Integration failure event error message