# jarmo

> Simple StatsD-like server.

Latest version **0.1.1** (published 2015-05-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install jarmo
pnpm add jarmo
yarn add jarmo
bun add jarmo
```

## 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.1.1 |
| Published | 2015-05-07 |
| First published | 2015-04-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | taneli.hartikainen@jamk.fi |
| Maintainers | tanelih |

## Links

- npm: https://www.npmjs.com/package/jarmo
- Repository: https://github.com/N4SJAMK/jarmo
- Issues: https://github.com/N4SJAMK/jarmo/issues
- npm.io page: https://npm.io/package/jarmo

## Dependencies (1)

- [babel](https://npm.io/package/babel.md) 5.1.11

## Recent versions

- 0.1.1 (latest) — 2015-05-07
- 0.1.0 — 2015-04-29

## README

<p align="center">
  <img src="http://i.imgur.com/8paRPGe.png" />
</p>

Jarmo is a simple StatsD-like server. This means that Jarmo can be used for
stats aggregation similarly to [StatsD](https://github.com/etsy/statsd).

However there are a few differences. Jarmo does not define any metric types,
instead it expects data to be sent in a `JSON` format. Jarmo merely parses the
received data as `JSON` and adds a `timestamp` to the data as it is received.

Jarmo runs a `flush cycle`, similarly to StatsD. Upon the end of each cycle,
all the received data is `flushed` to `reporters`, which in StatsD terms are
defined as `backends`.

## Configuration
The available configuration is listed below:

```javascript
  export default {
    reporters: [
      '../reporters/influxdb'
      // List the 'require':able paths of wanted reporters here...
    ],
    memoize:        false,  // Whether to 'cache' received data.
    port:           8000,   // Port to run the service on.
    flush_interval: 10000   // The interval between flushes (in milliseconds).
                            // If set to zero, received data will be flushed to
                            // reporters as soon as it is received.
  }
```

### Reporter Configuration
Each reporter defines a `name`, for example our `influxdb-reporter` is simply
called `influxdb` here. In order to pass configuration to `initialize` method
of the reporter, we add the configuration object with the key `influxdb` to our
configuration file, like so:

```javascript
  export default {
    influxdb: {
      // reporter configuration for 'influxdb' goes here!
    },
    reporters: [
      '../reporters/influxdb'
    ],
    host: 'localhost'
  }
```

### Reporter Interface
Reporters must be requireable using the NodeJS `require`. The exported module
must have a `flush` function, which unsurprisingly is called each time data is
to be flushed.

If a reporter defines an `initialize` function, it is called during the server
initialization phase after reporters have been loaded. It is given the config
hash keyed by its `name` in the server's configuration file.

## Running
```
npm install && npm start
```

## Sending Data
Jarmo expects simple JSON messages delivered via UDP.
```
echo "{\"foo\":\"bar\"}" | nc -u -w0 localhost 8000
```
Do note that Jarmo does not format your messages in any way. In fact it is the
`reporter` that is responsible for extracting the required data from the `JSON`
messages and reporting it to wherever.

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