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

All docs This doc

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

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.

Info

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
Anchor
Artifacts
Artifacts

...

Info

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.

For example, you can enable statistics for a proxy service as described below.

  1. Start the ESB profile and log into the management console.
  2. In the Main tab, look for the Services section and click List  under the same section to open the Deployed Services page. Then click on the required proxy service as shown below.
    Image Removed 
  3. Click Enable Statistics and Enable Tracing links. Note that message tracing is not recommended for production environments. 
    Click OK in the information message that appears to confirm that statistics/tracing is enabled.
    Image Removed 

...

If you have worker nodes configured in your deployment, use WSO2 Integration Studio to enable message tracing/statistics as follows. You need to set the value of the Trace Enabled and Statistics Enabled options to true in the Properties tab of the artifact. Note that message tracing is not recommended for production environments. 

...

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. 
    Image Added
  3. To enable mediation tracing for the REST API, select Enable Tracing (shown above).

    Note

    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:
    Image Added

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