Split SDK for Elixir

hex.pm versionBuild StatusGreenkeeper badge

Overview

This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via feature flags to manage your complete customer experience.

Twitter Follow

Compatibility

The Elixir Thin Client SDK is compatible with Elixir v1.14.0 and later, and requires Splitd daemon v1.2.0 or later.

Getting started

Installing from Hex.pm

The Split Elixir thin client is published as a package in hex.pm. It can be installed by adding split_thin_elixir to your list of dependencies in mix.exs:

def deps do
  [
    {:split, "~> 1.0", hex: :split_thin_sdk}
  ]
end

After adding the dependency, run mix deps.get to fetch the new dependency.

Using the SDK

Below is a simple example that describes the instantiation and most basic usage of our SDK.

NOTE: Keep in mind that Elixir SDK requires an Splitd daemon instance running in your infrastructure to connect to, with the link type set to unix-stream.

# Start the SDK supervisor
Split.Supervisor.start_link(address: "/var/run/splitd.sock")

# Get treatment for a user
case Split.get_treatment(user_id, feature_flag_name) do
  "on" ->
    # Feature flag is enabled for this user
  "off" ->
    # Feature flag is disabled for this user
  _ ->
    # "control" treatment. For example, when feature flag is not found or Elixir SDK wasn't able to connect to Splitd
end

Please refer to our official docs to learn about all the functionality provided by our SDK and the configuration options available for tailoring it to your current application setup.

Submitting issues

The Split team monitors all issues submitted to this issue tracker. We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.

Contributing

Please see Contributors Guide to find all you need to submit a Pull Request (PR).

License

Licensed under the Apache License, Version 2.0. See: Apache License.

About Split

Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.

To learn more about Split, contact hello@split.io, or get started with feature flags for free at https://www.split.io/signup.

Split has built and maintains SDKs for:

For a comprehensive list of open source projects visit our Github page.

Learn more about Split:

Visit split.io/product for an overview of Split, or visit our documentation at help.split.io for more detailed information.