Contents

# Infield

This gem handles reporting deprecation warnings to Infield from a Rails app.

## Setup

You'll need an API key and repo environment ID to use this gem. You can find these at https://app.infield.ai/deprecations after signing up.

Add the gem to your gemfile:

    gem 'infield', require: false

Then in `config/application.rb`:

    if ENV['INFIELD_API_KEY']
      require 'infield'
      Infield.run(api_key: ENV['INFIELD_API_KEY'],
                  repo_environment_id: ENV['INFIELD_REPO_ENVIRONMENT_ID'])
    end

And in any environment you want to profile from:

    config.active_support.deprecation = :notify

## Configuration options

The infield gem batches requests and sends them asyncronously. You can configure the following options to `Infield.run` (defaults shown here):

    Infield.run(
        api_key: key, # required
        repo_environment_id: id, # required
        sleep_interval: 5, # seconds, # how long to sleep between processing events
        batch_size: 10, # how many events to batch in one API request to Infield
        queue_limit: 30 # If more than this number of events come in in sleep_interval, any over are dropped
    )

## Test environment notes

If you enable this gem in test and use another gem to block all web
calls in your test environment, make sure to allow access to `app.infield.ai`.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
infield-0.3.0	README.md