Monitoring an IIEP via External System

Integration endpoints can be monitored from external systems using Monitoring Sensors or the REST API.

Performance Data

When using a sensor with details, the 'Performance Data' section of the status page includes the information outlined below.

Note: All of the background processes (BGPs) of the IEP are collected and grouped by the Status, Wait Time, and Run Time in the database.

  • Max Run Time - largest value in the Run Time column; determines the longest Run Time among all IEP BGPs.
  • Mean Run Time - average value in the Run Time column; determines the average Run Time among all IEP BGPs.
  • Min Run Time - smallest value in the Run Time column; determines the shortest Run Time among all IEP BGPs.
  • Total Run Time - sum of all values in the Run Time column; determines how much time all the IEP BGPs were running.
  • Max Wait Time - largest value in the Wait Time column; determines the longest Wait Time (in the queue) among all IEP BGPs.
  • Mean Wait Time - average value in the Wait Time column; determines the average Wait Time (in the queue) among all IEP BGPs.
  • Min Wait Time - smallest value in the Wait Time column; determines the shortest Wait Time (in the queue) among all IEP BGPs.
  • Number of Failed BGPs - count of the BGPs in 'completedwitherrors' and 'failed' states.
  • Number of handled requests - count of the BGPs NOT in the 'running' and 'waiting' states.
  • Number of running BGPs - count of the BGPs in 'completedwitherrors,' 'failed,' 'aborted,' and 'succeeded' states.
  • Number of waiting BGPs - count of the BGPs in the 'waiting' state.
  • Number Waiting In Receiver - IIEP specific; returns the number of messages waiting in the Receiver for handling. Returns -1 if the Receiver is not able to return the number of waiting messages.
  • Total number of BGPs - count of the BGPs in all possible BGP states ('completedwitherrors,' 'failed,' 'waiting,' 'running,' 'aborted,' and 'succeeded').

Monitoring Sensors

For each integration endpoint created in STEP, a Monitoring Sensor is automatically created. Monitoring Sensors allow external systems to query the status of individual endpoints via HTTP, without authentication. In the following sample URLs, substitute your own system URL and endpoint ID to access your own endpoints.

A Monitoring Sensor can return the following information:

  1. Simple traffic light response returns OK, WARNING, CRITICAL, or UNKNOWN for inbound endpoints via: 
http://[System URL]/admin/monitoring/InboundIntegrationEndpointStatus-[Endpoint ID]/status
  1. Nagios friendly response returns detailed statistics in Nagios friendly format for inbound endpoints via: 
http://[System URL]/admin/monitoring/InboundIntegrationEndpointStatus-[Endpoint ID]/nagios
  1. Full detailed XML response returns XML with detailed statistics for inbound endpoints via: 
http://[System URL]/admin/monitoring/InboundIntegrationEndpointStatus-[Endpoint ID]/xml

REST API Monitoring

An alternative to Monitoring Sensors is to use the REST API, which requires authentication.

  1. Overview of all configured integration endpoints via:
[Host]/restapi/integrationendpoints?context=[Context]&workspace=[Main]
  1. Detailed statistics for specific endpoint via:
[Host]/restapi/integrationendpoints/[Endpoint ID]?context=[Context]&workspace=[Main]
  1. Execution report for specific endpoint via:
[Host]/restapi/integrationendpoints/[Endpoint ID]/log?context=[Context]&workspace=[Main]
  1. Java log entries related to errors in Background Processes generated by specific endpoint via:
[Host]/restapi/integrationendpoints/[Endpoint ID]/errorexcerpts?context=[Context]&workspace=[Main]
  1. Overview of Background Processes generated by specific endpoint via:
[Host]/restapi/integrationendpoints/[Endpoint ID]/backgroundprocesses?context=[Context]&workspace=[Main]