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.

...

Listenerorg.wso2.carbon.identity.data.publisher.application.authentication.AuthnDataPublishHandlerManager
PurposeThis listener should be enabled if you want to analyze statistics for specific sessions in WSO2 IS Analytics. A session is a time duration between a successful login and and the subsequent log out by a specific user. For more informations about this type of Analytics, see Analyzing Statistics for Sessions.
Configuration
Code Block
languagexml
<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

Info

The required configuration details described below are available by default. Follow this section to understand the Analytics related configurations used in the process and do any modifications if required.

Setting up the DAS configuration involves 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

...

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 properties of this event publisher configuration are explained in the table below.

...

  • 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.

    Note

    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.

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 Analytics - IS server should be taken into consideration when specifying the thrift port. e.g., If the WSO2 Analytics - 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>

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

Info

This parameter is not included in the AuthenticationDataPublisher.xml file by default. When it is not included, the authenticator URL is derived by adding 100 to the thrift port.


authenticatorURL

ssl://localhost: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