influx-write

This is a simplified InfluxDB v2+ client for node designed to write measurements as unobtrusively as possible. It has zero dependencies.

Unlike the official client, this one batches many measurement writes into a single HTTP request made on a configurable interval (or manually). If a HTTP request fails, it will hold the measurements in a small buffer until they can be sent to Influx.

This borrows the Point class from the official client, so this library should be a drop-in replacement for the official one.

Installation

npm install influx-write

Quick Start

import { InfluxWriter, Point } from 'influx-write';

// Create client
const client = new InfluxWriter({
  host: 'https://us-west-2-1.aws.cloud2.influxdata.com',
  token: 'your-token',
  database: 'my-database'
});

// Write data
client.write(new Point('temperature')
  .tag('location', 'server-room')
  .floatField('value', 23.5)
  .timestamp(Date.now()));

// Gracefully close
await client.close();

Configuration Options

The InfluxWriter constructor accepts the following options:

| Option | Type | Default | Description | |--------|------|---------|-------------| | host | string | required | The InfluxDB host URL (e.g., 'https://us-west-2-1.aws.cloud2.influxdata.com'). Must include the protocol (http:// or https://). | | token | string | required | InfluxDB authentication token for API access. | | database | string | required | The target database/bucket name where data will be written. | | agent | http.Agent | auto-created | Custom HTTP agent for connection pooling and keep-alive settings. | | flushInterval | number | 1000 | Interval in milliseconds for automatic flushing of buffered data. | | compressThreshold | number | 1024 | If there are more than this number of bytes to send in a single request, the data will be gzipped. | | maxBuffer | number | 1000 | Maximum number of data points to buffer in memory. | | timeout | number | 5000 | Request timeout in milliseconds for HTTP requests to InfluxDB. | | autoFlush | boolean | true | Whether to regularly flush measurements to InfluxDB. |

Writing Data

The write() method accepts multiple data formats. It is guaranteed to not throw.

Single Point Object

client.write(new Point('temperature')
  .tag('location', 'server-room')
  .floatField('value', 23.5)
  .timestamp(Date.now()));

Line Protocol String

client.write('temperature,location=server-room value=23.5');

Multiple Points

client.write([
  new Point('temperature').tag('location', 'room1').floatField('value', 20.0),
  new Point('temperature').tag('location', 'room2').floatField('value', 22.0)
]);

Array of Line Protocol Strings

client.write([
  'measurement1,tag=value field=123 1234567890',
  'measurement2,tag=value field=456 1234567891'
]);

Manual Flushing

By default, data is automatically flushed from the internal buffer at the configured interval. You can also flush manually:

// Flush buffered data immediately
await client.flush();

Graceful Shutdown

Always close the client to ensure all buffered data is sent:

// Write some final data
client.write(new Point('shutdown').stringField('status', 'complete'));

// Close and wait for completion
await client.close();
console.log('Client closed, all data sent');

Error Handling

The client includes built-in error handling:

• Failed requests are automatically retried by re-adding data to the buffer.
• If the buffer exceeds maxBuffer size during errors, old data is discarded to prevent unbounded growth.