https://github.com/ksylvest/analytic
https://github.com/ksylvest/analytic
analytics ruby
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/ksylvest/analytic
- Owner: ksylvest
- License: mit
- Created: 2024-08-04T15:49:16.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-11T21:06:46.000Z (over 1 year ago)
- Last Synced: 2025-01-10T23:51:05.997Z (over 1 year ago)
- Topics: analytics, ruby
- Language: Ruby
- Homepage: https://analytic.ksylvest.com/
- Size: 399 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Analytic
[](https://github.com/ksylvest/analytic/blob/main/LICENSE)
[](https://rubygems.org/gems/analytic)
[](https://github.com/ksylvest/analytic)
[](https://analytic.ksylvest.com)
[](https://circleci.com/gh/ksylvest/analytic)
[](https://codeclimate.com/github/ksylvest/analytic/maintainability)
[](https://codeclimate.com/github/ksylvest/analytic/test_coverage)
Analytic provides visitor / session / view tracking without the need for any third-party service.
## Installation
```bash
$ bundle add analytic
$ bin/rails analytic:install:migrations
$ bin/rails db:migrate
```
```ruby
# config/routes.rb
Rails.application.routes.draw do
mount Analytic::Engine, at: '/analytic'
end
```
## Usage
Default inline tracking is configured with:
```ruby
class ApplicationController
include Analytic::Trackable
before_action :analytic_track!, if: -> { request.format.html? }
end
```
Alternative job tracking is configured with:
```ruby
class ApplicationController
include Analytic::Trackable
before_action :analytic_enqueue_track_job!, if: -> { request.format.html? }
end
```
_note: a queue such as sidekiq, rescue, etc must be running to see tracking_
## Configuration
### Authentication the Dashboard
By default **Analytic** is not authenticated. To authenticate using `Rack::Auth` generate a random username and password:
```ruby
$ bin/rails secret # generate a secret
$ bin/rails credentials:edit
```
```yaml
analytic:
username: abc...
password: def...
```
```ruby
# config/initializers/analytic.rb
def same?(src, dst)
# https://api.rubyonrails.org/classes/ActiveSupport/SecurityUtils.html
ActiveSupport::SecurityUtils.secure_compare(src, dst)
end
Analytic.configure do |config|
unless Rails.env.local?
config.use Rack::Auth::Basic do |username, password|
credentials = Rails.application.credentials.analytic
same?(username, credentials.username) && same?(password, credentials.password)
end
end
end
```
### Capturing Extra Parameters
By default **Analytic** tracks `utm_source`, `utm_medium`, `utm_campaign`, `utm_content`, `utm_term`, `ref` and `source` parameters for each request. This list can be customized using:
```ruby
# config/initializer/analytic.rb
Analytic.configure do |config|
config.params << :gclid # e.g. Google
config.params << :msclkid # e.g. Bing
end
```
### Changing the Time Zone
By default **Analytic** uses `Time.zone`. The time zone can be changed using:
```ruby
# config/application.rb
class Application < Rails::Application
config.time_zone = 'Canada/Pacific'
end
```
The time zone may also be specified for **Analytic** using any `ActiveSupport::TimeZone`:
```ruby
# config/initializer/analytic.rb
Analytic.configure do |config|
config.time_zone = Time.find_zone('Canada/Pacific')
end
```
### Changing the Database
By default **Analytic** uses your apps main database. The database can be changed using:
```ruby
# config/initializer/analytic.rb
Analytic.configure do |config|
config.connects_to = { database: { writing: :primary, reading: :replica } }
end
```
### Overriding IP Masking Rules
By default IP addresses are masked as follows:
- IPv4: limit to leading 24-bits (e.g. '255.255.255.255' becomes '255.255.255.0')
- IPv6: limit to leading 48-bits (e.g. 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff' becomes 'ffff:ffff:ffff:0000:0000:0000:0000:0000')
To override both an `ip_v4_mask` and `ip_v6_mask` are assignable:
```ruby
Analytic.configure do |config|
config.ip_v4_mask = 24 # nil skips masking
config.ip_v6_mask = 48 # nil skips masking
```
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).