# @blitt/good-influx

> InfluxDB broadcasting for Good process monitor

Latest version **0.0.8** (published 2017-07-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @blitt/good-influx
pnpm add @blitt/good-influx
yarn add @blitt/good-influx
bun add @blitt/good-influx
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2017-07-12 |
| First published | 2017-05-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Perkd |
| Maintainers | nicais, fabriece |

## Links

- npm: https://www.npmjs.com/package/@blitt/good-influx
- Repository: https://github.com/PerkdAS/perkd-good-influx
- Homepage: https://github.com/PerkdAS/perkd-good-influx#readme
- Issues: https://github.com/PerkdAS/perkd-good-influx/issues
- npm.io page: https://npm.io/package/@blitt/good-influx

## Dependencies (5)

- [hoek](https://npm.io/package/hoek.md) 4.x.x
- [wreck](https://npm.io/package/wreck.md) 12.x.x
- [good-udp](https://npm.io/package/good-udp.md) 4.x.x
- [good-http](https://npm.io/package/good-http.md) 6.x.x
- [fast-safe-stringify](https://npm.io/package/fast-safe-stringify.md) ^1.1.13

## Recent versions

- 0.0.8 (latest) — 2017-07-12
- 0.0.7 — 2017-07-12
- 0.0.6 — 2017-05-29
- 0.0.5 — 2017-05-23
- 0.0.4 — 2017-05-23
- 0.0.3 — 2017-05-14
- 0.0.2 — 2017-05-14
- 0.0.1 — 2017-05-14

## README

# @blitt/good-influx

[InfluxDB](https://docs.influxdata.com/) broadcasting for Good process monitor, based on [good-http](https://github.com/hapijs/good-http).
It can write to HTTP or UDP Telegraf endpoints.

`@blitt/good-influx` will format your Good data according to the [InfluxDB Line Protocol](https://docs.influxdata.com/influxdb/v1.1/write_protocols/line_protocol_tutorial/).

## Usage

`@blitt/good-influx` is a write stream used to send events to InfluxDB endpoints in batches. If your `endpoint` is `http://` or `https://`, it makes a "POST" request with a plain-text payload to the supplied `endpoint`. It will make a final "POST" request to the endpoint to flush the rest of the data on "finish".

If the supplied `endpoint` is a `udp://` endpoint then `@blitt/good-influx` will send the stats via UDP.  This may improve application performance since UDP does not wait for a response.  Though it does fail silently, so you run the risk that your stats are failing to record and you don't know about it.

### Example

```javascript
const Hapi = require('hapi');
const server = new Hapi.Server();
server.connection();

const options = {
	ops: {
	    interval: 1000
	},
    reporters: {
    	// Send only 'ops' events to InfluxDB
        influx: [{
            module: 'good-squeeze',
            name: 'Squeeze',
            args: [{ ops: '*' }]
        }, {
            module: '@blitt/good-influx',
            args: ['http://localhost:8086/write?db=good', {
                threshold: 10,
                metadata: {
                    serviceName: 'SuperAwesomeService'
                }
        	}]
        }]
    }
};

server.register({
    register: require('good'),
    options: options
}, (err) => {

    if (err) {
        console.error(err);
    } else {
        server.start(() => {
            console.info('Server started at ' + server.info.uri);
        });
    }
});
```


## Good Influx
### GoodInflux (endpoint, config)

Creates a new GoodInflux object where:

- `endpoint` - full path to remote server's InfluxDB HTTP API end point to transmit InfluxDB statistics (e.g. `http://localhost:8086/write?db=good`)
- `config` - configuration object *(Optional)*
  - `[threshold]` - number of events to hold before transmission. Defaults to `20`. Set to `0` to have every event start transmission instantly. It is recommended to have a set threshold to make data transmission more efficient.
  - `[errorThreshold]` - number of erroring message sends to tolerate before the plugin fails.  Default is 0.
  - `[wreck]` - configuration object to pass into [`wreck`](https://github.com/hapijs/wreck#advanced). Defaults to `{ timeout: 60000, headers: {} }`. `content-type` is always "text/plain".
  - `[udpType]` - UDP type; defaults to `udp4`. Probably not necessary to change, but more documentation is available on the [NodeJS Dgram Documentation](https://nodejs.org/api/dgram.html#dgram_dgram_createsocket_type_callback)
  - `[metadata]` - arbitrary information you would like to include in your InfluxDB stats.  This helps you query InfluxDB for the statistics you want.

## Series

### Error

time | host | pid | error | id | method | url
-----|------|-----|-------|----|--------|----

### Log

time | host | pid | data | tags
-----|------|-----|------|-----

### Ops

time | host | pid | os | proc | metadata _(optional)_
-----|------|-----|----|------|-----------

- os includes: `cpu1m`, `cpu5m`, `cpu15m`, `freemem`, `totalmem` and `uptime`
- proc includes: `delay`, `heapTotal`, `heapUsed`, `rss` and `uptime`
- metadata _(optional)_ includes any decorators you may have added as part of the `metadata` config option above.

### Request

time | host | pid | data | id | method | path | tags
-----|------|-----|------|----|--------|------|-----

### Response

time | host | pid | httpVersion | id | instance | labels | method | path | query |
-----|------|-----|-------------|----|----------|--------|--------|------|-------|

referer | remoteAddress | responseTime | statusCode | userAgent
---------|---------------|--------------|------------|----------

## License

[MIT](LICENSE.txt)

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