RailsアプリケーションにPiwikを統合

piwik_analyticsはRails 3.xにおけるRubyのGemです。サーバーにPiwikをインストールしてウェブサイトを作成した後、ウェブサイトに埋め込むJavaScriptのトラッキングタグを取得します。多くの場合Railsでは、トラッキングタグは application.html.erb ビューに埋めこまれます。ビューにトラッキングタグを含めるのはそんなに簡単ではありません。

piwik_analyticsのgemは、ビューテンプレートをめちゃくちゃにしなくても、アプリケーションにPiwikを含めるための簡単な方法を提供します。

インストール

Gemfileにpiwik_analytics のGemを追加します。:

gem 'piwik_analytics', '~> 1.0.1'

以下を実行することを忘れないでください。

bundle install

! 次にジェネレータを実行します。:

rails g piwik_analytics:install

これにより、アプリケーションの config ディレクトリにpiwik.yml設定ファイルをインストールします。

設定

config/piwik.yml を開いて、設定を編集します。各設定は、設定ファイル自体に記述されています。

# 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 Piwik
#
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

見て分かるように、Piwikのデフォルトでは本番モードで有効になっています。 disabled: falseと設定することにより、開発環境やテスト環境でPiwikを有効にすることもできます。次に、Piwikから追跡したいWebサイトのサイトIDを取得する必要があるでしょう。 Piwikのインストールにログインし、”設定”に移動して、 “Webサイト”タブをクリックします。

PiwikのサイトID

この場合、サイトIDは “1″です。最後のステップとして、PiwikのインストールのURLを設定する必要があります。 Piwikが http://example.com/piwik/ でホストされている場合は、 example.com/piwik （最後のスラッシュなし）にURLを設定する必要があります。

Piwikはバージョン1.1から非同期トラッキングスクリプトをサポートしています。アプリケーションで非同期トラッキングを使用したい場合には、単に use_async: trueと設定します。