wso2/wso2is-analytics repository overview

⁠Supported tags and respective Dockerfile links

• 5.6.0 (Dockerfile)⁠

⁠Quick reference

• Where to get help:
  Docker Community Forums⁠, Docker Community Slack⁠, Stack Overflow⁠ or mail to WSO2 Developer mailing list⁠

• Where to file issues:
  Product specific issues at WSO2 Identity Server Analytics product repository⁠ and Docker resource usage issues at product Docker resource repository⁠

• Maintained by:
  WSO2 Inc.⁠

• Supported Docker versions:
  Docker v17.09.0 or above

⁠About WSO2 Identity Server Analytics

WSO2 Identity Server Analytics allows you to view and analyze statistics related to authentication requests that go through WSO2 Identity Server. You can configure WSO2 Identity Server to publish authentication related events to WSO2 Identity Server Analytics so that you view and analyze login analytics and session analytics.

⁠How to use this image.

⁠Start an Identity Server Analytics profile instance

The following command starts a Linux Ubuntu-based Identity Server Analytics profile Docker image.

$ docker run -it -p 9444:9444 --name analytics wso2/wso2is-analytics:5.6.0

Here, only port 9444 has been mapped to the corresponding Docker host (host machine on top of which containers are spawned) port. You may map other container service ports to Docker host ports as desired.

⁠Accessing management console

• To access the Identity Server Analytics Dashboard, use the Docker host IP and port 9444 as follows:

https://{DOCKER_HOST}:9444/portal/dashboards/IsAnalytics-AuthenticationData/

• To access the management console, use the Docker host IP and port 9444 as follows:

https://{DOCKER_HOST}:9444/carbon

⁠Container shell access and viewing server logs

Assuming you have started a Docker container instance of Analytics profile as instructed in the previous section Start an Identity Server Analytics profile instance,

• The Analytics server log is available through Docker's container log:

$ docker logs analytics

• The Docker exec command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside the container you created:

$ docker exec -it analytics bash

⁠How to update configurations

Configurations would lie on the Docker host machine and they can be volume mounted to the container. As an example, the steps required to change the port offset using carbon.xml is as follows:

• Stop the Analytics profile container if it's already running.

In the Analytics profile product distribution, carbon.xml configuration file can be found at {DISTRIBUTION_HOME}/conf. Copy the file to a suitable location of the host machine, referred to as {SOURCE_CONFIGS}/carbon.xml and increase the offset value under ports by 1.

• Grant read permission to other users for {SOURCE_CONFIGS}/carbon.xml.

$ chmod o+r {SOURCE_CONFIGS}/carbon.xml

• Run the image by mounting the file to the container as follows:

$ docker run -p 9445:9445 --volume {SOURCE_CONFIGS}/carbon.xml:{TARGET_CONFIGS}/carbon.xml wso2/wso2is-analytics:5.6.0

Here, {TARGET_CONFIGS} refers to /home/wso2carbon/wso2is-analytics-5.6.0/repository/conf folder of the container.

⁠Image Variants

⁠wso2is-analytics:{version}

Ubuntu 18.04 LTS based Docker image with Oracle JDK 8⁠ installed. WSO2 Identity Server Analytics has been installed on top of this Docker image.

⁠License

View license information⁠ for the software contained in this image.

As with all Docker images, these are likely to contain other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.