This documentation is for WSO2 Identity Server 5.2.0 . View documentation for the latest release.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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. In your Web browser, go to <IS Analytics page link>
  2. Click the Download button in the upper right-hand corner of the page to download the latest version. 

...

  1. Go to the WSO2 IS product page.
  2. To download Analytics - IS, click Analytics

For detailed information about the supporting applications you need to install, see Installation Prerequisites.

Running WSO2 Analytics - Identity Server

...

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

 

...

Configuring IS Analytics

Setting up the DAS configuration involves providing the information required by WSO2 IS to publish data to the DAS Analytics - IS 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

The required information about the receiving port that serves as the target to which IS related information is sent as events are provided via a publisher configuration in the <IS_HOME>/repository/deployment/server/eventpublishers/AuthenticationDataPublisher.xml file. Below The following is the a sample configuration. Here, please make sure to point to the correct DAS Thrift port (If you are running DAS by offset 1 then DAS Thrift port is 7612).

Code Block
<?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:7612</property>
    <property encrypted="false" name="password">admin</property>
  </to>
</eventPublisher>

The above properties of this event publisher properties are described configuration are explained in the table below.

 

Adapter Property
Description
Configuration file property
Example
Receiver URL

The URL of the target receiver to which IS related information is sent as events. The format of the URL is as follows.

tcp://<localhost>:<THRIFT_PORT>

Info

The default port offsets done for WSO2 IS should be taken into consideration when specifying the thrift port. e.g., If the WSO2 IS server was started with a port offset of 1, the thrift port should be 7612 instead of 7611.


receiverURL

tcp://localhost:76127611

Authenticator URL

The URL of the authenticator. The format of the authenticator URL is as follows.

authenticatorURL

ssl://localhost:7712

User NameUsername for the listener

tcp://<localhost>:<SSL_PORT>

Info

The default port offsets done for WSO2 IS should be taken into consideration when specifying the SSL port. e.g., If the WSO2 IS server was started with a port offset of 1, the SSL port should be 7662 instead of 7661.


authenticatorURL

tcp://auth-host:7661

User NameThe username of the listener.
username

wso2event-user

PasswordPassword A password for the listener.
password
wso2event-password
ProtocolThe communication protocol that will be is used to publish events.
protocol
thrift/binary
Publishing ModeEvents The events publishing mode. Non-blocking refers to asynchronous publishing, and blocking refers to synchronous publishing.
publishingMode
non-blocking/blocking
Publishing TimeoutPositive A positive integer to denote the timeout for the non-blocking publishing mode.
publishTimeout
0