Analytics for Ruby

If you're using Bundler, add the following line to your project's Gemfile:

gem 'analytics-ruby', '~> 2.4.0', :require => 'segment/analytics'

Or, if you're using the gem directly from your application, you'll need to:

gem install analytics-ruby

Then initialize the gem with your Segment source's Write Key and an optional error handler, like so:

1
require 'segment/analytics'
2

3
Analytics = Segment::Analytics.new({
4
    write_key: 'YOUR_WRITE_KEY',
5
    on_error: Proc.new { |status, msg| print msg }
6
})

That will create an instance of Analytics that you can use to send data to Segment for your source.

If you're using Rails, you can stick that initialization logic in config/initializers/analytics_ruby.rb and omit the require call.

For Business plans with access to Regional Segment, you can use the host configuration parameter to send data to the desired region:

1. Oregon (Default) — api.segment.io/
2. Dublin — events.eu1.segmentapis.com/

The Identify method is how you associate your users and their actions to a recognizable userId and traits. You can find details on the identify method payload in the Spec.

The Identify call has the following fields:

Example Identify:

1
Analytics.identify(
2
    user_id: '019mr8mf4r',
3
    traits: { email: "#{ user.email }", friends: 872 },
4
    context: {ip: '8.8.8.8'})

This example call identifies your user by their unique User ID (the one you know him by in your database) and labels them with email and friends traits.

The Track method lets you record any actions your users perform. You can find details on the Track method payload.

The Track call has the following fields:

You should track events that are indicators of success for your site, like Signed Up, Item Purchased or Article Bookmarked.

To get started, Segment recommends tracking just a few important events. You can always add more later.

Example Track call:

1
Analytics.track(
2
    user_id: '019mr8mf4r',
3
    event: 'Item Purchased',
4
    properties: { revenue: 39.95, shipping: '2-day' })

This example Track call tells you that your user just triggered the Item Purchased event with a revenue of $39.95 and chose your hypothetical '2-day' shipping.

Track event properties can be anything you want to record, for example:

1
Analytics.track(
2
    user_id: 'f4ca124298',
3
    event: 'Article Bookmarked',
4
    properties: {
5
      title: 'Snow Fall',
6
      subtitle: 'The Avalance at Tunnel Creek',
7
      author: 'John Branch'
8
    })

For more information about choosing which events to track, event naming and more, check out Analytics Academy.

The Page method lets you record page views on your website, along with optional extra information about the page being viewed.

If you're using Segment's client-side set up in combination with the Ruby library, page calls are already tracked for you by default. However, if you want to record your own page views manually and aren't using the client-side library, read on.

The Page call has the following fields:

Example Page call:

1
Analytics.page(
2
  user_id: user_id,
3
  category: 'Docs',
4
  name: 'Ruby library',
5
  properties: { url: 'https://segment.com/libraries/ruby/' })

Find details on the Page payload in the Segment Spec.

The Group method associates an identified user with a company, organization, project, workspace, team, tribe, platoon, assemblage, cluster, troop, gang, party, society or any other name you came up with for the same concept.

This is useful for tools like Intercom, Preact and Totango, as it ties the user to a group of other users.

The Group call has the following fields:

Example Group call:

1
Analytics.group(
2
  user_id: '019mr8mf4r',
3
  group_id: '56',
4
  traits: { name: 'Initech', description: 'Accounting Software'})

Find more details about Group including the Group payload in the Segment Spec.

Alias is how you associate one identity with another. This is an advanced method, but it is required to manage user identities successfully in some destinations.

In Mixpanel it's used to associate an anonymous user with an identified user once they sign up. For Kissmetrics, if your user switches IDs, you can use Alias to rename the 'userId'.

Alias method definition:

Analytics.alias(previous_id: 'previous id', user_id: 'new id')

The Alias call has the following fields:

Here's a full example of how you might use the Alias call:

1
# the anonymous user does actions ...
2
Analytics.track(user_id: 'anonymous_user', event: 'Anonymous Event')
3
# the anonymous user signs up and is aliased
4
Analytics.alias(previous_id: 'anonymous id', user_id: 'user id')
5
# the identified user is identified
6
Analytics.identify(user_id: 'user id', traits: { plan: 'Free' })
7
# the identified user does actions ...
8
Analytics.track(user_id: 'user id', event: 'Identified Action')

For more details about Alias, including the Alias call payload, check out the Segment Spec.

You can import historical data by adding the timestamp argument to any of your method calls. This can be helpful if you've just switched to Segment.

Historical imports can only be done into destinations that can accept historical timestamped data. Most analytics tools like Mixpanel, Amplitude, and Kissmetrics can handle that type of data just fine. One common destination that does not accept historical data is Google Analytics since their API cannot accept historical data.

Note: If you're tracking things that are happening right now, leave out the timestamp and Segment's servers will timestamp the requests for you.

The Alias, Group, Identify, Page, and Track calls can all be passed an object of integrations that lets you turn certain destinations on or off. By default all destinations are enabled.

Here's an example Track call with the integrations object shown.

1
Analytics.track({
2
  user_id: '83489',
3
  event: 'Song Paused',
4
  integrations: { All: false, Kissmetrics: true }
5
})

In this case, you're specifying that you want this identify to only go to Kissmetrics. All: false says that no destination should be enabled unless otherwise specified, and Kissmetrics: true turns on Kissmetrics.

Destination flags are case sensitive and match the destination's name in the docs (for example, "AdLearn Open Platform", "awe.sm", or "MailChimp").

Note:

• Business Tier users can filter Track calls right from the Segment UI on your source schema page. Segment recommends using the UI if possible since it's a much simpler way of managing your filters and can be updated with no code changes on your side.
• If you are on a grandfathered plan, events sent server-side that are filtered through the Segment dashboard still count towards your API usage.

Segment's libraries are built to support high performance environments. That means it is safe to use analytics-ruby on a web server that's serving hundreds of requests per second.

Every method you call does not result in an HTTP request, but is queued in memory instead. Messages are flushed in batch in the background, which allows for much faster operation.

By default, Segment's library will flush:

• the very first time it gets a message
• whenever messages are queued and there is no outstanding request

There is a maximum of 500KB per batch request and 32KB per call.

The queue consumer makes only a single outbound request at a time to avoid saturating your server's resources. If multiple messages are in the queue, they are sent together in a batch call.

You can specify the following additional options to determine how the queue operates and to help debug possible errors. None of them are required for normal operation.

1
# Error handler to log statements
2

3
Segment::Analytics.new({
4
  write_key: 'YOUR_WRITE_KEY',
5
  on_error: Proc.new { |status, msg| print msg },
6
  max_queue_size: 10000,
7
  batch_size: 100,
8
  stub: true
9
})

If you're running a script or internal queue system to upload data, you should call Analytics.flush at the end of execution to ensure that all of your messages are sent to our servers. Segment also recommendeds that you call flush on shutdown, so that all queued messages are sent to Segment instead of waiting for the next launch.

1
AppAnalytics = Segment::Analytics.new({
2
  write_key: 'ONE_WRITE_KEY'
3
})
4
AppAnalytics.flush

If you're using Ruby on Rails with the Turbolinks setting enabled, and you're adding Analytics.js on your website, you'll need to tweak the default configuration.

Instead of having the entire snippet in the <head> of your site, you need to move the analytics.page() call that is included in the snippet by default into the <body> so that it will get triggered on every new page load. But you must have the first part of the snippet in the <head> or the library will fail to load properly.

The Ruby library will automatically handle serializating your data into JSON for Segment's servers. It uses JSON.generate under the hood. Note that BigDecimal values are intentionally sent as Strings rather than floats so that our Node servers don't lose precision. If you'd prefer to use a float, you can coerce values to a float before sending the data to Segment.

Different parts of your application may require different types of batching, or even sending to multiple Segment sources. In that case, you can initialize multiple instances of Analytics with different settings:

1
AppAnalytics = Segment::Analytics.new({
2
  write_key: 'ONE_WRITE_KEY'
3
})
4

5
MarketingAnalytics = Segment::Analytics.new({
6
  write_key: 'ANOTHER_WRITE_KEY'
7
})

The following tips often help resolve common issues.

1. Double check that you've followed all the steps in the Quickstart.
2. Make sure that you're calling a Segment API method once the library is successfully installed—identify, track, etc.
3. Make sure your application isn't shutting down before the Analytics.Client local queue events are pushed to Segment. You can manually call Analytics.Client.Flush() to ensure the queue is fully processed before shutdown.

If you are experiencing data loss from your source, you may be experiencing one or more of the following common errors:

• Payload is too large: If you attempt to send events larger than 32KB per normal API request or batches of events larger than 500KB per request, Segment's tracking API responds with 400 Bad Request. Try sending smaller events (or smaller batches) to correct this error.
• Identifier is not present: Segment's tracking API requires that each payload has a userId and/or anonymousId. If you send events without either the userId or anonymousId, Segment's tracking API responds with an no_user_anon_id error. Check the event payload and client instrumentation for more details.
• Track event is missing name: All Track events to Segment must have a name in string format.
• Event dropped during deduplication: Segment automatically adds a messageId field to all payloads and uses this value to deduplicate events. If you're manually setting a messageId value, ensure that each event has a unique value.
• Incorrect credentials: Double check your credentials for your downstream destination(s).
• Destination incompatibility: Make sure that the destination you are troubleshooting can accept server-side API calls. You can see compatibility information on the Destination comparison by category page and in the documentation for your specific destination.
• Destination-specific requirements: Check out the destination's documentation to see if there are other requirements for using the method and destination that you're trying to get working.