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.

...

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.

Info

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

    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 7613 instead of 7611 7612.


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

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