Rack::UniversalAnalytics
Rack Middleware for injecting Google Analytics tracking code (either the new universal analytics version, or the legacy asynchronous version).
Usage
Gemfile
gem 'rack-universal-analytics'
Rails
## config/application.rb:
config.middleware.use Rack::UniversalAnalytics, :tracking_id => 'UA-xxxxxx-x'
Options
-
:tracking_id
(String, lambda) — The Google Analytics tracking ID for your account. If not set, this middleware is a no-op -
:property_url
(String, lambda) — Domain for GATC cookies. If not set and personality is set to :universal, this middleware is a no-op -
:personality
(Symbol, lambda) — analytics personality to use. One of :async, :universal, :none (default). When not set to :universal or :async, this rack middleware is a no-op -
:adjusted_bounce_rate_timeouts
(Array) — An array of times in seconds that the tracker will use to set timeouts for adjusted bounce rate tracking. See analytics.blogspot.ca/2012/07/tracking-adjusted-bounce-rate-in-google.html for details. ex: [15, 30, 45, 60] -
:site_speed_sample_rate
(Integer) — Defines a new sample set size for Site Speed data collection, see developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration?hl=de#gat.GA_Tracker._setSiteSpeedSampleRate
Without a tracking_id and personality set (and without a property_url set when personality is set to :universal
) this middleware acts as a no-op and passes
content through unchanged. This middleware should always be harmless when mounted in from of apps which fail to explicitly opt-in by setting these variables up correctly.
Event Tracking
In your application controller, you may track an event. For example:
track_analytics_event("Newsletter", "Signup")
Custom Variables
In your application controller, you may push arbritrary data. For example:
push_analytics_variable(1, "User", "John Doe")
Dynamic Options
You may instead define any of :tracking_id
, :personality
, or :property_url
to a lambda to dynamically vary them on a request-by-request basis
config.middleware.use Rack::UniversalAnalytics,
tracking_id: ->(env) {
return env[:site_ga].tracker if env[:site_ga]
},
property_url: ->(env) {
return Website.domain
},
personality: ->(env) {
case env[:foo]
when :bar then :async
when :baz then :universal
end
}
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Add tests. This is important! It helps me not break your feature unintentionally in the future!
- Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Copyright
Copyright (c) 2014 Matthew Barnett, Mike Deering, with portions courtesy Lee Hambley's [rack-google-analytics] (https://github.com/kangguru/rack-google-analytics)
See LICENSE for details.