Page History
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 (WSO2 IS) in the Analytics Dashboard 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.
- Go to the WSO2 IS product page.To download Analytics - IS, click AnalyticsIdentity Server previous releases page.
- Select Version 5.2.0.
Enter your email address and click Download as shown below:
Installing WSO2 IS Analytics
Take the following steps to install WSO2 IS Analytics. Because this procedure is identical to installing WSO2 Data Analytics Server (DAS), these steps take you to the DAS documentation for details.
Ensure that you have met the installation prerequisites.
Info The installation prerequisites for IS - Analytics is the same as that for of WSO2 Data Analytics Server. Therefore, for detailed information about the supporting applications you need to install, see Installation Prerequisites in WSO2 DAS documentation.
- . Go to the installation instructions relevant to your operating system:
Running WSO2 Analytics - Identity Server
...
For detailed instructions to run a WSO2 product, see Running the Product.If you want to run
For detailed instructions to run WSO2 IS Analytics in a clustered setup, see WSO2 Products Clustering and Deployment Guide - Clustering Data Analytics Server.
Running WSO2 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/Identityidentity.xml
file.
Listener | org.wso2.carbon.identity.data.publisher.application.authentication.AuthnDataPublisherProxy | |||||
---|---|---|---|---|---|---|
Purpose | This 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 |
|
Listener | org.wso2.carbon.identity.data.publisher.application.authentication.impl.DASLoginDataPublisherImpl |
---|---|
Purpose | This 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 the following sections. |
Configuration |
|
---|
Listener | org.wso2.carbon.identity.data.publisher.application.authentication.impl.DASSessionDataPublisherImpl | |||||
---|---|---|---|---|---|---|
Purpose | This 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 |
|
Configuring event publishers
...
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.
|
| receiverURL |
| ||
Authenticator URL | The URL of the authenticator. The format of the authenticator URL is as follows.
|
| authenticatorURL |
| ||||
User Name | The username of the listener.
| username | wso2event-user | |||
Password | A password for the listener. | password | wso2event-password | |||
Protocol | The communication protocol that is used to publish events. | protocol | thrift/binary | |||
Publishing Mode | The events publishing mode. Non-blocking refers to asynchronous publishing, and blocking refers to synchronous publishing. | publishingMode | non-blocking/blocking | |||
Publishing Timeout | A positive integer to denote the timeout for the non-blocking publishing mode. | publishTimeout | 0 |
Sharing the governance registry and user store
In order to log into the Analytics Dashboard with the credentials of a specific tenant (other than the super tenant) and view security statistics specific for that tenant, you need to share the governance registry and the user store. For detailed information about registry sharing strategies, see the library article Sharing Registry Space across Multiple Product Instances.
Configuring IS Analytics with a hostname
If you configure IS Analytics with a hostname, the relevant hostname (e.g., node2.analytics.com
) should be added in the IS-Analytics_Home/repository/deployment/server/jaggeryapps/portal/configs/designer.json
file as shown below for the IS Analytics dashboards to function.
Code Block | ||
---|---|---|
| ||
{
……..
},
"host": {
"hostname": "node2.analytics.com",
"port": "",
"protocol": ""
}
} |
For complete instructions to change the default hostname of IS Analytics, see WSO2 DAS Documentation - Changing the Hostname.