node-influx
v1.0.2
Published
Communicate with influxd via JSON-RPC
Downloads
239
Maintainers
Readme
node-influx
node-influx is a simple wrapper for the Influx client's JSON-RPC API.
The API is equivalent to the API document here.
The methods are exposed as lower camelcase methods on the influx.Client
object, or you may call the API directly using the cmd
method.
Install
npm install node-influx
Examples
Create client
// all config options are optional
var client = new influx.Client({
host: 'localhost',
port: 9239,
user: 'username',
pass: 'password',
timeout: 30000
});
Get balance across all accounts with minimum confirmations of 6
client.getBalance('*', 6, function(err, balance, resHeaders) {
if (err) return console.log(err);
console.log('Balance:', balance);
});
Getting the balance directly using cmd
client.cmd('getbalance', '*', 6, function(err, balance, resHeaders){
if (err) return console.log(err);
console.log('Balance:', balance);
});
Batch multiple RPC calls into single HTTP request
var batch = [];
for (var i = 0; i < 10; ++i) {
batch.push({
method: 'getnewaddress',
params: ['myaccount']
});
}
client.cmd(batch, function(err, address, resHeaders) {
if (err) return console.log(err);
console.log('Address:', address);
});
SSL
See Enabling SSL on original client.
If you're using this to connect to Influxd across a network it is highly
recommended to enable ssl
, otherwise an attacker may intercept your RPC credentials
resulting in theft of your influx.
When enabling ssl
by setting the configuration option to true
, the sslStrict
option (verifies the server certificate) will also be enabled by default. It is
highly recommended to specify the sslCa
as well, even if your influxd has
a certificate signed by an actual CA, to ensure you are connecting
to your own influxd.
var client = new influx.Client({
host: 'localhost',
port: 9239,
user: 'username',
pass: 'password',
ssl: true,
sslStrict: true,
sslCa: fs.readFileSync(__dirname + '/myca.cert')
});