Fathom

Fathom Analytics provides very simple website stats without tracking or storing personal data. If you require more comprehensive analytics, a Google Analytics alternative, where data ownership and privacy compliance are still a concern check out Matomo Openshift.

fathom-openshift is a set of OpenShift configurations to set up an instance of the Fathom web analytics server. See: Fathom

Architecture

The service is composed by the following components:

• fathom: the main analytics service.
• fathom-db: a postgresql instance that will be used to store the analytics data.
• fathom-proxy: the nginx service used as reverse-proxy

Deployment / Configuration

The templates provided in the openshift folder include everything that is necessary to create the required builds and deployments.

To run Fathom on openshift you MUST install openshift-developer-tools and have them available on your path

By default, Fathom uses the Artifactory docker registry. If you are going to keep the default settings, Artifactory MUST be enabled in your OCP cluster, otherwise you will have to tweak the param file to specify your docker registry.

Running with Artifactory/docker.io:

Follow the instructions on artifactory to create an artifactory secret in each of the environments you will be building/deploying to. The initOSProjects.sh utility function in openshift-developer-tools can also be used to autmatically set-up the pull credentials and links them to the service accounts.

If you want to use your docker hub account, do the same command as for artifactory but use your docker.io login credentials.

Deploy:

Once the secret is created, use the manage script in the openshift folder to deploy your project

./manage -n 4a9599 init

This will generate local param files, make sure to go through each of the param files, uncomment NAMESPACE_NAME, and set it to your project namespace. In this case, 4a9599.

If you're using a custom docker registry you will also need to uncomment and change DOCKERREG and PULLCREDS in fathom-proxy-build.local.param and SOURCEIMAGENAME in fathom-build.local.param

Next we can build and deploy

./manage build ./manage -e dev deploy

First Run

Once everything is up and running in OpenShift, follow the instructions and create your admin user to secure the analytics dashboard.

To start tracking, create a site in your Fathom dashboard and copy the tracking snippet to the website(s) you want to track.

Filtering traffic from localhost and dev/test instances

Fathom does not yet support defining filters to exclude traffic based on URL/referrer. To separate traffic coming from different environments it is necessary to use a different tracking ID for each instance.

it is possible to achieve this by:

1. importing a "generic" script to the app/pages you will want to track, like <script type="text/javascript" src="/fathom.js"></script>
2. configuring your webserver to serve, if available, a static file containing the tracking code when receiving requests to /fathom.js. For nginx the configuration to add looks like this:

# serve the fathom analytics tracking code, if available
location =/fathom.js {
    root /tmp;
    gzip            on;
    gzip_min_length 1000;
    gzip_types      *;
}