This documentation is for WSO2 Enterprise Integrator version 6.4.0 . View documentation for the latest release in the 6.x.x family and the latest release in the 7.x.x family.

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 sections describe the prerequisites for publishing statistics from the ESB profile of WSO2 EI to the Analytics profile.

Enabling statistics/message tracing for the ESB profile

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.

  • The time spent on each mediator.
  • The time spent to process each message.
  • The fault count of a single message flow.
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.

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. 
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.

Enabling statistics/message tracing for ESB artifacts

Note that it is not recommended to enable tracing in production environments. Therefore, be sure that you only enable statistics in development environments.

You can select the specific proxy services, REST APIs, sequences and endpoints that you want to monitor via WSO2 EI Analytics by enabling statistics for them. To enable statistics for an individual artifact, you need to click the Enable Statistics link for it in the ESB profile's management console. See the following sections for detailed information on enabling statistics for the required artifact types.

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 synchronising 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.
     
  3. Click Enable Statistics and Enable Tracing links. Click OK in the information message that appears to confirm that statistics/tracing is enabled.
     
The following table specifies the path to the Enable Statistics link for each ESB artifact type that can be analyzed using the Analytics Dashboard.


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 EI Tooling 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.)

Configuring the ESB to publish data to the Analytics profile

The required configuration details described below are available by default. Follow this section to understand the Analytics related configurations used in the process, and do any modifications if required. In a clustered deployment, the following configurations should be checked for each Enterprise Integrator node in the cluster.

This step involves providing the information required by the ESB profile to publish data to WSO2 EI Analytics in order to analyze the data via the Analytics Dashboard. An event publisher is configured with the URL to which ESB-related information are published as events.

Follow the procedure below to configure EI Analytics.

  1. Open the <EI_HOME>/repository/deployment/server/eventpublishers/MessageFlowConfigurationPublisher.xml file, and enter relevant configurations as described in the table below. This file is used to enter the information required to publish ESB data to the WSO2 EI Analytics server.

    PropertyRequired ValueExample
    usernameThe username to be used when accessing the WSO2 EI Analytics server to publish configurations.admin
    passwordThe password to be used when accessing the WSO2 EI Analytics server to publish configurations.admin
    receiverURLThe URL of the thrift port to which the EI configurations should be published. The format of the URL is as follows.
    tcp://<localhost>:<THRIFT_PORT>
    tcp://localhost:7612
  2. Open the <EI_HOME>/repository/deployment/server/eventpublishers/MessageFlowStatisticsPublisher.xml file, and do the configurations and specified in the table below. 

    PropertyRequired ValueExample
    usernameThe username to be used when accessing the WSO2 EI Analytics server to publish statistics.admin
    passwordThe password to be used when accessing the WSO2 EI Analytics server to publish statistics.admin
    receiverURLThe URL of the thrift port to which the EI statistics should be published. The format of the URL is as follows.
    tcp://<localhost>:<THRIFT_PORT>
    tcp://localhost:7612
  • No labels