Publishing ESB Data to Analytics

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

Configuring the ESB to publish data to the Analytics profile

The following configurations in the ESB profile of WSO2 EI ensures that ESB data is published to the Analytics profile. The published data can then be analyzed via the Analytics dashboard. 

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. 

   Property	Required Value	Example
   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 URLS.	Single-node deployment: tcp://localhost:7612 HA Cluster: tcp://analytics-server-1:7612,tcp://analytics-server-2:7612
   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
   Username	The username to use when accessing the WSO2 EI Analytics server to publish configurations.	admin
   Password	The password to use when accessing the WSO2 EI Analytics server to publish configurations.	admin

   
   

   
   

3. Property	Description
   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. Open the synapse.properties file (stored in the <EI_HOME>/conf/ directory) and configure the following property.

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.

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.

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 Integration Studio or the management console for this purpose.

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

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