Monitoring Composite APIs
For monitoring and debugging the execution of a composite API, you have the options described below.
Messages and Schedules
For composite APIs launched by an email, you can use the Messages module in DigitalSuite Studio for monitoring the processing of the email. For composite APIs triggered by a timer at specified times and intervals, you can use the Schedules module in DigitalSuite Studio for monitoring the execution of schedules. For details, refer to Messages and Schedules.
When the composite API is called from a process activity, you can use a process report to monitor the execution of the activity. If the execution fails, the corresponding error shows up in the error log panel of the Process Console. You can access the Process Console directly from the process instances listed in a process report. For details, refer to Process Console.
The Logs Application enables you to monitor activities on the RunMyProcess platform. For monitoring composite APIs, it is particularly useful when the error message of a process report is not explicit enough, or when the composite API was neither triggered from a web interface nor from a process, but, for example, from an external system. In those cases, the Logs Application is the only way to monitor the composite API.
The access to the Logs Application is restricted to users with an Administrator profile.
The execution details of a composite API are shown on separate tabs in the Logs Application:
Composite API Logs shows the final status of composite APIs that have run on the platform. It is either
Aborted. You do not get details about variables, the execution result, or errors in case of an aborted instance.
API Call Logs displays log information for all API calls made on the platform. They can be filtered (on the Protocol column) to only show the
COMPOSITE_APIrelated ones. In addition to the status of the composite API, you can view the URL that was called, the number of call attempts, the call type (
External), and its duration.
Custom Logs lists the errors that were thrown. If the execution of the composite API failed, you can find the error in this list. The filtering capabilities are restricted. You have to rely on the timestamp to find the error you are interested in. For details about debugging and error handling, refer to the Developer Guide.
In Live mode, only logs with severity
SEVERE are stored and shown in the Logs Application.
For details, refer to Logs Application.
To check the result of a composite API’s execution from a web interface, you can use your browser’s network console (usually part of the browser’s developer tools). It allows you to check if the composite API has been triggered and to monitor its status, execution result, and the variables/parameters that have been sent.