Prerequisites to Publish Statistics

This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Prerequisites to Publish Statistics

Following are the prerequisites that should be fulfilled, in order for the Analytics Dashboard to publish the data processed by WSO2 IS.


Step 01: Download WSO2 IS Analytics

You can either download and build the source code or download the WSO2 IS binary distribution.

The binary distribution contains the binary files for both MS Windows and Linux-based operating systems.

Follow the steps below to download WSO2 IS Analytics binary distribution. 

  1. Go to the WSO2 IS Analytics download page.

  2. Download the WSO2 IS Analytics pack.

    1. To download the pack with updates, click SIGN-IN & DOWNLOAD.  

    2. To download the pack without updates, click DOWNLOAD

Step 02: Enable Analytics in WSO2 IS

Follow the steps below to enable event publishing in WSO2 IS.

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

  2. Enable the following listeners. 

Step 03: Configure Event Publishers

In a fresh WSO2 IS pack, you can view all the event publishers related to WSO2 IS Analytics in the <IS_HOME>/repository/deployment/server/eventpublishers directory.

The required configurations described below are available by default. Thus, follow this section to understand the analytics-related configurations used in the process and do any modifications if required.

WSO2 Analytics presents the login and/or session data published by WSO2 IS. For this, you need to configure the event publishers.

Follow the steps below to configure the event publishers:

  1. Configure the login analytics and session analytics using the following files.

    1. Login analytics<IS_HOME>/repository/deployment/server/eventpublishers/IsAnalytics-Publisher-wso2event-AuthenticationData.xml

    2. Session analytics: <IS_HOME>/repository/deployment/server/eventpublishers/IsAnalytics-Publisher-wso2event-SessionData.xml 

      The common properties that can be configured for event publishers in the files mentioned above are as follows.  

Step 04: Change the Admin Password

Follow the steps below to change the admin password.

  1. Navigate to the <IS_HOME>/repository/deployment/server/eventpublishers/IsAnalytics-Publisher-wso2event-AuthenticationData.xml configuration file and update the admin password.

  2. If you created a new keystore for WSO2 IS Analytics, import the public certificate of that keystore to the client­-truststore.jks of the WSO2 IS using the following command. 

    keytool -import -alias <alias> -file <file_name> -keystore client-truststore.jks -storepass wso2carbon

Step 05: Run the Servers

Follow the steps below to run WSO2 IS and WSO2 IS Analytics.

  1. Run WSO2 IS. For detailed instructions, see Running the Product.

  2. Run the WSO2 IS Analytics profiles.

    1. Run the Worker node of WSO2 IS Analytics. For detailed instructions, see WSO2 SP - Starting Worker Node.

    2. Run the Dashboard node of WSO2 IS Analytics. For detailed instructions, see WSO2 SP - Starting a Dashboard Node