Skip to content

Setting up the EI Analytics Profile for Observability

Follow the instructions given below to enable observability for your Micro Integrator deployment using the Analytics profile of WSO2 EI 6.6.0.

EI-Analytics Observability

The Analytics profile consists of two components: Worker and Dashboard. The worker is the server that processes the data streams that are sent from the Micro Integrator and publishes the statistics to a database. The dashboard reads the statistics published by the worker and displays the statistics. The worker and dashboard are connected through the database.

This solution is more suitable if you already have an observability stack such as ELK, or if you want more business analytics and less operational observability. To select the most appropriate observability solution for your deployment, see Observability Deployment Strategy.

System requirements

You will be running three servers (analytics worker, analytics dashboard, and the Micro Integrator) for this solution. Be sure that you have the required system specifications to run each server.

  • For the Analytics Worker:

    Memory

    • ~ 2 GB per worker node (and therefore, 4 GB for the recommended Minimum HA cluster
    • 2 CPU cores minimum. It is recommended to allocate 4 cores.
    • ~ 2 GB is the initial heap (-Xms) required for the server startup. The maximum heap size is 4 GB (-Xmx)

    Disk

  • ~ 480 MB, excluding space allocated for log files and databases.
  • For the Analytics Dashboard:

    Memory

    • ~ 2 GB minimum, 4 GB Maximum
    • 2 CPU cores minimum. It is recommended to allocate 4 cores.
    • ~ 512 MB heap size. This is generally sufficient to process typical SOAP messages but the requirements vary with larger message sizes and the number of messages processed concurrently.

    Disk

  • ~ 480 MB, excluding space allocated for log files and databases.
  • For the Micro Integrator, see the installation prerequsites.

Download the servers

Configuring the Micro Integrator

Configure SSL certificates

Warning

Be sure to configure this step before starting the Micro Integrator.

To allow the Micro Integrator server and the Analytics server to communicate using SSL, the digital certificates should be shared by the two servers. See the instructions on adding SSL certificates to keystores.

For testing, you can simply copy the keystore files from the <EI_6.x.x_HOME>/wso2/analytics/resources/security directory to the MI_HOME/resources/security directory.

Enabling statistics monitoring

To enable statistics monitoring for the Micro Integrator, add the following parameters in the deployment.toml file of your Micro Integrator. This file is stored in the MI_HOME/conf.

[mediation]
flow.statistics.enable=true
stat.tracer.collect_payloads=true
stat.tracer.collect_mediation_properties=true

Enabling statistics for ALL artifacts

If you want to collect statistics for all your integration artifacts, be sure to add the following parameter to the deployment.toml file in addition the parameters explained above:

[mediation]
flow.statistics.capture_all=true

Alternatively, you can enable statistics for selected artifacts as explained below.

Enabling statistics for specific artifacts

Let's use the integration artifacts from the service chaining tutorial.

Warning

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.

If you did not try the service chaining tutorial yet:

  1. Download the pre-packaged project for the service chaining use case.
  2. Open WSO2 Integration Studio and import the pre-packaged project.

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

  1. Select HealthcareAPI in the canvas of WSO2 Integration Studio to open the Properties tab.
  2. Select Statistics Enabled and (if required) Trace Enabled as shown below. rest api properties

Follow the steps below to enable statistics for the endpoint artifacts:

  1. Select the required endpoint artifacts from the project explorer.
  2. Select Statistics Enabled and (if required) Trace Enabled as shown below. endpoint properties

What's Next?

If you have successfully set up your anlaytics deployment, see the instructions on using the Analytics dashboard.

Top