The Customer Data Platform for Developers

Website · Documentation · Community Slack

The RudderStack Ruby SDK lets you send customer event data from your Ruby applications to your specified destinations.

• Set up a RudderStack open source account.
• Set up a Ruby source in the dashboard.
• Copy the write key and the data plane URL. For more information, refer to the Ruby SDK documentation.

To install the RudderStack Ruby SDK, add this line to your application's Gem file:

gem 'rudder_analytics_sync'

You can also install it yourself by running the following command:

gem install rudder_analytics_sync

To use the Ruby SDK, create a client instance as shown:

analytics = RudderAnalyticsSync::Client.new(
  write_key: 'WRITE_KEY', # Required
  data_plane_url: 'DATA_PLANE_URL',
  stub: false,
  gzip: true,  # Set to false to disable Gzip compression
  on_error: proc { |error_code, error_body, exception, response|
    # defaults to an empty proc
  }
)

You can then use this client to send the events. A sample track call sent using the client is shown below:

analytics.track(
  user_id: 12345,
  event: 'Test Event'
)

From version 2.0.0, the Ruby SDK supports Gzip compression and it is enabled (set to true) by default. However, you can disable this feature by setting the Gzip parameter to false while initializing the SDK, as shown:

analytics = RudderAnalyticsSync::Client.new(
  write_key: 'WRITE_KEY', # required
  data_plane_url: 'DATA_PLANE_URL',
  stub: false,
  gzip: false, // Set to true to enable Gzip compression
  on_error: proc { |error_code, error_body, exception, response|
    # defaults to an empty proc
  }
)

Refer to the RudderStack Ruby SDK documentation for more information on the supported event types.

You can manually batch your events using analytics.batch, as shown:

analytics.batch do |batch|
  batch.context = {...}       # Shared context for all the events
  batch.integrations = {...}  # Shared integrations hash for all the events
  batch.identify(...)
  batch.track(...)
  batch.track(...)
  ...
end

The RudderStack Ruby SDK is released under the MIT license.