Lookout Ahoy

A full-featured, mountable analytics dashboard for your Rails app, powered by Ahoy.

Fork of Ahoy Captain with SQLite support added (PG already supported), and Rails 8 compatibility.

Lookout supports PostgreSQL and SQLite.

Drop it in:

$ bundle add lookout-ahoy

$ rails g lookout:install

In your host app’s config/importmap.rb, add a single line to pull in Lookout’s pins:

# your app’s pins…
pin "application"
pin "@hotwired/turbo-rails", to: "turbo.min.js"
pin "@hotwired/stimulus", to: "stimulus.min.js"
pin "@hotwired/stimulus-loading", to: "stimulus-loading.js"
pin_all_from "app/javascript/controllers", under: "controllers"

# Lookout Analytics
Lookout.importmap(self)

This avoids referencing Lookout::Engine.root from your app. For older importmap-rails, Lookout also inlines its own importmap via lookout_importmap_tags.

Lookout doesn't do any tracking for you; it merely provides a dashboard for your data from the Ahoy gem.

By default, Lookout assumes you're tracking controller and action in your Ahoy::Event properties, and a page view event is named $view. See this section for more information: https://github.com/ankane/ahoy#events

For a quick sanity check:

Lookout.event.where(name: Lookout.config.event[:view_name]).count
Lookout.event.with_routes.count

This can be fully-customized. See the initializer config/initializers/lookout.rb for more.

If you have a large dataset (> 1GB) you probably want some indexes. rails g lookout:migration

• Top sources
• Top pages, landing pages, and exit pages
• UTM reporting
• Top locations, by countries, regions, and cities
• Top devices, by browser, OS, and device type
• Goal tracking
• Funnels
• Filter by:
  • Page
  • Location
  • Device type
  • OS
  • UTM tags
  • Goal
  • Event Property
• CSV exports
• Date comparison

All are welcome to contribute.

The gem is available as open source under the terms of the MIT License.