This documentation is for WSO2 Enterprise Integrator version 6.4.0 . View documentation for the latest release.
Publishing ESB Data to the Analytics Profile - WSO2 Enterprise Integrator 6.4.0 - WSO2 Documentation

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

The following sections describe the prerequisites for publishing statistics from the ESB profile of WSO2 EI to the Analytics profile.

Enabling statistics/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 statistics/message tracing for the ESB profile

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

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. 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 statistics/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 EI Tooling 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 synchronising is enabled, you need to enable statistics for the required artifacts only in one node.

Using WSO2 EI Tooling

Follow the steps given below.

  1. Go to WSO2 EI Tooling, and select the Properties tab of the required artifact. 
  2. Set the value of the Trace Enabled and Statistics Enabled options to true as shown below. Note that message tracing is not recommended for production environments. 

Using the management console

Follow the steps given below.

  1. Start the ESB profile of WSO2 EI and log in to the management console.
  2. 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.


    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

    See the following examples:

    To enable statistics for a REST API:

    1. On the Main tab of the management console, go to Manage -> Service Bus and click APIs. The Deployed APIs screen appears with the list of deployed APIs:
      Enable statistics for the REST API
    2. To enable the collection of mediation statistics for the REST API, click Enable Statistics.
    3. To enable mediation tracing for the REST API, click Enable Tracing. Note that message tracing is not recommended for production environments. 

    To enable statistics for Endpoints:

    1. On the Main tab of the management console, go to Manage -> Service Bus, and click Endpoints. The Manage Endpoints screen appears with the list of endpoints.
      Enable statistics for the endpoint artifacts
    2. To enable the collection of mediation statistics for the endpoints, click Enable Statistics for each endpoint.

    To enable statistics for a proxy service:

    1. In the Main tab, look for the Services section and click List under the same section to open the Deployed Services page. Then, click the required proxy service as shown below.
       

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

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