# node-red-contrib-statsd

> Node-red output to a StatsD server

Latest version **1.3.0** (published 2019-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-red-contrib-statsd
pnpm add node-red-contrib-statsd
yarn add node-red-contrib-statsd
bun add node-red-contrib-statsd
```

## 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.3.0 |
| Published | 2019-07-26 |
| First published | 2017-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 140.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Loren West - github.com/lorenwest |
| Maintainers | lorenwest |
| Keywords | node-red, statsd |

## Links

- npm: https://www.npmjs.com/package/node-red-contrib-statsd
- Repository: https://github.com/microclimates/node-red-contrib-statsd
- Issues: https://github.com/microclimates/node-red-contrib-statsd/issues
- npm.io page: https://npm.io/package/node-red-contrib-statsd

## Dependencies (1)

- [node-statsd](https://npm.io/package/node-statsd.md) ~0.1.1

## Recent versions

- 1.3.0 (latest) — 2019-07-26
- 1.2.3 — 2018-01-25
- 1.2.2 — 2018-01-25
- 1.2.1 — 2018-01-25
- 0.1.0 — 2017-02-08

## README

# Time-series output through StatsD for node-red topics

The [Node-Red](http://nodered.org/) project is a visual tool for wiring the Internet of Things.

This package is Node-Red contribution for sending flows to a
[StatsD server](https://github.com/etsy/statsd).

Here's an example flow that places the output of an MQTT topic into a StatsD server:

![](https://raw.githubusercontent.com/microclimates/node-red-contrib-statsd/master/img/example-flow.png)

## Prerequisites

1. A StatsD server running in your network.
1. Node.js installed
    - [Windows / OSX / Linux](https://nodejs.org/en/download/)
    - [Raspberry Pi](http://nodered.org/docs/hardware/raspberrypi.html)
    - [BeagleBone Black](http://nodered.org/docs/hardware/beagleboneblack.html)

## Installation

1. Install Node-RED: `npm install -g node-red`
1. Install Statsd package
    1. `mkdir -p ~/.node-red/node_modules`
    1. `npm install --prefix ~/.node-red node-red-contrib-statsd` 

## Usage

1. `node-red`
1. Open [http://localhost:1880](http://localhost:1880)
1. Add an input or function node that produces a numeric payload (an MQTT input topic works well)
1. Add the statsd node, and connect it to the flow above
1. Add configuration parameters:

![](https://raw.githubusercontent.com/microclimates/node-red-contrib-statsd/master/img/config.png)

## Updating

1. Update Node-RED: `npm update -g node-red`
1. Update Statsd package
    1. `npm update --prefix ~/.node-red node-red-contrib-statsd`

## License

MIT License. See [LICENSE.txt](https://raw.githubusercontent.com/microclimates/node-red-contrib-statsd/master/LICENSE.txt) for more details.

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