Prerequisites to Publish Statistics

The following sections cover the prerequisites that should be completed in order to publish information relating to the processing carried out by WSO2 Identity Server (WSO2 IS) in the Analytics Dashboard of WSO2 Analytics - IS.

Downloading WSO2 IS Analytics

Follow the instructions below to download the binary distribution of WSO2 IS Analytics.

The binary distribution contains the binary files for both MS Windows, and Linux-based operating systems. You can also download and build the source code.

1. Go to the WSO2 Identity Server previous releases page.
2. Select Version 5.6.0.

3. Enter your email address and click Download as shown below:

   

   The installation prerequisites for IS - Analytics is the same as that for WSO2 Data Analytics Server. Therefore, for detailed information about the supporting applications you need to install, see Installation Prerequisites in WSO2 DAS documentation.

Running WSO2 Analytics - Identity Server

Once WSO2 Analytics - IS is downloaded, you can start its server and access its Management Console.

Running WSO2 Identity Server

The WSO2 Identity Server should run simultaneously with the WSO2 Analytics - IS server. For detailed instructions to run a WSO2 product, see Running the Product.

Enabling analytics for Identity Server

To enable publishing statistics for WSO2 Identity Server in WSO2 Analytics - IS, the following listeners should be enabled in the <IS_HOME>/repository/conf/identity/identity.xml file.

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

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

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

Configuring event publishers

Configuring event publishers involve providing the information required by WSO2 IS to publish login and/or session data  to the Analytics - IS server in order to analyze the data using the Analytics Dashboard. This configuration is the same for login analytics and session analytics. The differences are as follows.

• The configuration required for login analytics is located in the <IS_HOME>/repository/deployment/server/eventpublishers/IsAnalytics-Publisher-wso2event-AuthenticationData.xml file. The configuration required for session analytics is located in the <IS_HOME>/repository/deployment/server/eventpublishers/IsAnalytics-Publisher-wso2event-SessionData.xml file.

• The event streams used for login analytics and session analytics are different because the format in which the events are captured for the two types of analytics are different. For detailed information about event streams, see Understanding Event Streams and Event Tables.
  

  The event streams specified for publishers should not be modified because that would cause errors in the existing default configuration.

   

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

receiverURL

<property name="receiverURL">tcp://al.km.wso2.com:7614, tcp://al.km.wso2.com:7615</property>

authenticatorURL

username

password

protocol

publishingMode

publishTimeout

Viewing event publishers and changing the admin password

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

The following is a sample of this configuration file named IsAnalytics-Publisher-wso2event-AuthenticationData.xml.

<?xml version="1.0" encoding="UTF-8"?>
<eventPublisher
name="IsAnalytics-Publisher-wso2event-AuthenticationData"
statistics="disable" trace="disable" xmlns="http://wso2.org/carbon/eventpublisher">
	<from streamName="org.wso2.is.analytics.stream.OverallAuthentication" version="1.0.0"/>
	<mapping customMapping="disable" type="wso2event"/>
	<to eventAdapterType="wso2event">
		<property name="username">admin</property>
		<property name="protocol">thrift</property>
		<property name="publishingMode">non-blocking</property>
		<property name="publishTimeout">0</property>
		<property name="receiverURL">tcp://localhost:7612</property>
		<property encrypted="true" name="password">kuv2MubUUveMyv6GeHrXr9il59ajJIqUI4eoYHcgGKf/BBFOWn96NTjJQI+wYbWjKW6r79S7L7ZzgYeWx7DlGbff5X3pBN2Gh9yV0BHP1E93QtFqR7uTWi141Tr7V7ZwScwNqJbiNoV+vyLbsqKJE7T3nP8Ih9Y6omygbcLcHzg</property>
	</to>
</eventPublisher>

In the above sample there is an encrypted password. However, in a fresh IS pack you can see a plain text password as shown below.

<property encrypted="false" name="password">admin</property>

Once you restart the pack it will get automatically encrypted. So if you want to change the admin password you need to include the new password as plain text in IS event publishers as shown below.

<property encrypted="false" name="password">new password</property>

Sharing the governance registry and user store

In order to log into the Analytics Dashboard with the credentials of a specific tenant (other than the super tenant) and view security statistics specific for that tenant, you need to share the governance registry and the user store. For detailed information about registry sharing strategies, see the library article Sharing Registry Space across Multiple Product Instances.

Configuring IS Analytics with a hostname

If you configure IS Analytics with a hostname, the relevant hostname (e.g., node2.analytics.com) should be added in the IS-Analytics_Home/repository/deployment/server/jaggeryapps/portal/configs/designer.json file as shown below for the IS Analytics dashboards to function. 

{
    ........
    },

    "host": {
        "hostname": "node2.analytics.com",
        "port": "",
        "protocol": ""
    }
}

For complete instructions to change the default hostname of IS Analytics, see WSO2 DAS Documentation - Changing the Hostname.

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