# metrics-influxdb

> InfluxDB backend integration for metrics

Latest version **1.0.3** (published 2022-02-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install metrics-influxdb
pnpm add metrics-influxdb
yarn add metrics-influxdb
bun add metrics-influxdb
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-02-11 |
| First published | 2015-11-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 45.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Brandon Hamilton |
| Maintainers | brandonhamilton |
| Keywords | metrics, influxdb |

## Links

- npm: https://www.npmjs.com/package/metrics-influxdb
- Repository: https://github.com/brandonhamilton/node-metrics-influxdb
- Homepage: https://github.com/brandonhamilton/node-metrics-influxdb#readme
- Issues: https://github.com/brandonhamilton/node-metrics-influxdb/issues
- npm.io page: https://npm.io/package/metrics-influxdb

## Dependencies (1)

- [metrics](https://npm.io/package/metrics.md) ^0.1.21

## Recent versions

- 1.0.3 (latest) — 2022-02-11
- 1.0.1 — 2019-04-05
- 1.0.0 — 2017-11-21
- 0.3.1 — 2017-11-14
- 0.3.0 — 2017-10-02
- 0.2.2 — 2017-09-21
- 0.2.1 — 2017-09-18
- 0.2.0 — 2017-09-18
- 0.1.1 — 2017-06-19
- 0.1.0 — 2017-04-28
- 0.0.7 — 2016-05-11
- 0.0.6 — 2015-12-06
- 0.0.5 — 2015-11-27
- 0.0.4 — 2015-11-25
- 0.0.3 — 2015-11-24
- … 2 more at https://npm.io/package/metrics-influxdb/versions

## README

# InfluxDB reporter for metrics

[![Build Status](https://travis-ci.org/brandonhamilton/node-metrics-influxdb.svg)](https://travis-ci.org/brandonhamilton/node-metrics-influxdb)
[![Dependency Status](https://david-dm.org/brandonhamilton/node-metrics-influxdb.svg)](https://david-dm.org/brandonhamilton/node-metrics-influxdb)
[![devDependency Status](https://david-dm.org/brandonhamilton/node-metrics-influxdb/dev-status.svg)](https://david-dm.org/brandonhamilton/node-metrics-influxdb#info=devDependencies)

A node.js InfluxDB v0.9 and higher reporting backend for [metrics](https://www.npmjs.com/package/metrics). (Tested at least with InfluxDB 0.9 and 0.12.)

# Installation

    $ npm install metrics-influxdb

## Usage

```javascript
"use strict";

var InfluxMetrics = require('metrics-influxdb');

var reporter = new InfluxMetrics.Reporter({ protocol: 'udp', tags: { 'server': 'one' } });
var c = new InfluxMetrics.Counter();
reporter.addMetric('test.counter', c);
c.inc();

var g = new InfluxMetrics.Gauge();
reporter.addMetric('test.gauge', g);
g.set(10);

var h = new InfluxMetrics.Histogram();
reporter.addMetric('test.histogram', h);
h.update(50);

var m = new InfluxMetrics.Meter();
reporter.addMetric('test.meter', m);
m.mark(1);

var t = new InfluxMetrics.Timer();
reporter.addMetric('test.timer', t);
t.update(50);

reporter.report(); // Send metrics to InfluxDB
reporter.report(false); // Force flush of all metrics in buffer

reporter.start(1000) // Schedule report to be run every 1000 ms (also available through options)
reporter.stop() // Stop scheduled reporter 
```

## Configuration

The ``options`` object accepts the following fields:

<table>
  <tr>
    <th>Parameter</th><th>Type</th><th>Default</th><th>Description</th>
  </tr>
  <tr>
    <th>host</th>
    <td>string</td>
    <td><code>127.0.0.1</code></td>
    <td>InfluxDB host</td>
  </tr>
  <tr>
    <th>port</th>
    <td>number</td>
    <td><code>8089</code>(<code>udp</code>) / <code>8086</code>(<code>http</code>)</td>
    <td>InfluxDB port</td>
  </tr>
  <tr>
    <th>protocol</th>
    <td>string</td>
    <td><code>udp</code></td>
    <td>InfluxDB protocol (<code>udp</code> / <code>http</code> / <code>https</code>)</td>
  </tr>
  <tr>
    <th>tags</th>
    <td>object</td>
    <td><code>{}</code></td>
    <td>Tags to add to influxdb measurements</td>
  </tr>
  <tr>
    <th>tagger</th>
    <td>function</td>
    <td><code>none</code></td>
    <td>Function invoked with the metric key and expected to return the tags for
    it in the form <code>{tag1: value1, tag2: value2, ...}</code>
        </td>
  </tr>
  <tr>
    <th>namer</th>
    <td>function</td>
    <td><code>identity</code></td>
    <td>Function invoked with the metric key and expected to return the desired name of the metric in InfluxDB</code>
        </td>
  </tr>
  <tr>
    <th>metricReportedHook</th>
    <td>function</td>
    <td><code>none</code></td>
    <td>Function invoked with `(metric key, Metric)` after it has been reported - so that the user can f.ex. `.clear()` counters.</td>
  </tr>
  <tr>
    <th>fieldFilter</th>
    <td>function</td>
    <td><code>none</code></td>
    <td>Function invoked with `(metric key, Metric, fieldName, fieldValue)`. The field is only sent to InfluxDB if the function returns `true` for it.</td>
  </tr>
  <tr>
    <th>precision</th>
    <td>string</td>
    <td><code>ms</code></td>
    <td><code>n</code>/<code>u</code>/<code>ms</code>/<code>s</code>/<code>m</code>/<code>h</code></td>
  </tr>
  <tr>
    <th>bufferSize</th>
    <td>number</td>
    <td><code>0</code></td>
    <td>Number of points to keep before sending to InfluxDB</td>
  </tr>
  <tr>
    <th>scheduleInterval</th>
    <td>number</td>
    <td><code>null</code></td>
    <td>This is the time in ms to flush any buffered metrics</td>
  </tr>
  <tr>
    <th>skipIdleMetrics</th>
    <td>boolean</td>
    <td><code>false</code></td>
    <td>Suppress sending of metrics if there has been no new updates from previous report</td>
  </tr>
  <tr>
    <th>callback</th>
    <td>function</td>
    <td><code>none</code></td>
    <td>A standard Node callback invoked with the result of the InfluxDB call (nothing or an `Error`).</td>
  </tr>
</table>

The <code>udp</code> protocol accepts the following additional options:
<table>
  <tr>
    <th>Parameter</th><th>Type</th><th>Default</th><th>Description</th>
  </tr>
  <tr>
    <th>maxPacketSize</th>
    <td>integer</td>
    <td><code>1024</code></td>
    <td>Maximum safe UDP packet size to use</td>
  </tr>
</table>

The <code>http</code> and <code>https</code> protocols accept the following additional options:
<table>
  <tr>
    <th>Parameter</th><th>Type</th><th>Default</th><th>Description</th>
  </tr>
  <tr>
    <th>username</th>
    <td>string</td>
    <td><code>null</code></td>
    <td>InfluxDB username</td>
  </tr>
  <tr>
    <th>password</th>
    <td>string</td>
    <td><code>null</code></td>
    <td>InfluxDB password</td>
  </tr>
  <tr>
    <th>database</th>
    <td>string</td>
    <td><code>null</code></td>
    <td>InfluxDB database</td>
  </tr>
  <tr>
    <th>consistency</th>
    <td>string</td>
    <td><code>null</code></td>
    <td><code>one</code>/<code>quorum</code>/<code>all</code>/<code>any</code></td>
  </tr>
  <tr>
    <th>httpTimeout</th>    
    <td>number</td>
    <td><code>200</code></td>
    <td>http Timeout ms</td>
  </tr>
  <tr>
    <th>httpAgent</th>    
    <td>object</td>
    <td><code>undefined</code></td>
    <td>https Agent configuration</td>
  </tr>
</table>

</table>

## A more complex example

```javascript
const InfluxMetrics = require('metrics-influxdb');
const options = {
    host: "my.influxdb.example.com",
    port: 8086,
    protocol: "http",
    username: "the monitor",
    password: "super sercret",
    database: "app_metrics",
    tags: {
        app: "my-awesome-app",
        environment: "production"
    },
    callback(error) {
        if (error) {
            console.log("Sending data to InfluxDB failed: ", error);
        }
    },
    /* Given a key like "type=system.area=memory.metric=heapUsed"
     * produce `{ type: "system", area: "memory", metric: "heapUsed" }`
     * so that these tags will be stored with the measure in InfluxDB
     */
    tagger: (metricKey) => _.chain(metricKey.split("."))
        .map((tagVal) => {
            const [_str, key, val] = tagVal.match(/(\w+)=(.+)/) || [];
            if (!key || !val) {
                console.log(`Expected format 'key=value[.key2=val2...]' but got the non-conforming part '${tagVal}'.`);
                return undefined;
            }
            else return [key, val];
        })
        .reject(_.isUndefined)
        .zipObject()
        /* Replace " ,=" - see https://docs.influxdata.com/influxdb/v0.13/write_protocols/write_syntax/#escaping-characters */
        .mapValues((value) => value.replace(/([ ,=])/g, "\\$1");)
        .value(),
    namer: (metricKey, tags) => {
        // We need a user-friendly name for the metrics ("measurements" in InfluxDB) that do not contain dots
        // as Grafana seems to have issues with those
        if (tags.type && tags.metric) {
            return tags.type + "_" + tags.metric;
        }
        return metricKey;
    },
    metricReportedHook: (key, metric) => {
        // Reset metrics as InfluxDB will do the aggregation and we should thus only send it new values
        metric.clear();
    },
    fieldFilter: (key, metric, fieldName, fieldValue) => {
        // Don't send unnecessary data to the DB to save CPU and disk space:
        // don't send 0s (likely many, since we clear metrics after send) and
        // various aggregated measures (percentiles etc.) since the DB will 
        // aggregate for us (well, as best as possible given 1 min-summarized data)
        if (metric.type === "histogram") {
            return metric.count > 0 && ["count", "min", "max", "mean", "median"].includes(fieldName);
        }
        if (metric.type === "timer") {
            return metric.duration.count > 0 && ["count", "min", "max", "mean", "median"].includes(fieldName);
        }
        if (metric.type === "counter") {
            return fieldValue > 0;
        }
        return true;
    }
};

const reporter = new InfluxMetrics.Reporter(options);

const h = new InfluxMetrics.Histogram();
reporter.addMetric('type=system.area=memory.metric=heapUsed', c);
h.update(process.memoryUsage().heapUsed);

reporter.start(1000);
```

## Credits

This module is based on [metrics-influxdb](https://github.com/dropwizard/metrics) by dropwizard.

## License

The MIT License (MIT)

Copyright (c) 2015 Brandon Hamilton

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---
_Source: https://npm.io/package/metrics-influxdb · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._