Government of British ColumbiaGovernment of British Columbia

DevHub

beta

Topic

Community Contributed Content

Helpful resources shared by the community

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.

Since there are interdependencies between deployment configurations, please make sure to follow this order when creating them for the first time:

  1. build and deploy the database
  2. build and deploy the Fathom analytics server
  3. build and deploy the proxy

The scripts in openshift-developer-tools can be used to manage the builds and deployments.

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      *;
    }
  • Create an Issue

Community Contributed Content
Content