This documentation is in progress and includes all updates released after Data Analytics Server 3.1.0. For documentation specific to a version, see About this Release.
WSO2 Data Analytics Server is succeeded by WSO2 Stream Processor. To view the latest documentation for WSO2 SP, see WSO2 Stream Processor Documentation.
WSO2 Data Analytics Server Documentation

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

WSO2 implements customized Analytics functionality in WSO2 products such as WSO2 ESB, WSO2 API Manager and WSO2 Identity Server. This functionality is available by default in the WSO2 Analytics products that are used in combination with these products (e.g., the Analytics functionality specific for WSO2 ESB is available by default in WSO2 ESB Analytics). In addition, this customised functionality can be installed as features in other Analytics products (i.e., in WSO2 DAS and any other WSO2 product based on it).

Click on the relevant tab for instructions to install and use the required Analytics features in the selected Analytics product.

ESB Analytics features allow you to monitor WSO2 ESB in the Analytics Dashboard by viewing statistics for all/selected ESB artifacts. For detailed information about using ESB Analytics to monitor WSO2 ESB using ESB Analytics, see WSO2 ESB Documentation - WSO2 ESB Analytics.

The ESB Analytics features can be installed and used as described below in the following WSO2 products.

  • WSO2 Data Analytics Server
  • WSO2 API Manager Analytics
  • WSO2 IS Analytics

Installing the features

Follow the procedure below to install the required feature for ESB Analytics.

  1. Log into the Management Console of your Analytics product. For detailed instructions to access the Management Console of a WSO2 product, see Running the Product .
  2. Add the latest P2 repository. The repository URL is given below.
    http://product-dist.wso2.com/p2/carbon/releases/wilkes/ 
    For detailed instructions to add a repository, see WSO2 Admin Guide - Managing the Feature Repository.
  3.  Install the feature named ESB Analytics. For detailed instructions to install a feature, see WSO2 Admin Guide - Installing Features.

Enabling mediation statistics

This section involves doing the required configurations to allow the WSO2 ESB server to publish statistics in the WSO2 Analytics server.

Open the  <ESB_HOME>/repository/conf/synapse.properties file and configure the required properties as described in the table below.

PropertyRequired ValuePurpose
mediation.flow.statistics.enabletrue

Setting this property to true results in the following information being recorded.

  • 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.payloadstrueSetting this property to true results in the message payload before and after the mediation performed by individual mediators being recorded.

mediation.flow.statistics.tracer.collect.properties

true

Setting this property to true results in the following information being recorded.

  • Message context properties.
  • Message transport-scope properties. 
mediation.flow.statistics.collect.alltrue/false

If this property is set to true, mediation statistics is enabled for all the artifacts in your WSO2 ESB server by default.

You can enable statistics for the ESB artifacts by setting this property only if the mediation.flow.statistics.enable property is also set to true.

If this property is set to false, statistics and/or tracing needs to be manually enabled for the required artifacts as explained under WSO2 ESB Documentation - Enabling Statistics for ESB artifacts.

For detailed information, see WSO2 ESB Documentation - Prerequisites to Publish Statistics.

Accessing the published statistics

Follow the steps below to access the ESB Analytics dashboard.

  1. Start WSO2 Analytics server, and then start the WSO2 ESB server. For detailed instructions to start a WSO2 product, see Running the Product.

    • WSO2 ESB is by default configured to publish statistics in a server of which the Thrift port is 7612. Therefore, you should check the default ports of your Analytics server and configure a port offset if required.  

      e.g., The default Thrift port of WSO2 DAS is 7611. Therefore, if you are installing ESB Analytics features in WSO2 DAS to Analyze ESB statistics, you should start the WSO2 DAS server with a port offset of 1. No port offset is needed if you are using WSO2 IS Analytics because the default Thrift port of this product is 7612.

      For more information, see WSO2 Admin Guide - Changing the Default Ports.
       

    • If you run your WSO2 Analytics product on a Carbon port other than 9444 (and as a result on a Thrift port different to 7612), you should change the receiver URL specified in the following files to match the current Thrift port.
      • <ESB_HOME>/repository/deployment/server/eventpublishers/MessageFlowConfigurationPublisher.xml
      • <ESB_HOME>/repository/deployment/server/eventpublishers/MessageFlowStatisticsPublisher.xml

      e.g., If you are running WSO2 Analytics on the Carbon port 9446, the Thrift port is 7614. Therefore, the receiver URL should be configured as follows in both the files mentioned above.

      <property name="receiverURL">tcp://localhost:7614</property>
  2. Access the ESB Analytics dashboard using the following URL.
    https://<ANALYTICS_HOST>:<ANALYTICS_PORT>/portal/dashboards/esb-analytics/ 

    For detailed information about analyzing the ESB using the gadgets in this dashboard, see WSO2 ESB Documentation - Analyzing WSO2 ESB with the Analytics Dashboard.

API Manager Analytics features allow you to monitor the WSO2 API Manager as follows.

The API Manager Analytics features can be installed and used as described below in the following WSO2 products.

  • WSO2 Data Analytics Server
  • WSO2 ESB Analytics
  • WSO2 IS Analytics

Installing the features

Follow the procedure below to install the required feature for API Manager Analytics.

  1. Log into the Management Console of your Analytics product. For detailed instructions to access the Management Console of a WSO2 product, see Running the Product .
  2. Add the latest P2 repository. The repository URL is given below.
    http://product-dist.wso2.com/p2/carbon/releases/wilkes/ 

    For detailed instructions to add a repository, see WSO2 Admin Guide - Managing the Feature Repository.
  3. Install the following features

    • Analytics Spark Geolocation UDF

    • Analytics Spark scripts Common
    • Analytics Spark Useragent UDF
    • APIM Analytics Server Core
    • APIM Analytics Server UDF

    If API Manager Analytics features are being installed in an Analytics product where IS Analytics features are also installed or to be installed, the version of the Analytics Spark Geolocation UDF feature selected should be 1.0.2.


    For detailed instructions to install APIM Analytics features, see WSO2 API Manager Documentation - Installing WSO2 APIM Analytics Features.

Enabling Analytics

This section involves doing the required configurations to allow the WSO2 API Manager server to publish statistics in the WSO2 Analytics server.

  1. Open the <APIM_HOME>/repository/conf/api-manager.xml file and set the Enabled property under Analytics to true as shown below. Then save this change.

    <Enabled>true</Enabled>

  2. If you want to enable the Log Analyzer, open the <APIM_HOME>/repository/conf/log4j.properties file and add the DAS_AGENT to the end of the root logger as shown below. Then save this change.

    log4j.rootLogger=<other loggers>, DAS_AGENT

For detailed information, see WSO2 API Manager Documentation - Configuring APIM Analytics.

Accessing the published statistics

Follow the steps below to access the WSO2 API Manager Portal, and the APIM Log Analyzer.

Accessing the APIM Portal

The APIM Portal allows you to configure alerts for WSO2 API Manager so that you can be notified when different statistics relating to your APIs reach specified limits. As a result, you can effectively manage your APIs.

  1. Start WSO2 DAS server, and then start the WSO2 APIM server. For detailed instructions to start a WSO2 product, see Running the Product.

    • WSO2 API Manager is by default configured to publish statistics in a server of which the Thrift port is 7612. Therefore, you should check the default ports of your Analytics server and configure a port offset if required.  

      e.g., The default Thrift port of WSO2 DAS is 7611. Therefore, if you are installing API Manager Analytics features in WSO2 DAS to Analyze APIM statistics, you should start the WSO2 DAS server with a port offset of 1. No port offset is needed if you are using WSO2 IS Analytics because the default Thrift port of this product is 7612.

      For more information, see WSO2 Admin Guide - Changing the Default Ports.

    • If you run your WSO2 Analytics product on a Carbon port other than 9444 (and as a result on a Thrift port different to 7612), you should change the receiver URL specified in the <APIM_HOME>/repository/conf/api-manager.xml file to match the current Thrift port.

      e.g., If you are running WSO2 Analytics on the Carbon port 9446, the Thrift port is 7614. Therefore, the receiver URL should be configured as follows in the <APIM_HOME>/repository/conf/api-manager.xml  file. 

      <DASServerURL>{tcp://localhost:7614}</DASServerURL>
  2. Log into the WSO2 API Manager Admin Portal using the https://localhost:<SERVER_PORT>/admin URL.
  3. Click Settings  to expand that section and then click Analytics. This opens the Alert Configurations page where all the supported alert types are displayed. For details information to configure different alerts, see WSO2 API Manager Documentation- Configuring Alerts.
Accessing the Log Analyzer

The Log Analyzer allows you analyze messages logged for WSO2 APIM.

  1. Start WSO2 DAS server, and then start the WSO2 APIM server. For detailed instructions to start a WSO2 product, see Running the Product.

  2. Access the WSO2 API Manager Admin Portal using the https://<Host_Name>:<Port_Name>/admin URL. Log into the portal using your credentials.
  3. In the left navigator, click Log Analyzer to expand the Log Analyzer section. Then click on the relevant pages to perform your analysis as required. For detailed information about each page, see WSO2 API Manager Documentation - Analyzing Logs with the Log Analyzer.

Identity Server Analytics features allow you to monitor the authentication operations performed by WSO2 IS using the Analytics Dashboard. For more information, See WSO2 IS Documentation - Analyzing Statistics for Authentication Operations.

The IS Analytics features can be installed and used as described below in the following WSO2 products.

  • WSO2 Data Analytics Server
  • WSO2 ESB Analytics
  • WSO2 API Manager Analytics

Installing the features

Follow the procedure below to install the required feature for IS Analytics.

  1. Log into the Management Console of your Analytics product. For detailed instructions to access the Management Console of a WSO2 product, see Running the Product .
  2. Add the latest P2 repository. The repository URL is given below.
    http://product-dist.wso2.com/p2/carbon/releases/wilkes/ 
    For detailed instructions to add a repository, see WSO2 Admin Guide - Managing the Feature Repository.
  3.  Install the feature named IS Analytics. For detailed instructions to install a feature, see WSO2 Admin Guide - Installing Features.
     

Enabling Analytics

This section involves doing the required configurations to allow the WSO2 IS server to publish statistics in the WSO2 Analytics server.

  1. Open the IS_HOME>/repository/conf/identity/Identity.xml file.

  2. Enable the org.wso2.carbon.identity.data.publisher.application.authentication.AuthnDataPublisherProxy listener as follows. This listener needs to be enabled in order to publish statistics relating to both logins and sessions.

    <EventListener type="org.wso2.carbon.identity.core.handler.AbstractIdentityMessageHandler"            name="org.wso2.carbon.identity.data.publisher.application.authentication.AuthnDataPublisherProxy"
            orderId="11" enable="true"/>

     

  3. Enable the org.wso2.carbon.identity.data.publisher.application.authentication.impl.DASLoginDataPublisherImpl listener as follows if you want statistics relating to logins published in the Analytics Dashboard.
     

    <EventListener type="org.wso2.carbon.identity.core.handler.AbstractIdentityMessageHandler"            name="org.wso2.carbon.identity.data.publisher.application.authentication.impl.DASLoginDataPublisherImpl"
            orderId="10" enable="true"/>

  4. Enable the org.wso2.carbon.identity.data.publisher.application.authentication.impl.DASSessionDataPublisherImpl listener as follows if you want statistics relating to sessions to be published in the Analytics Dashboard.
     

    <EventListener type="org.wso2.carbon.identity.core.handler.AbstractIdentityMessageHandler"            name="org.wso2.carbon.identity.data.publisher.application.authentication.impl.DASSessionDataPublisherImpl"
            orderId="11" enable="true"/>

For detailed information, see WSO2 IS Documentation - Prerequisites to Publish Statistics.

Accessing the published statistics

Follow the steps below to access the IS Analytics dashboard.

  1. Start WSO2 Analytics server, and then start the WSO2 IS server. For detailed instructions to start a WSO2 product, see Running the Product.

    • WSO2 IS is by default configured to publish statistics in a server of which the Thrift port is 7612. Therefore, you should check the default ports of your Analytics server and configure a port offset if required.  

      e.g., The default Thrift port of WSO2 DAS is 7611. Therefore, if you are installing IS Analytics features in WSO2 DAS to Analyze IS statistics, you should start the WSO2 DAS server with a port offset of 1. No port offset is needed if you are using WSO2 ESB Analytics because the default Thrift port of this product is 7612.

      For more information, see WSO2 Admin Guide - Changing the Default Ports.

    • If you run your WSO2 Analytics product on a Carbon port other than 9444 (and as a result on a Thrift port different to 7612), you should change the receiver URL specified in the following files to match the current Thrift port.
      • <IS_HOME>/repository/deployment/server/eventpublishers/IsAnalytics-Publisher-wso2event-AuthenticationData.xml 
      • <IS_HOME>/repository/deployment/server/eventpublishers/IsAnalytics-Publisher-wso2event-SessionData.xml


      e.g., If you are running WSO2 Analytics on the Carbon port 9446, the Thrift port is 7614. Therefore, the receiver URL should be configured as follows in both the files mentioned above.

      <property name="receiverURL">tcp://localhost:7614</property>
  2. Access the IS Analytics dashboard using the following URL.
    https://<ANALYTICS_HOST>:<ANALYTICS_PORT>/portal/dashboards/is-analytics/ 

    For detailed information about analyzing the IS using the gadgets in this dashboard, see WSO2 IS Documentation - Analyzing Statistics for Authentication Operations.
  • No labels
||