Message mediation mode is one of the operational modes of the ESB profile where the ESB profile functions as an intermediate message router. When operating in this mode, it can filter, transform, drop or forward messages to an endpoint based on the given parameters. A unit of the mediation flow is a mediator. Sequences define the message mediation behavior of the ESB profile. A sequence is a series of mediators, where each mediator is a unit entity that can input a message, carry out a predefined processing task on the message, and output the message for further processing.
What is debugging with respect to mediation
Debugging is where you want to know if these units, which function as separate entities are operating as intended, or if a combination of these units are operating as a whole as intended. The ESB profile packs the Mediation debugger that enables you to debug the ESB profile message mediation flow in the server. Tooling support for the Mediation debugger is provided by the WSO2 Integration Studio Plugin which comes out of the box with WSO2 Integration Studio.
First follow the steps below to create a sample the ESB profile artifact, which you will debug .
- Install the plugin and run it. For instructions, see Installing WSO2 Integration Studio.
- Create the ESB profile artifact using the WSO2 Integration Studio. For instructions, see WSO2 Integration Studio.
There are two ways to debug a developed mediation flow.
- Instant debugging using Micro Integrator ( a light version of ESB profile) packaged with WSO2 Integration Studio.
- Deploy artifacts to an external WSO2 EI server and debug
Above two approaches are discussed in detail below.
Instant debugging using Micro Integrator
- When project artifacts are ready, on the project panel select the project you want to debug and click on Run > Debug.
- It will ask to choose the artifacts those needs to be deployed to Embedded Micro EI server. Internally WSO2 Integration Studio will generate a CAR application with choosed artifacts and deploy.
- On the console of WSO2 Integration Sturdio, notice that Micro Integrator is started with artifacts deployed. HTTP traffic is listened on 8290 port.
- Add some breakpoints in the flow as below. You can mark a particular mediator as a breakpoint.
- Invoke the service using SOAP UI or some external client. As soon as a request comes to the proxy service fisrt brak point will hit.
Note that you can view the payload that comes into the mediator and the properties that you can access on the message context.
- Click on "Continue" button. Then the message will be sent to the backend by call mediator and next breakpoint, the log mediator will hit.
Note that response can be viewed on Message Envelope tab. The property set before calling the endpoint is also accessible in the context.
- Click on "Continue" button again. Response will be received by the client.
Debugging with external WSO2 EI server
Creating the artifact
- Deploy the artifact you created on the ESB profile. For instructions, see Packaging your Artifacts into Composite Applications.
Enabling mediation debugging
Follow the steps below to enable debugging with respect to mediation.
- Click Run in the top menu of the WSO2 Integration Studio, and then click Debug Configurations.
- Enter the details to create a new configuration as shown in the example below. You need to define two port numbers and a hostname to connect the ESB profile with WSO2 Integration Studio in the mediation debug mode. Note that you need to specify debug mode as Remote.
- Add the new configuration to debug menu as below. Then you can access the configuation easily.
- Execute the following commands to start WSO2 EI server in the debug mode by passing a system variable at start up:
- On Windows:
<EI_HOME>\bin\integrator.bat --run -Desb.debug=true
- On Linux/Solaris:
sh <EI_HOME>/bin/integrator.sh -Desb.debug=true
- On Windows:
Click downward arrow beside Debug in the WSO2 Integration Studio, and select the new profile above created when the Console indicates the following.
You have approximately a one-minute time span to connect WSO2 Integration Studio with the EI server for the execution of the above created debug configuration. Otherwise, the EI server will stop listening and start without connecting with the debugger tool.
In WSO2 Integration Studio, right-click and add breakpoints or skip points on the desired mediators to start debugging as shown in the example below.
You can add the following debugging options on the mediators using the right click context menu.
- Toggle Breakpoint: Adds a breakpoint to the selected mediator
- Toggle Skip Point: Adds a skip point to the selected mediator
- Resend EI Debug Points: If you re-start the the ESB profile, or if you re-deploy the proxy service after changing its Synapse configuration, you need to re-send the information on breakpoints to the WSO2 EI server. This re-sends all registered debugging points to the EI Server.
- Delete All EI Debug Points: Deletes all registered debug points from the EI Server and WSO2 Integration Studio.
Now you can send a request to the external WSO2 EI server and debug the flow as discussed under "Instant debugging using Micro Integrator".
Information provided by the Debugger Tool
When your target artifact gets a request message and when the mediation flow reaches a mediator marked as a breakpoint, the message mediation process suspends at that point. A tool tip message of the suspended mediator displays the message envelope of the message payload at that point as shown in the example below.
You can view the message payload at that point of the message flow also in the Message Envelope tab as shown below.
Also, you can view the message mediation properties in the Variables view as shown in the example below.
The Variable view contains properties of the following property scopes.
Axis2-Client Scope Properties
Axis2 Scope Properties
Operation Scope Properties
Synapse Scope Properties
Transport Scope Properties
You can have a list of selected properties out of the above, in the properties table of the Message Envelope tab, and view information on the property keys and values of them as shown below.
Click Add Property, specify the context and name of the property, and then click OK, to add that property to the properties table in the Message Envelope tab as shown below.
Click Clear Property, to remove a property from the properties table.
Changing the property values
There are three operations that you can perform on message mediation property values as described below.
Injecting new properties
Follow the steps below to inject new properties to the ESB profile while debugging.
- Right click on the Variable view, click Inject/Clear Property, and then click Inject Property as shown below.
- Enter the details about the property you prefer to add as shown in the example below.
- Click OK.
- When the next debug point is hit, you will see the property is set to the specified context.
Clearing a property
Follow the steps below to clear an existing property from the the ESB profile.
- Right click on the Variable view, click Inject/Clear Property, and then click Clear Property as shown below.
- Enter the details about the property you want to clear as shown in the example below.
- Click OK.
Modifying a property
- Click on the value section of the preferred property and change the value in the Variable view as shown in the example below, to modify it.
- You will see the property is changed on the property view.
Viewing wire logs
While debugging a Synapse flow, you can view the the actual HTTP messages at the entry point of the ESB profile via wire logs. For example, you can view wire logs of the incoming flow and the final response of a proxy service. Also, you can view wire logs for points, where it goes out from the ESB profile. For example, you can see the outgoing and incoming wire logs for specific mediators (i.e. Call mediator, Send mediator etc.). Wire logs are useful to troubleshoot unexpected issues, which occurr while integrating miscallaneous systems. You can use wire logs to verify whether the message payload is properly going out from the server, whether the HTTP headers such as the content-type is properly set in the outgoing message etc.
Enabling wire logs
The passthrough HTTP transport is the main transport, which handles HTTP/HTTPS messages in WSO2 EI.
- Un-comment the following log appender in the
<EI_HOME/conf/log4j2.propertiesfile to enable wire logs for the passthrough HTTP transport:
- Add your logger name into the section called “loggers” (synapse-transport-http-wire)
CommonsHTTPSenderto invoke services. It does not leverage the non-blocking NHTTP/passthrough transports. Therefore, you need to add the following entries to the log appender above to enable wire logs for the callout mediator.
Add your logger name into the section called “loggers” (httpclient-wire-header, httpclient-wire-content)
Following is a sample wirelog.
DEBUG - wire >>- This represents a message, which is coming into WSO2 EI from the wire
DEBUG - wire <<- This represents a message, which goes to the wire from WSO2 EI
Viewing wire logs of a specific mediator
You need to put a debug point to the mediator, to view wire logs of it. When debugging is finished (or while debugging), right click on the mediator, and click Show WireLogs, to view wire logs for a specific mediator.
You can only view wire logs for a whole proxy service, call mediator, send mediator, or other API resources. However, you cannot view a wire log of a Synapse config (e.g. sequences), because there would not be anything written to wire, when the flow comes to the sequence etc. Hence, you can only view them in wire entry points.
Viewing wire logs while debugging
If you view wire logs while debugging, you view only the wire logs of mediators, whose execution is already completed as shown in the example below.
Viewing wire logs of a mediator after debugging execution of it
When you view wire logs of a mediator (e.g. send mediator) after debugging, you can view the request and response wire logs as shown in the example below.
Viewing wire logs of a proxy service after debugging
If you view wire logs of a proxy service after debugging finished, you view the request wire log and final response wire log of that proxy as shown in the example below.