This is the latest release in the 6.x.x family. For EI 7.0.0, click here.

All docs This doc
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

The following configurations in the ESB profile of WSO2 EI ensures that ESB data is published to Jaeger. The published data can then be visualized via the Jaeger UI.

Configuring the ESB to connect with Jaeger

Open the synapse.properties file (stored in the <EI_HOME>/conf/ directory) and configure the properties given below.

PropertyDescription
opentracing.enable

Set this property to true and enable statistics for the required ESB artifact, to record information such as the following.

  • The time spent on each mediator.
  • The time spent to process each message.
jaeger.sampler.manager.host

Host of Jaeger Sampler Manager. Defaults to localhost.

jaeger.sampler.manager.port

Port of Jaeger Sampler Manager. Defaults to 5778.

jaeger.sender.agent.host

Host of Jaeger Sender Agent. Defaults to localhost.

jaeger.sender.agent.portPort of Jaeger Sender Agent. Defaults to 6831.
jaeger.reporter.log.spansSet this property to true, in order to log reporting of each span.
jaeger.reporter.max.queue.sizeMaximum queue size of Jaeger Reporter. Defaults to 100.
jaeger.reporter.flush.intervalFlush interval (milliseconds) of Jaeger Reporter. Defaults to 10000.

Enabling message tracing

Follow the instructions give below to enable statistics monitoring and message tracing. You can use message tracing to track a message (including the message payload) throughout a mediation flow.

Note that it is not recommended to enable tracing in production environments as it generates a large number of events that reduces the performance of the analytics profile. Therefore, tracing should only be enabled in development environments.

Step 1: Enabling message tracing for the ESB server

Open the synapse.properties file (stored in the <EI_HOME>/conf/ directory) and configure the properties given below.

PropertyDescription
mediation.flow.statistics.tracer.collect.payloads

Set this property to true and enable tracing for the required ESB artifact, to record the message payload before and after the mediation performed by individual mediators. Note that message tracing is not recommended for production environments.

mediation.flow.statistics.tracer.collect.properties

Set this property to true and enable tracing for the required ESB artifact, to record the following information.

  • Message context properties.
  • Message transport-scope properties. 

Note that message tracing is not recommended for production environments.

mediation.flow.statistics.collect.all

Set this property to true and set the mediation.flow.statistics.enable property also to true, to enable mediation statistics for all the artifacts in the ESB profile by default.

If you set this property to false, you need to set the mediation.flow.statistics.enable property to true and manually enable statistics for the required ESB artifact.

Step 2: Enabling message tracing for ESB artifacts

If you have enabled the mediation.flow.statistics.collect.all property in the synapse.properties file as explained in the previous section, you will be monitoring the statistics of all the ESB artifacts (proxy services, REST APIs, sequences, and endpoints)  by default. Alternatively, you have the option of enabling statistics for only the required artifacts. You can use WSO2 Integration Studio or the management console for this purpose.

In a clustered deployment, statistics should be enabled for the required artifacts in all the EI nodes if you have not enabled deployment synchronizing. If deployment synchronizing is enabled, you need to enable statistics for the required artifacts only in one node.

Follow the steps below to enable tracing for a REST API artifact:

  1. Open WSO2 Integration Studio and open the REST API artifact.
  2. Click the REST API icon (in the design view) to open the Properties tab for the REST API. 
  3. To enable mediation tracing for the REST API, select Enable Tracing (shown above).

    Note that it is not recommended to enable tracing in production environments as it generates a large number of events that reduces the performance. Therefore, tracing should only be enabled in development environments.

  4. To enable tracing for endpoint artifacts, open the Form view of the endpoint artifact and set the Trace Enabled values to 'True'. For example, see the endpoint artifact given below:

Similarly, you can enable tracing for all the required artifacts.

  • No labels