The piwik_analytics gem provides an easy way to include Matomo (Piwik) into your application without messing up your view templates.
Add the piwik_analytics Gem to your Gemfile:
gem 'piwik_analytics', '~> 1.0.1'
Do not forget to run
! Then run the generator:
rails g piwik_analytics:install
This will install a piwik.yml configuration file into the config directory of your application.
Open up config/piwik.yml and edit the settings. Each setting is described in the config file itself.
# Configuration: # # disabled # false if tracking tag should be shown # use_async # Set to true if you want to use asynchronous tracking # url # The url of your piwik instance (e.g. localhost/piwik/ # id_site # The id of your website inside Matomo # production: piwik: id_site: 1 url: piwik-production.example.com use_async: false disabled: false development: piwik: id_site: 1 url: piwik-development.example.com disabled: true use_async: false test: piwik: id_site: 1 url: localhost disabled: true use_async: false
As you can see, by default Matomo (Piwik) is only enabled in production mode. You can of course enable Matomo in the development or test environment by setting disabled: false. You will then need to fetch the site ID of the website you want to track from Matomo. Login to your Matomo Installation, go to “Settings” and click the “Websites” tab.
In this case the site ID is “1”. As a last step you need to set the URL of your Matomo (Piwik) installation. If your Matomo is hosted under http://example.com/piwik/ you need to set the URL to example.com/piwik (without the trailing slash).
Matomo (Piwik) supports an asynchronous tracking script since version 1.1. In case you want to use asynchronous tracking in your application, simply set use_async: true.
The gem provides a simple helper that outputs the tracking tag. Inside your application.html.erb (or haml, slim) you can simply add the following snippet just before the closing body tag.
<%= piwik_tracking_tag %>
Make sure you have disabled: false when you test the gem.
Get Support for piwik_analytics
To get support or for further information: