Split evaluator

Using Split involves using one of our SDKs. The Split team builds and maintains these SDKs for some of the most popular language libraries and the SDKs are available under open source licenses. For languages where there is no native SDK support, Split offers the Split Evaluator, a small service capable of evaluating some or all available features for a given customer via a REST endpoint.

Installation

The service is available via its source code at https://github.com/splitio/split-evaluator.

To install the service:

1. Clone the repository: git clone https://github.com/splitio/split-evaluator
2. Prepare the sources: npm install

Usage

You can run Split Evaluator via the command line or Docker.

Command line

SPLITIO_API_KEY=<SPLIT_SDK_KEY> \
SPLITIO_EXT_API_KEY=<YOUR_CUSTOM_AUTHENTICATION> \
npm start

Docker

• Pull the image: docker pull splitsoftware/split-evaluator
• Run as: docker run -e SPLITIO_API_KEY={YOUR_API_KEY} -p 4444:7548 splitsoftware/split-evaluator

Endpoints

/get-treatment

Evaluates a single feature (split-name) for a single key.

Query params

• key: The key used in the getTreatment call.
• split-name: The name of the split you want to include in the getTreatment call.
• bucketing-key: (Optional) The bucketing key used in the getTreatment call.
• attributes: (Optional) A JSON string of the attributes to include in the getTreatment() call of the SDK.

Example

curl 'http://localhost:4444/get-treatment?key=my-customer-key&split-name=my-experiment&attributes=\{"attribute1":"one","attribute2":2,"attribute3":true\}' -H 'Authorization: {SPLITIO_EXT_API_KEY}'

Response

  {
    "splitName": "my-experiment",
    "treatment": "on"
  }

/get-treatments

Evaluates several features in bulk.

Query params

• keys: The array of keys to be used in the getTreatments call. Each key should specify matchingKey and trafficType. You can also specify bucketingKey.
• attributes: (optional) A JSON string of the attributes to include in the getTreatment() call of the SDK.

Example

curl 'http://localhost:4444/get-treatments?keys=\[\{"matchingKey":"my-first-key","trafficType":"account"\},\{"matchingKey":"my-second-key","bucketingKey":"my-bucketing-key","trafficType":"user"\}\]&attributes=\{"attribute1":"one","attribute2":2,"attribute3":true\}' -H 'Authorization: {SPLITIO_EXT_API_KEY}'

Response

[
  { "splitName": "my-experiment", "treatment":"on" },
  { "splitName": "my-second-experiment", "treatment":"off" },
  ...
  { "splitName": "my-last-experiment", "treatment":"visa" }
]

/admin/ping

A ping endpoint to monitor the service status. If the service is running, it responds with pong and the HTTP status code 200.

Example

curl 'http//localhost:4444/admin/ping'

/admin/uptime

Returns the uptime of the service in a human-readable string.

Example

curl 'http//localhost:4444/admin/uptime'

Response

"5d 3h 36m 39s"

/admin/healthcheck

Checks that everything is working as expected before sending evaluations. It returns a status code of either 200 or 500, depending on the result of the check, along with a message explaining the status.

Example

curl 'http//localhost:4444/admin/healthcheck'

Response

// For 200 status code
"Split Evaluator working as expected."

// For 500 status code
"Split evaluator engine not evaluating traffic properly."

/admin/version

Version information for the evaluator and the SDK within.

Example

curl 'http//localhost:4444/admin/version'

Response

  {
    "version": "1.0.2",
    "sdk": "nodejs",
    "sdkVersion": "9.3.4"
  }

/admin/machine

Returns the data for the machine where this service is running.

Example

curl 'http//localhost:4444/admin/machine'

Response

  {
    "ip": "10.0.0.125",
    "name": "machine_name"
  }

Configuration

The available configuration variables are listed below. Always use -e <VARIABLE>=<VALUE> with Docker.

HTTPS/SSL

This service does not currently support a secured connection. We recommend running this service in a redundant manner behind a load balancer such as AWS ELB or Nginx, with SSL termination.

Reach out to us any time at support@split.io if you have questions.