Skip to content

Monitoring and Debugging Composite APIs Instances

For monitoring and debugging the execution of a composite API instance, DigitalSuite offers the options described below. They differ from those for process requests since the execution path of composite API tasks is not persisted.

Depending on the problems or errors you encounter, support from the application developers might be essential.

Process Reports

For a composite API that is called from a process activity, you can use a process report to monitor the execution of the activity. If the execution fails, the error shows up in the error log panel of the Process Console.

You can access the Process Console of DigitalSuite Studio, for example, from process requests listed in a process report. In the Reports module, you access the console by clicking a process request in a process report. In other DigitalSuite Studio modules, an Open Console option is provided where it might be necessary to check a composite API that is called from a process activity.

Logs Application

If an error message for a composite API that is called from a process activity is not explicit enough or if the composite API is neither triggered from a web interface nor from a process, but, for example, from an external system, you have to use the Logs Application for monitoring, a standard portal application that you can access from the Administration Applications section on your RunMyProcess DigitalSuite homepage. For an overview on the Logs Application, refer to Monitoring DigitalSuite Platform Activities.

The following logs provide execution details for monitoring composite API instances:

  • The Composite API Log shows the final status of composite API instances that have been executed. It is either Completed, Outdated, Cancelled, or Aborted. You do not get details about variables, the execution result, or errors in case of an aborted instance.

  • The API Call Log displays log information for all API calls made on the platform. They can be filtered to only show the calls related to composite APIs instances. In addition to the status of an instance, you can view the URL that was called, the number of call attempts, the call type (Internal or External), and its duration.

  • The Custom Log lists the errors that were thrown. If the execution of the composite API instance failed, you can find the error in this log. The filtering capabilities are restricted. You have to rely on the timestamp to find the error you are interested in.

In Live mode, only logs with severity of type SEVERE are stored and shown in the Logs Application.

Event Management

In addition to the Logs Application and other monitoring tools, you can use the Event Management capabilities of DigitalSuite to track and monitor composite API instances in real time.

Event Management allows you to configure events that capture specific activities or errors related to composite APIs, such as execution failures, timeouts, or abnormal termination statuses. These events can then trigger notifications, logging, or automated actions, helping you identify issues earlier and respond more effectively.

For example, you can define an event rule that listens for aborted or failed composite API instances and immediately notifies developers or operations teams. This complements the Logs Application by providing a more proactive approach to monitoring and alerting, rather than relying solely on manual log inspections.

Network Console

To check the result of the execution of a composite API 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 instance has been triggered and monitor its status, execution result, and the variables/parameters that have been sent.