wso2/wso2am-analytics-dashboard repository overview

⁠About WSO2 Product Docker Images

WSO2 product Docker images available at DockerHub⁠ package General Availability (GA) versions of WSO2 products with no WSO2 Updates⁠.

For a production grade deployment of the desired WSO2 product-version, it is highly recommended to use the relevant Docker image which packages WSO2 Updates, available at WSO2 Private Docker Registry⁠.

⁠Supported tags and respective Dockerfile links

• 3.2.0, latest (Dockerfile)⁠

• 3.2.0-alpine (Dockerfile)⁠

• 3.2.0-centos (Dockerfile)⁠

• 3.1.0 (Dockerfile)⁠

• 3.1.0-alpine (Dockerfile)⁠

• 3.1.0-centos (Dockerfile)⁠

• 3.0.0 (Dockerfile)⁠

• 3.0.0-alpine (Dockerfile)⁠

• 3.0.0-centos (Dockerfile)⁠

• 2.6.0 (Dockerfile)⁠

• 2.6.0-alpine (Dockerfile)⁠

• 2.6.0-centos (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 API Manager 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 Dashboard profile of WSO2 API Manager Analytics

WSO2 API Manager integrates with API Manager Analytics to provide reports, statistics, and graphs on the APIs deployed in WSO2 API Manager. You can then configure alerts to monitor these APIs and detect unusual activity, manage locations via geolocation statistics and carry out a detailed analysis of the logs. WSO2 API Manager has an enhanced distribution of Analytics to cater to API Manager specific scenarios.

APIM Analytics consists of two components: Worker and Dashboard. The dashboard reads the statistics published by the worker and displays the statistics on the dashboard. The worker and dashboard are connected through the database.

⁠How to use this image.

⁠Start an Analytics Dashboard profile instance

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

$ docker run -it -p 9643:9643 --name dashboard wso2/wso2am-analytics-dashboard:3.2.0

Here, port 9643 has been mapped to the corresponding Docker host (host machine on top of which containers are spawned) port.

⁠Accessing the Dashboard portal

To access the dashboard portal, use the docker host IP and port 9643 as follows:

https://{DOCKER_HOST}:9643/analytics-dashboard

⁠Container shell access and viewing server logs

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

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

$ docker logs dashboard

• 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 dashboard bash

⁠Pass arguments during server startup

⁠Running in debug mode

To start a Docker container instance of the Dashboard profile in debug mode (assuming 5005 to be the remote debugging port), use the following command:

$ docker run -it -p 9643:9643 -p 5005:5005 --name another-dashboard wso2/wso2am-analytics-dashboard:3.2.0 -debug 5005

⁠How to update configurations

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

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

In Analytics Dashboard profile product distribution, deployment.yaml configuration file can be found at {DISTRIBUTION_HOME}/conf/dashboard. Copy the file to some suitable location of the host machine, referred to as {SOURCE_CONFIGS}/deployment.yaml and change the offset value under ports to 1.

• Grant read permission to other users for {SOURCE_CONFIGS}/deployment.yaml.

$ chmod o+r {SOURCE_CONFIGS}/deployment.yaml

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

$ docker run -p 9641:9641 --volume {SOURCE_CONFIGS}/deployment.yaml:{TARGET_CONFIGS}/deployment.yaml wso2/wso2am-analytics-dashboard:3.2.0

Here, {TARGET_CONFIGS} refers to /home/wso2carbon/wso2am-analytics-3.2.0/conf/dashboard folder of the container.

⁠Image Variants

Multiple product profile Docker images based on different base operating systems are available.

⁠wso2am-analytics-dashboard:{version}

Ubuntu 18.04 LTS based Docker image with AdoptOpenJDK 11 pre-installed has been used as the base Docker image⁠.

Analytics Dashboard profile of WSO2 API Manager Analytics has been installed on top of this Docker image.

⁠wso2am-analytics-dashboard:{version}-alpine

Alpine based Docker image with AdoptOpenJDK 11 pre-installed has been used as the base Docker image⁠.

Analytics Dashboard profile of WSO2 API Manager Analytics has been installed on top of this Docker image.

⁠wso2am-analytics-dashboard:{version}-centos

CentOS based Docker image with AdoptOpenJDK 11 pre-installed has been used as the base Docker image⁠.

Analytics Dashboard profile of WSO2 API Manager 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.