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 in the Analytics Dashboard of WSO2 Analytics - IS.
Downloading WSO2 Analytics - Identity Server
Follow the instructions below to download the binary distribution of WSO2 Analytics - IS.
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.
- In your Web browser, go to <IS Analytics page link>
- Click the Download button in the upper right-hand corner of the page to download the latest version.
Next, go to Installation Prerequisites in WSO2 DAS Documentation for instructions on installing the necessary supporting applications.
Running WSO2 Analytics - Identity Server
Once WSO2 Analytics - IS is downloaded, you can start its server and access its Management Console. For detailed instructions to run a WSO2 product, see Running the Product.
The WSO2 Analytics - IS server and the WSO2 IS server are required to run simultaneously. Therefore it is required to start one of the servers with a default port offset using the following property.
Running WSO2 Identity Server
The WSO2 IS server should run simultaneously with the WSO2 Analytics - IS server. For detailed instructions to run a WSO2 product, see Running the Product.
Open the Management Consoles of the two WSO2 products in two separate browsers to avoid signing off from one Management Console when you sign into the other.
Enabling and disabling Analytics for Identity Server
In WSO2 Identity Server, analytics is enabled by default.. <Incorporate a config for this>
Setting up the DAS configuration
Setting up the DAS configuration involves providing the information required by WSO2 IS to publish data to the DAS server in order to analyze the data using the Analytics Dashboard. Follow the procedure below to set up the DAS configuration.
In WSO2 IS, there is a Data publisher configuration which provides necessary details about the destination/target DAS Server. It is located at <IS_HOME>/repository/deployment/server/eventpublishers/AuthenticationDataPublisher.xml . Below is the sample configuration.
<?xml version="1.0" encoding="UTF-8"?> <eventPublisher name="AuthenticationDataPublisher" statistics="disable" trace="disable" xmlns="http://wso2.org/carbon/eventpublisher"> <from streamName="authentication-analytics-stream" 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:7611</property> <property encrypted="false" name="password">admin</property> </to> </eventPublisher>
The above event publisher properties are described below.
Configuration file property
|Receiver URL||URL of the target receiver|
|Authenticator URL||URL of the authenticator|
|User Name||Username for the listener|
|Password||Password for the listener|
|Protocol||The communication protocol that will be used to publish events|
|Publishing Mode||Events publishing mode. Non-blocking refers to asynchronous publishing, and blocking refers to synchronous publishing|
|Publishing Timeout||Positive integer to denote the timeout for the non-blocking publishing mode|