This documentation is for WSO2 Identity Server 5.2.0 . View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

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.

  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

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.
-DportOffset=1 

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 analytics for Identity Server

To enable publishing statistics for WSO2 Identity Server in WSO2 Analytics - IS,  the DASAuthnDataPublisherImpl property should be set to true in the <IS_HOME>/repository/conf/identity/Identity.xml file as shown below.

<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 Analytics - IS server in order to analyze the data using the Analytics Dashboard.

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. The following is a 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:7612</property>
    <property encrypted="false" name="password">admin</property>
  </to>
</eventPublisher>

The properties of this event publisher 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>

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:7612

Authenticator URL

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

ssl://<localhost>:<SSL_PORT>

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 7712 instead of 7711.


authenticatorURL

ssl://auth-host:7712

User NameThe username of the listener.
username

wso2event-user

PasswordA password for the listener.
password
wso2event-password
ProtocolThe communication protocol that is used to publish events.
protocol
thrift/binary
Publishing ModeThe events publishing mode. Non-blocking refers to asynchronous publishing, and blocking refers to synchronous publishing.
publishingMode
non-blocking/blocking
Publishing TimeoutA positive integer to denote the timeout for the non-blocking publishing mode.
publishTimeout
0
  • No labels