Google Analytics for you commandline tools

analytics.rb is a simple implementation of the Google Analytics measurement protocol that takes just three steps to use

1. Create a Google Analytics property with universal analytics using an 'app' profile (not website) help

2. Configure Analytics in just one line

Analytics.configure "UA-XXXXXXXX-Y", "MyAppName" 

3. Log 'Event' or 'Exception' activity in just one line

Analytics.event category:'AppStart' action:'--help' 

Voila! You have logged an event to your App analytics from the command line!

Analytics.rb supports the following options

• Event Logging: track any 'event' you define and report it in the Behaviour section of GA
• Exception Logging: capture exception information and send back analysis in the Crashes section of GA
• Timing Logging: track timing and performance statistics and report it in the App Speed section of GA

All request to the GA Measurement API are done on a new thread. The return type for logging methods is of type Thread The Net::HTTP::Response object is contained in the thread's :response key incase you want to access it

Event tracking supports the following (all the following are optional parameters)

Sample Exception

Log and event with cagetory and label values

Analytics.event category: "Parameters", label: "--help"

The event method returns a type 'Thread' that is executing the fire and forget request

In this examlpe we log an event and wait for execution to complete

thread = Analytics.event category: "Parameter", label: "--all"  
# capture fire and forget thread

thread.nil?                                                     
# => false, if it is nil there was an error

thread.status                                                   
# => sleep | The thread is most likely sleeping since it is in IO

thread.join                                                     
# block and wait until thread is complete

resp = thread[:response]                                        
# Net::HTTP::Response object

See the GA event reference regarding the different options.

See the GA parameter reference regard the maximum bytes

Similar to Event Logging, except only accepting two optional parameters

Sample Exception

rescue Exception => e
  Analytics.exception description: e.message, :fatal? => true
end

Only two required options are necessary to configure Analytics, the properties Tracking ID and Application Name

Analytics.configure "UA-XXXXXXXX-Y", "AppName"

A variety of option parameters are accepted too

NOTE: Calling .configure clears all your configuration options and resets them to defaults.

# debug mode enable ... prints to console
Analytics.configure "UA-XXXXXXXX-Y", "AppName", debug: true

# anonymize client IP address AND resets debug to false
Analytics.configure "UA-XXXXXXXX-Y", "AppName", anonymize_ip: true

# set App Name Explicitly
Analytics.app_version = '0.1'

Client Id

Client Id's are UUIDs that must be sent with every request. Currently a random UUID is assigned for a given instance

Session Start & Stop

You can start and stop sessions by logging with :session parameter

# starts session for this client id
Analytics.event label: "Program start", session: 'start'  

# wait for 10 seconds ... 
sleep 10                                                  

# terminate the session for this client Id
Analytics.exception description: "Uh-Oh", session: 'end'