sarathi-consul-strategy

0.0.6 • Public • Published

sarathi-consul-strategy

Implementation of Sarathi's discovery API for Consul.io

Build Status Coverage Status

Installation

npm install sarathi-consul-strategy --save

Features

Lets you use Sarathi as declarative rest client with client-side load balancing when using consul.io discovery server.

Usage

var ConsulDiscoveryStrategy = require("sarathi-consul-strategy").DiscoveryStrategy;
var ds = new ConsulDiscoveryStrategy(...);
sarathiClientBuilder.setDiscoveryStrategy(ds);

Options

  • serviceId: String name of the service to discover, Ex: "testservice"
  • client: Object instance of discovery service client, if you already have one; you might have used it for registering your service.
  • clientConfig: Object Configuration to be passed to discovery service client, if you want sarathi to instantiate it. Client instance, if passed, takes precedence over this.
  • refreshRate: Number in ms. timeout, to refresh discovered services. Ex: 30000 to mean every 30s.
  • zone: String not yet supported, but for data-center awareness.
  • discoveryTimeout: Number in ms. Timeout, time to wait for before the call to the discovery server times out.

Examples

When consul server is running locally

var ds = new ConsulDiscoveryStrategy({serviceId: "express-service"});

When consul client already instantiated

var ds = new ConsulDiscoveryStrategy({serviceId: "express-service", client: consulClientInstance});

API

A fluent API for setting configuration

DiscoveryBuilder()

Object returned by require("sarathi-consul-strategy").StrategyBuilder

#setClient(discoveryClient)

Set instance of the discovery server client. This shall come handy when you have already instantiated the client instance for registering with the server.

#setClientConfig(clientConfig)

Pass the config for sarathi to instantiate the client. If setClient and setClientConfig both are used, client instance passed will be used and the configuration provided to this method will be discarded. You can un-set the client instance by setting it to undefined.

#setRefreshRate(refreshRate)

Set service catalg refresh timeout

#setServiceId(serviceId)

Set the service name to look for on the discovery server

#setZone(zone)

NOT Implemented; but this is where you can set the data center preference

#setDiscoveryTimeout(timeout)

Sets the timeout period for throwing exception for when discovery server is taking too long to respond.

#build()

Builds the discovery handler instance and returns the instance of DiscoveryStrategy.

ConsulDiscoveryStrategy

Sarathi consul discovery strategy

#getConsulInstance()

Returns the instance of consul client, if you needed to use it.

Configuration Defaults

{
    serviceId: undefined,
    client: undefined,
    clientConfig: {},
    refreshRate: 30000,
    zone: undefined,
    discoveryTimeout: 30000
}

Package Sidebar

Install

npm i sarathi-consul-strategy

Weekly Downloads

4

Version

0.0.6

License

MIT

Last publish

Collaborators

  • nikhilw