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.

...

  1. Open the carbon.xml file (stored in the <EI_HOME>/conf/ directory).
  2. Under <Analytics>, enter the relevant configurations as described in the table below. 

    PropertyRequired ValueExample
    ServerURL

    The URL to which the EI statistics are published as events. The format of this URL can be one of the following:

    • <protocol>://<hostname
    • <ip>:<port>

    When you deploy EI Analytics as an HA cluster, enter the URLS of the Analytics nodes as a list of comma-separated URLSURLs that are separated by vertical bars (|).

    AuthServerURL

    When the authentication of EI statistics published to EI Analytics is carried out in a separate server, set this parameter to specify the URL of that authentication server.

    The format of this URL can be one of the following:

    • <protocol>://<hostname
    • <ip>:<port>
    ssl://localhost:7712
    UsernameThe username to use when accessing the WSO2 EI Analytics server to publish configurations.admin
    PasswordThe password to use when accessing the WSO2 EI Analytics server to publish configurations.admin



  3. Open the synapse.properties file (stored in the <EI_HOME>/conf/ directory) and configure the following property.

    PropertyDescription
    mediation.flow.statistics.enable

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

    • The time spent on each mediator.
    • The time spent to process each message.
    • The fault count of a single message flow.

Configuring the ESB to publish data to Jaeger

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.

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

...

    • following property.

Enabling statistics/message tracing

...

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 of the analytics profile. Therefore, tracing should only be enabled in development environments.

Step 1: Enabling statistics/message tracing for the ESB server

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

...

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.

...

Follow the steps below to enable statistics and tracing for the REST API:

  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 the collection of mediation statistics for the REST API, select Enable Statistics (shown above).
  4. 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 of the analytics profile. Therefore, tracing should only be enabled in development environments.

To enable statistics and tracing for the endpoint artifacts, open the Form view of the endpoint artifact and set the Trace Enabled and Statistics Enabled values to 'True'. For example, see the QueryDoctorEP endpoint:
Image Added

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


Info
titleUsing the management console?

The following table specifies the path to the Enable Statistics link for each ESB artifact type that can be analyzed using the Analytics Dashboard using the management console.

EI Artifact TypePath
Proxy ServiceMain tab => Services => List => Deployed Services page => <Proxy_Service_Name>
REST APIMain tab => APIs => Deployed APIs page
SequenceMain tab => Sequences => Mediation Sequences page
EndpointMain tab => Endpoints => Manage Endpoints page
Inbound EndpointMain tab => Inbound Endpoints => Manage Inbound Endpoints page

...

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. 

...