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

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 following listeners should be enabled in the <IS_HOME>/repository/conf/identity/Identity.xml file.

Listenerorg.wso2.carbon.identity.data.publisher.application.authentication.AuthnDataPublishHandlerManager
PurposeThis is the common event listener for all the types of Analytics supported for WSO2 IS. This listener captures all the statistics sent to WSO2 IS Analytics as events, and redirects them to the relevant listener based on their type. Therefore, this listener is required to enable both session analytics and login analytics.
Configuration
<EventListener type="org.wso2.carbon.identity.core.handler.AbstractIdentityMessageHandler"
name="org.wso2.carbon.identity.data.publisher.application.authentication.AuthnDataPublishHandlerManager"
orderId="11" enable="true"/>
Listenerorg.wso2.carbon.identity.data.publisher.application.authentication.impl.DASLoginDataPublisherImpl
PurposeThis listener should be enabled if you want to analyze statistics relating to logins attempted via WSO2 IS. For more information about this type of analytics, see Analyzing Statistics for Resident Identity Provider.
Configuration
<EventListener type="org.wso2.carbon.identity.core.handler.AbstractIdentityMessageHandler"
name="org.wso2.carbon.identity.data.publisher.application.authentication.impl.DASLoginDataPublisherImpl"
orderId="10" enable="true"/>

 

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

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.

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

    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>

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>

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.

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
  • No labels
{"cc_re__cc_re__cc_by_4_0": ["footer-logo\"><a href=\"http://www.atlassian.com/\" rel=\"nofollow\">Atlassian</a></div>\n\n                    <script type=\"text/javascript\">\r\n$(document).ready(function() {\r\n$(\".medium-field\").attr(\"placeholder\",\"Search this documentation\");\r\n$(\".search\").attr(\"placeholder\",\"Search all WSO2 documentation\");\r\n             });\r\n             </script>\r\n\r\n<script>jQuery('#footer').prepend('<div style=\"margin:20px; font-size:11px;\" align=\"right\">Copyright \u00a9 WSO2 LLC 2015-2022<br/>Content licensed under <a href=\"https://creativecommons.org/licenses/by/4.0/\">CC By 4.0</a>. Samples licensed under <a href=\"http://www.apache.org/licenses/LICENSE-2.0\">Apache 2.0</a>.</div>'); </script>\r\n\r\n<script  type=\"text/javascript\">\r\n\r\n\r\n\r\nwindow.ATL_JQ_PAGE_PROPS = $.extend(window.ATL_JQ_PAGE_PROPS, {\r\n\r\n        // ==== custom trigger function ====\r\n        triggerFunction : function( showCollectorDialog ) {\r\n            $('#atlwdg-trigger').on( 'click', function(e) {\r\n                e.preventDefault();\r\n                showCollectorDialog();\r\n            });\r\n  "], "copyright__copyright__copyright": ["of the listener.\nusername\n\nwso2event-user\n\nPasswordA password for the listener.\npassword\nwso2event-password\nProtocolThe communication protocol that is used to publish events.\nprotocol\nthrift/binary\nPublishing ModeThe events publishing mode. Non-blocking refers to asynchronous publishing, and blocking refers to synchronous publishing.\npublishingMode\nnon-blocking/blocking\nPublishing TimeoutA positive integer to denote the timeout for the non-blocking publishing mode.\npublishTimeout\n0\n  \u2022 No labels", "of the listener.\nusername\n\nwso2event-user\n\nPasswordA password for the listener.\npassword\nwso2event-password\nProtocolThe communication protocol that is used to publish events.\nprotocol\nthrift/binary\nPublishing ModeThe events publishing mode. Non-blocking refers to asynchronous publishing, and blocking refers to synchronous publishing.\npublishingMode\nnon-blocking/blocking\nPublishing TimeoutA positive integer to denote the timeout for the non-blocking publishing mode.\npublishTimeout\n0\n  \u2022 No labels", "of the listener.\nusername\n\nwso2event-user\n\nPasswordA password for the listener.\npassword\nwso2event-password\nProtocolThe communication protocol that is used to publish events.\nprotocol\nthrift/binary\nPublishing ModeThe events publishing mode. Non-blocking refers to asynchronous publishing, and blocking refers to synchronous publishing.\npublishingMode\nnon-blocking/blocking\nPublishing TimeoutA positive integer to denote the timeout for the non-blocking publishing mode.\npublishTimeout\n0\n  \u2022 No labels"]}