consul - npm Package Compare versions

Comparing version 0.3.0 to 0.4.0

lib/agent.js

@@ -11,2 +11,4 @@ /**
 
+var AgentCheck = require('./agent/check').AgentCheck;
+var AgentService = require('./agent/service').AgentService;
 var utils = require('./utils');
@@ -20,2 +22,4 @@
   this.consul = consul;
+  this.check = new AgentCheck(consul);
+  this.service = new AgentService(consul);
 }
@@ -28,14 +32,3 @@
 Agent.prototype.checks = function(callback) {
-  this.consul.emit('debug', 'agent.checks');
-
-  var req = {
-    method: 'GET',
-    path: '/agent/checks',
-  };
-
-  this.consul.request(req, function(err, res) {
-    if (err) return callback(err);
-
-    callback(null, res.body);
-  });
+  this.check.list(callback);
 };
@@ -48,18 +41,7 @@
 Agent.prototype.services = function(callback) {
-  this.consul.emit('debug', 'agent.services');
-
-  var req = {
-    method: 'GET',
-    path: '/agent/services',
-  };
-
-  this.consul.request(req, function(err, res) {
-    if (err) return callback(err);
-
-    callback(null, res.body);
-  });
+  this.service.list(callback);
 };
 
 /**
- * Returns the members as seen by the local serf agent
+ * Returns the members as seen by the local consul agent
  */
@@ -66,0 +48,0 @@

lib/consul.js

@@ -15,4 +15,7 @@ /**
 var Agent = require('./agent').Agent;
+var Catalog = require('./catalog').Catalog;
+var Health = require('./health').Health;
 var Kv = require('./kv').Kv;
 var Session = require('./session').Session;
+var Status = require('./status').Status;
 var request = require('./request');
@@ -34,7 +37,10 @@
   this.host = options.host || 'localhost';
-  this.httpPort = options.httpPort || '8500';
+  this.port = options.port || '8500';
 
   this.agent = new Agent(this);
+  this.catalog = new Catalog(this);
+  this.health = new Health(this);
   this.kv = new Kv(this);
   this.session = new Session(this);
+  this.status = new Status(this);
 }
@@ -52,3 +58,3 @@
   options.hostname = this.host;
-  options.port = this.httpPort;
+  options.port = this.port;
   options.path = '/v1' + options.path;
@@ -55,0 +61,0 @@

lib/kv.js

@@ -44,2 +44,6 @@ /**
   if (options.hasOwnProperty('wait')) req.query.wait = options.wait;
+  if (options.raw) {
+    req.query.raw = 'true';
+    req.buffer = true;
+  }
 
@@ -49,6 +53,8 @@ this.consul.request(req, function(err, res) {
     if (err) return callback(err);
+    if (options.raw) return callback(null, res.body);
 
     if (res.body && Array.isArray(res.body)) {
       res.body.forEach(function(item) {
-        item.Value = new Buffer(item.Value, 'base64').toString();
+        item.Value = new Buffer(item.Value, 'base64');
+        if (!options.buffer) item.Value = item.Value.toString();
       });
@@ -137,7 +143,5 @@ }
 
-  this.consul.request(req, function(err, res) {
+  this.consul.request(req, function(err) {
     if (err) return callback(err);
 
-    if (res.statusCode !== 200) return callback(new Error('delete failed'));
-
     callback();
@@ -144,0 +148,0 @@ });

lib/request.js

@@ -124,15 +124,17 @@ /**
 
-        var contentType = (res.headers['content-type'] || '').split(';')[0];
+        if (!options.buffer) {
+          var contentType = (res.headers['content-type'] || '').split(';')[0];
 
-        switch (contentType.trim()) {
-          case 'application/json':
-            try {
-              res.body = JSON.parse(res.body.toString());
-            } catch (err) {
-              return callback(err);
-            }
-            break;
-          case 'text/plain':
-            res.body = res.body.toString();
-            break;
+          switch (contentType.trim()) {
+            case 'application/json':
+              try {
+                res.body = JSON.parse(res.body.toString());
+              } catch (err) {
+                return callback(err);
+              }
+              break;
+            case 'text/plain':
+              res.body = res.body.toString();
+              break;
+          }
         }
@@ -139,0 +141,0 @@ }

lib/session.js

@@ -44,6 +44,6 @@ /**
   if (options.dc) req.query.dc = options.dc;
-  if (options.hasOwnProperty('lockdelay')) req.body.LockDelay = options.lockdelay;
-  if (options.hasOwnProperty('name')) req.body.Name = options.name;
-  if (options.hasOwnProperty('node')) req.body.Node = options.node;
-  if (options.hasOwnProperty('checks')) req.body.Checks = options.checks;
+  if (options.lockdelay) req.body.LockDelay = options.lockdelay;
+  if (options.name) req.body.Name = options.name;
+  if (options.node) req.body.Node = options.node;
+  if (options.checks) req.body.Checks = options.checks;
 
@@ -89,3 +89,3 @@ this.consul.request(req, function(err, res) {
 
-Session.prototype.info = function(options, callback) {
+Session.prototype.get = function(options, callback) {
   if (typeof options === 'string') {
@@ -118,2 +118,4 @@ options = { id: options };
 
+Session.prototype.info = Session.prototype.get;
+
 /**
@@ -125,3 +127,3 @@ * Lists sessions belonging to a node
   if (typeof options === 'string') {
-    options = { name: options };
+    options = { node: options };
   }
@@ -135,3 +137,3 @@
     method: 'GET',
-    path: '/session/node/' + options.name,
+    path: '/session/node/' + options.node,
     query: {},
@@ -138,0 +140,0 @@ };

package.json

 {
   "name": "consul",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Consul client",
@@ -10,12 +10,11 @@ "main": "lib/index.js",
     "jshint": "^2.5.1",
+    "lodash": "^2.4.1",
     "mocha": "^1.20.1",
+    "node-uuid": "^1.4.1",
     "should": "^4.0.4",
+    "temp": "^0.8.0",
     "uuid": "^1.4.1"
   },
   "scripts": {
-    "test": "./node_modules/.bin/jshint lib test && ./node_modules/.bin/jscs lib test && ./node_modules/.bin/mocha --recursive --require should -R spec",
-    "less": "less ./test/tmp/*.log",
-    "tail": "tail -f ./test/tmp/*.log",
-    "start": "./test/cluster start",
-    "stop": "./test/cluster stop"
+    "test": "./node_modules/.bin/jshint lib test/*.js && ./node_modules/.bin/jscs lib test/*.js && ./node_modules/.bin/mocha --reporter spec --timeout 15000"
   },
@@ -22,0 +21,0 @@ "keywords": [

README.md

@@ -5,12 +5,1111 @@ # Consul
 
-## Test
+ * [Documentation](#documentation)
+ * [Development](#development)
 
-``` console
-$ sudo ifconfig lo0 alias 127.0.0.2 up
-$ sudo ifconfig lo0 alias 127.0.0.3 up
-$ npm install
-$ npm start
-$ npm test
+## Documentation
+
+See the official [HTTP API][consul-docs-api] docs for more information.
+
+ * [Consul](#init)
+ * [Agent](#agent)
+  * [Check](#agent-check)
+  * [Service](#agent-service)
+ * [Catalog](#catalog)
+  * [Node](#catalog-node)
+  * [Service](#catalog-service)
+ * [Health](#health)
+ * [KV](#kv)
+ * [Session](#session)
+ * [Status](#status)
+
+<a name="init"/>
+### consul([options])
+
+Initialize a new Consul client.
+
+Options
+
+ * host (String, default: 127.0.0.1): agent address
+ * port (String, default: 8500): agent HTTP port
+
+Usage
+
+``` javascript
+var consul = require('consul')();
 ```
 
+<a name="agent"/>
+### consul.agent
+
+ * [check](#agent-check)
+ * [service](#agent-service)
+ * [members](#agent-members)
+ * [self](#agent-self)
+ * [join](#agent-join)
+ * [forceLeave](#agent-force-leave)
+
+<a name="agent-members"/>
+### consul.agent.members([options], callback)
+
+Returns the members as seen by the consul agent.
+
+Options
+
+ * wan (Boolean, default: false): return WAN members instead of LAN members 
+
+Usage
+
+``` javascript
+consul.agent.members(function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+[
+  {
+    "Name": "node1",
+    "Addr": "127.0.0.1",
+    "Port": 8301,
+    "Tags": {
+      "bootstrap": "1",
+      "build": "0.3.0:441d613e",
+      "dc": "dc1",
+      "port": "8300",
+      "role": "consul",
+      "vsn": "2",
+      "vsn_max": "2",
+      "vsn_min": "1"
+    },
+    "Status": 1,
+    "ProtocolMin": 1,
+    "ProtocolMax": 2,
+    "ProtocolCur": 2,
+    "DelegateMin": 2,
+    "DelegateMax": 4,
+    "DelegateCur": 4
+  }
+]
+```
+
+<a name="agent-self"/>
+### consul.agent.self(callback)
+
+Returns the agent node configuration.
+
+Usage
+
+``` javascript
+consul.agent.self(function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+{
+  "Config": {
+    "Bootstrap": true,
+    "Server": true,
+    "Datacenter": "dc1",
+    "DataDir": "/tmp/node1/data",
+    "DNSRecursor": "",
+    "DNSConfig": {
+      "NodeTTL": 0,
+      "ServiceTTL": null,
+      "AllowStale": false,
+      "MaxStale": 5000000000
+    },
+    "Domain": "consul.",
+    "LogLevel": "INFO",
+    "NodeName": "node1",
+    "ClientAddr": "127.0.0.1",
+    "BindAddr": "127.0.0.1",
+    "AdvertiseAddr": "127.0.0.1",
+    "Ports": {
+      "DNS": 8600,
+      "HTTP": 8500,
+      "RPC": 8400,
+      "SerfLan": 8301,
+      "SerfWan": 8302,
+      "Server": 8300
+    },
+    "LeaveOnTerm": false,
+    "SkipLeaveOnInt": false,
+    "StatsiteAddr": "",
+    "Protocol": 2,
+    "EnableDebug": false,
+    "VerifyIncoming": false,
+    "VerifyOutgoing": false,
+    "CAFile": "",
+    "CertFile": "",
+    "KeyFile": "",
+    "ServerName": "",
+    "StartJoin": [],
+    "UiDir": "",
+    "PidFile": "/tmp/node1/pid",
+    "EnableSyslog": false,
+    "SyslogFacility": "LOCAL0",
+    "RejoinAfterLeave": false,
+    "CheckUpdateInterval": 300000000000,
+    "Revision": "441d613e1bd96254c78c46ee7c1b35c161fc7295+CHANGES",
+    "Version": "0.3.0",
+    "VersionPrerelease": ""
+  },
+  "Member": {
+    "Name": "node1",
+    "Addr": "127.0.0.1",
+    "Port": 8301,
+    "Tags": {
+      "bootstrap": "1",
+      "build": "0.3.0:441d613e",
+      "dc": "dc1",
+      "port": "8300",
+      "role": "consul",
+      "vsn": "2",
+      "vsn_max": "2",
+      "vsn_min": "1"
+    },
+    "Status": 1,
+    "ProtocolMin": 1,
+    "ProtocolMax": 2,
+    "ProtocolCur": 2,
+    "DelegateMin": 2,
+    "DelegateMax": 4,
+    "DelegateCur": 4
+  }
+}
+```
+
+<a name="agent-join"/>
+### consul.agent.join(options, callback)
+
+Trigger agent to join a node.
+
+Options
+
+ * address (String): node IP address to join
+ * wan (Boolean, default false): attempt to join using the WAN pool
+
+Usage
+
+``` javascript
+consul.agent.join('127.0.0.2', function(err) {
+  if (err) throw err;
+});
+```
+
+<a name="agent-force-leave"/>
+### consul.agent.forceLeave(options, callback)
+
+Force remove node.
+
+Options
+
+ * node (String): node name to remove
+
+Usage
+
+``` javascript
+consul.agent.forceLeave('node2', function(err) {
+  if (err) throw err;
+});
+```
+
+<a name="agent-check"/>
+### consul.agent.check
+
+ * [list](#agent-check-list)
+ * [register](#agent-check-register)
+ * [deregister](#agent-check-deregister)
+ * [pass](#agent-check-pass)
+ * [warn](#agent-check-warn)
+ * [fail](#agent-check-fail)
+
+<a name="agent-check-list"/>
+### consul.agent.check.list(callback)
+
+Returns the checks the agent is managing.
+
+Usage
+
+``` javascript
+consul.agent.check.list(function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+{
+  "example": {
+    "Node": "node1",
+    "CheckID": "example",
+    "Name": "example",
+    "Status": "passing",
+    "Notes": "This is an example check.",
+    "Output": "",
+    "ServiceID": "",
+    "ServiceName": ""
+  }
+}
+```
+
+<a name="agent-check-register"/>
+### consul.agent.check.register(options, callback)
+
+Registers a new check.
+
+Options
+
+ * name (String): check name
+ * id (String, optional): check ID
+ * script (String): path to check script, requires interval
+ * internal (String): interval to run check, requires script (ex: `15s`)
+ * ttl (String): time to live before check must be updated, instead of script and interval (ex: `60s`)
+ * notes (String, optional): human readable description of check
+
+Usage
+
+``` javascript
+var check = {
+  name: 'example',
+  ttl: '15s',
+  notes: 'This is an example check.',
+};
+
+consul.agent.check.register(check, function(err) {
+  if (err) throw err;
+});
+```
+
+<a name="agent-check-deregister"/>
+### consul.agent.check.deregister(options, callback)
+
+Deregister a check.
+
+Options
+
+ * id (String): check ID
+
+Usage
+
+``` javascript
+consul.agent.check.deregister('example', function(err) {
+  if (err) throw err;
+});
+```
+
+<a name="agent-check-pass"/>
+### consul.agent.check.pass(options, callback)
+
+Mark a test as passing.
+
+Options
+
+ * id (String): check ID
+
+Usage
+
+``` javascript
+consul.agent.check.pass('example', function(err) {
+  if (err) throw err;
+});
+```
+
+<a name="agent-check-warn"/>
+### consul.agent.check.warn(options, callback)
+
+Mark a test as warning.
+
+Options
+
+ * id (String): check ID
+
+Usage
+
+``` javascript
+consul.agent.check.warn('example', function(err) {
+  if (err) throw err;
+});
+```
+
+<a name="agent-check-fail"/>
+### consul.agent.check.fail(options, callback)
+
+Mark a test as critical.
+
+Options
+
+ * id (String): check ID
+
+Usage
+
+``` javascript
+consul.agent.check.fail('example', function(err) {
+  if (err) throw err;
+});
+```
+
+<a name="agent-service"/>
+### consul.agent.service
+
+ * [list](#agent-service-list)
+ * [register](#agent-service-register)
+ * [deregister](#agent-service-deregister)
+
+<a name="agent-service-list"/>
+### consul.agent.service.list(callback)
+
+Returns the services the agent is managing.
+
+Usage
+
+``` javascript
+consul.agent.service.list(function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+{
+  "example": {
+    "ID": "example",
+    "Service": "example",
+    "Tags": [
+      "dev",
+      "web"
+    ],
+    "Port": 80
+  }
+}
+```
+
+<a name="agent-service-register"/>
+### consul.agent.service.register(options, callback)
+
+Registers a new service.
+
+Options
+
+ * name (String): service name
+ * id (String, optional): service ID
+ * tags (String[], optional): service tags
+ * check (Object, optional): service check
+  * script (String): path to check script, requires interval
+  * internal (String): interval to run check, requires script (ex: `15s`)
+  * ttl (String): time to live before check must be updated, instead of script and interval (ex: `60s`)
+  * notes (String, optional): human readable description of check
+
+Usage
+
+``` javascript
+consul.agent.service.register('example', function(err) {
+  if (err) throw err;
+});
+```
+
+<a name="agent-service-deregister"/>
+### consul.agent.service.deregister(options, callback)
+
+Deregister a service.
+
+Options
+
+ * id (String): check ID
+
+Usage
+
+``` javascript
+consul.agent.service.deregister('example', function(err) {
+  if (err) throw err;
+});
+```
+
+<a name="catalog"/>
+### consul.catalog
+
+ * [node](#catalog-node)
+ * [service](#catalog-service)
+ * [datacenters](#catalog-datacenters)
+
+<a name="catalog-datacenters"/>
+### consul.catalog.datacenters(callback)
+
+Lists known datacenters.
+
+Usage
+
+``` javascript
+consul.catalog.datacenters(function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+[
+  "dc1"
+]
+```
+
+<a name="catalog-node"/>
+### consul.catalog.node
+
+ * [list](#catalog-node-list)
+ * [services](#catalog-node-services)
+
+<a name="catalog-node-list"/>
+### consul.catalog.node.list([options], callback)
+
+Lists nodes in a given datacenter.
+
+Options
+
+ * dc (String, optional): datacenter (defaults to local for agent)
+
+Usage
+
+``` javascript
+consul.catalog.node.list(function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+[
+  {
+    "Node": "node1",
+    "Address": "127.0.0.1"
+  }
+]
+```
+
+<a name="catalog-node-services"/>
+### consul.catalog.node.services(options, callback)
+
+Lists the services provided by a node.
+
+Options
+
+ * node (String): node ID
+
+Usage
+
+``` javascript
+consul.catalog.node.services('node1', function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+{
+  "Node": {
+    "Node": "node1",
+    "Address": "127.0.0.1"
+  },
+  "Services": {
+    "consul": {
+      "ID": "consul",
+      "Service": "consul",
+      "Tags": null,
+      "Port": 8300
+    },
+    "example": {
+      "ID": "example",
+      "Service": "example",
+      "Tags": [
+        "dev",
+        "web"
+      ],
+      "Port": 80
+    }
+  }
+}
+```
+
+<a name="catalog-service"/>
+### consul.catalog.service
+
+ * [list](#catalog-service-list)
+ * [nodes](#catalog-service-nodes)
+
+<a name="catalog-service-list"/>
+### consul.catalog.service.list([options], callback)
+
+Lists services in a given datacenter.
+
+Options
+
+ * dc (String): datacenter (defaults to local for agent)
+
+Usage
+
+``` javascript
+consul.catalog.service.list(function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+{
+  "consul": [],
+  "example": [
+    "dev",
+    "web"
+  ]
+}
+```
+
+<a name="catalog-service-nodes"/>
+### consul.catalog.service.nodes(options, callback)
+
+Lists the nodes in a given service.
+
+Options
+
+ * service (String): service ID
+ * dc (String, optional): datacenter (defaults to local for agent)
+ * tag (String, optional): filter by tag
+
+Usage
+
+``` javascript
+consul.catalog.service.nodes('example', function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+[
+  {
+    "Node": "node1",
+    "Address": "127.0.0.1",
+    "ServiceID": "example",
+    "ServiceName": "example",
+    "ServiceTags": [
+      "dev",
+      "web"
+    ],
+    "ServicePort": 80
+  }
+]
+```
+
+<a name="health"/>
+### consul.health
+
+ * [node](#health-node)
+ * [checks](#health-checks)
+ * [service](#health-service)
+ * [state](#health-state)
+
+<a name="health-node"/>
+### consul.health.node(options, callback)
+
+Returns the health info of a node.
+
+Options
+
+ * node (String): node
+ * dc (String, optional): datacenter (defaults to local for agent)
+
+Usage
+
+``` javascript
+consul.health.node('node1', function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+[
+  {
+    "Node": "node1",
+    "CheckID": "serfHealth",
+    "Name": "Serf Health Status",
+    "Status": "passing",
+    "Notes": "",
+    "Output": "Agent alive and reachable",
+    "ServiceID": "",
+    "ServiceName": ""
+  },
+  {
+    "Node": "node1",
+    "CheckID": "service:example",
+    "Name": "Service 'example' check",
+    "Status": "unknown",
+    "Notes": "",
+    "Output": "",
+    "ServiceID": "example",
+    "ServiceName": "example"
+  }
+]
+```
+
+<a name="health-checks"/>
+### consul.health.checks(options, callback)
+
+Returns the checks of a service.
+
+Options
+
+ * service (String): service ID
+ * dc (String, optional): datacenter (defaults to local for agent)
+
+Usage
+
+``` javascript
+consul.health.checks('example', function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+[
+  {
+    "Node": "node1",
+    "CheckID": "service:example",
+    "Name": "Service 'example' check",
+    "Status": "unknown",
+    "Notes": "",
+    "Output": "",
+    "ServiceID": "example",
+    "ServiceName": "example"
+  }
+]
+```
+
+<a name="health-service"/>
+### consul.health.service(options, callback)
+
+Returns the nodes and health info of a service.
+
+Options
+
+ * service (String): service ID
+ * dc (String, optional): datacenter (defaults to local for agent)
+ * tag (String, optional): filter by tag
+ * passing (Boolean, optional): restrict to passing checks
+
+Usage
+
+``` javascript
+consul.health.service('example', function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+[
+  {
+    "Node": {
+      "Node": "node1",
+      "Address": "127.0.0.1"
+    },
+    "Service": {
+      "ID": "example",
+      "Service": "example",
+      "Tags": null,
+      "Port": 0
+    },
+    "Checks": [
+      {
+        "Node": "node1",
+        "CheckID": "service:example",
+        "Name": "Service 'example' check",
+        "Status": "unknown",
+        "Notes": "",
+        "Output": "",
+        "ServiceID": "example",
+        "ServiceName": "example"
+      },
+      {
+        "Node": "node1",
+        "CheckID": "serfHealth",
+        "Name": "Serf Health Status",
+        "Status": "passing",
+        "Notes": "",
+        "Output": "Agent alive and reachable",
+        "ServiceID": "",
+        "ServiceName": ""
+      }
+    ]
+  }
+]
+```
+
+<a name="health-state"/>
+### consul.health.state(options, callback)
+
+Returns the checks in a given state.
+
+Options
+
+ * state (String, enum: any, unknown, passing, warning, critical): state
+ * dc (String, optional): datacenter (defaults to local for agent)
+
+Usage
+
+``` javascript
+consul.health.state('unknown', function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+[
+  {
+    "Node": "node1",
+    "CheckID": "service:example",
+    "Name": "Service 'example' check",
+    "Status": "unknown",
+    "Notes": "",
+    "Output": "",
+    "ServiceID": "example",
+    "ServiceName": "example"
+  }
+]
+```
+
+<a name="kv"/>
+### consul.kv
+
+ * [get](#kv-get)
+ * [set](#kv-set)
+ * [del](#kv-del)
+
+<a name="kv-get"/>
+### consul.kv.get(options, callback)
+
+Return key/value (kv) pair(s).
+
+Options
+
+ * key (String): path to value
+ * dc (String, optional): datacenter (defaults to local for agent)
+ * recurse (Boolean, default: false): return all keys with given key prefix
+ * index (String, optional): used with `ModifyIndex` to block and wait for changes
+ * wait (String, optional): limit how long to wait for changes (ex: `5m`), used with index
+ * raw (Boolean, optional): return raw value (can't be used with recursive, implies buffer)
+ * buffer (Boolean, default: false): decode value into Buffer instead of String
+
+Usage
+
+``` javascript
+consul.kv.get('hello', function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+{
+  "CreateIndex": 6,
+  "ModifyIndex": 6,
+  "LockIndex": 0,
+  "Key": "hello",
+  "Flags": 0,
+  "Value": "world"
+}
+```
+
+<a name="kv-set"/>
+### consul.kv.set(options, callback)
+
+Set key/value (kv) pair.
+
+Options
+
+ * key (String): key
+ * value (String|Buffer): value
+ * dc (String, optional): datacenter (defaults to local for agent)
+ * flags (Number, optional): unsigned integer opaque to user, can be used by application
+ * cas (String, optional): use with `ModifyIndex` to do a check-and-set operation
+ * acquire (String, optional): session ID, lock acquisition operation
+ * release (String, optional): session ID, lock release operation
+
+Usage
+
+``` javascript
+consul.kv.set('hello', 'world', function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+true
+```
+
+<a name="kv-del"/>
+### consul.kv.del(options, callback)
+
+Delete key/value (kv) pair(s).
+
+Options
+
+ * key (String): key
+ * dc (String, optional): datacenter (defaults to local for agent)
+ * recurse (Boolean, default: false): delete all keys with given key prefix
+
+Usage
+
+``` javascript
+consul.kv.del('hello', function(err) {
+  if (err) throw err;
+});
+```
+
+<a name="session"/>
+### consul.session
+
+ * [create](#session-create)
+ * [destroy](#session-destroy)
+ * [get](#session-get)
+ * [node](#session-node)
+ * [list](#session-list)
+
+<a name="session-create"/>
+### consul.session.create([options], callback)
+
+Create a new session.
+
+Options
+
+ * dc (String, optional): datacenter (defaults to local for agent)
+ * lockdelay (String, range: 1s-60s, default: `15s`): the time consul prevents locks held by the session from being acquired after a session has been invalidated
+ * name (String, optional): human readable name for the session
+ * node (String, optional): node with which to associate session (defaults to connected agent)
+ * checks (String[], optional): checks to associate with session
+
+Usage
+
+``` javascript
+consul.session.create(function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+{
+  "ID": "a0f5dc05-84c3-5f5a-1d88-05b875e524e1"
+}
+```
+
+<a name="session-destroy"/>
+### consul.session.destroy(options, callback)
+
+Destroy a given session.
+
+Options
+
+ * id (String): session ID
+ * dc (String, optional): datacenter (defaults to local for agent)
+
+Usage
+
+``` javascript
+consul.session.destroy('a0f5dc05-84c3-5f5a-1d88-05b875e524e1', function(err) {
+  if (err) throw err;
+});
+```
+
+<a name="session-get"/>
+### consul.session.get(options, callback)
+
+Queries a given session.
+
+Options
+
+ * id (String): session ID
+ * dc (String, optional): datacenter (defaults to local for agent)
+
+Usage
+
+``` javascript
+consul.session.get('a0f5dc05-84c3-5f5a-1d88-05b875e524e1', function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+{
+  "CreateIndex": 11,
+  "ID": "a0f5dc05-84c3-5f5a-1d88-05b875e524e1",
+  "Name": "",
+  "Node": "node1",
+  "Checks": [
+    "serfHealth"
+  ],
+  "LockDelay": 15000000000
+}
+```
+
+<a name="session-node"/>
+### consul.session.node(options, callback)
+
+Lists sessions belonging to a node.
+
+Options
+
+ * node (String): node
+ * dc (String, optional): datacenter (defaults to local for agent)
+
+Usage
+
+``` javascript
+consul.session.node('node1', function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+[
+  {
+    "CreateIndex": 13,
+    "ID": "a0f5dc05-84c3-5f5a-1d88-05b875e524e1",
+    "Name": "",
+    "Node": "node1",
+    "Checks": [
+      "serfHealth"
+    ],
+    "LockDelay": 15000000000
+  }
+]
+```
+
+<a name="session-list"/>
+### consul.session.list([options], callback)
+
+Lists all the active sessions.
+
+Options
+
+ * dc (String, optional): datacenter (defaults to local for agent)
+
+Usage
+
+``` javascript
+consul.session.list(function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+[
+  {
+    "CreateIndex": 15,
+    "ID": "a0f5dc05-84c3-5f5a-1d88-05b875e524e1",
+    "Name": "",
+    "Node": "node1",
+    "Checks": [
+      "serfHealth"
+    ],
+    "LockDelay": 15000000000
+  }
+]
+```
+
+<a name="status"/>
+### consul.status
+
+ * [leader](#status-leader)
+ * [peers](#status-peers)
+
+<a name="status-leader"/>
+### consul.status.leader(callback)
+
+Returns the current Raft leader.
+
+Usage
+
+``` javascript
+consul.status.leader(function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+"127.0.0.1:8300"
+```
+
+<a name="status-peers"/>
+### consul.status.peers(callback)
+
+Returns the current Raft peer set.
+
+Usage
+
+``` javascript
+consul.status.peers(function(err, result) {
+  if (err) throw err;
+});
+```
+
+Result
+
+``` json
+[
+  "127.0.0.1:8300"
+]
+```
+
+## Development
+
+ 1. Install [Consul][download] into your `PATH`.
+ 1. Attach required IPs
+
+    ``` console
+    $ sudo ifconfig lo0 alias 127.0.0.2 up
+    $ sudo ifconfig lo0 alias 127.0.0.3 up
+    ```
+
+ 1. Install client dependencies
+
+    ``` console
+    $ npm install
+    ```
+
+ 1. Run tests
+
+    ``` console
+    $ npm test
+    ```
+
 ## License
@@ -21,1 +1120,3 @@
 [consul]: http://www.consul.io/
+[consul-docs-api]: http://www.consul.io/docs/agent/http.html
+[download]: http://www.consul.io/downloads.html

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Copyleft License

License

(Experimental) Copyleft license information was found.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

67141

increased by288.61%

Number of package files

19

increased by90%

Lines of code

1162

increased by98.29%

Number of lines in readme file

1121

increased by5505%

Worsened metrics

Dev dependency count

9

increased by50%

Number of low license alerts

3

increased byInfinity%

License quality

70

decreased by-30%

No dependency changes