The Split.io Elixir thin client.

This module provides a simple API to interact with the Split.io service via the Split Daemon (splitd).

Adding Split to Your Supervision Tree

The most basic approach is to add Split as a child of your application's top-most supervisor, i.e. lib/my_app/application.ex.

defmodule MyApp.Application do
  use Application

  def start(_type, _args) do
    children = [
      # ... other children ...
      {Split, [socket_path: "/var/run/split.sock"]}
    ]

    opts = [strategy: :one_for_one, name: MyApp.Supervisor]
    Supervisor.start_link(children, opts)
  end
end

You can also start Split dynamically by calling Split.Supervisor.start_link/1:

Split.Supervisor.start_link(opts)

Options

Split takes a number of keyword arguments as options when starting. The following options are available:

• :socket_path: REQUIRED The path to the splitd socket file. For example /var/run/splitd.sock.
• :pool_size: OPTIONAL The size of the pool of connections to the splitd daemon. Default is the number of online schedulers in the Erlang VM (See: https://www.erlang.org/doc/apps/erts/erl_cmd.html).
• :connect_timeout: OPTIONAL The timeout in milliseconds to connect to the splitd daemon. Default is 1000.

Using the API

Once you have started Split, you are ready to start interacting with the Split.io splitd's daemon to access feature flags and configurations.

Split.get_treatment("user_key", "feature_name")