# statman-meter

> statman-meter is one of the metrics from the statman library. Loosely based upon codehale metric package, a meter provides count and average information over a period of time

Latest version **1.2.1** (published 2018-04-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install statman-meter
pnpm add statman-meter
yarn add statman-meter
bun add statman-meter
```

## 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.2.1 |
| Published | 2018-04-13 |
| First published | 2017-01-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 22.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | jasonray |
| Maintainers | jasonray |
| Keywords | metrics, statman |

## Links

- npm: https://www.npmjs.com/package/statman-meter
- Repository: https://github.com/jasonray/statman-meter
- Homepage: https://github.com/jasonray/statman-meter#readme
- Issues: https://github.com/jasonray/statman-meter/issues
- npm.io page: https://npm.io/package/statman-meter

## Dependencies (4)

- [should](https://npm.io/package/should.md) ^13.2.1
- [underscore](https://npm.io/package/underscore.md) ^1.8.3
- [string-template](https://npm.io/package/string-template.md) ^1.0.0
- [statman-stopwatch](https://npm.io/package/statman-stopwatch.md) ^2.7.0

## Recent versions

- 1.2.1 (latest) — 2018-04-13
- 1.2.0 — 2018-04-13
- 1.1.2 — 2018-04-12
- 1.1.1 — 2018-04-12
- 1.1.0 — 2018-04-06
- 1.0.2 — 2017-01-06
- 1.0.1 — 2017-01-06
- 1.0.0 — 2017-01-06
- 0.0.1 — 2017-01-06

## README

# statman-meter [![Build Status](https://travis-ci.org/jasonray/statman-meter.svg?branch=master)](https://travis-ci.org/jasonray/statman-meter) [![on npm](http://img.shields.io/npm/v/statman-meter.svg?style=flat)](https://www.npmjs.org/package/statman-meter)
statman-meter is one of the metrics from the statman library. Loosely based upon codahale metric package, a meter provides count and average information over a period of time.

This can be used to instrument call that may be expensive:
- incoming web service calls
- outbound calls to a subsystem
- expensive algorithms

# Install it!
## Option 1: access directly
Install using npm:
```
npm install statman-meter
```

Reference in your app:
```
var Meter = require('statman-meter');
var meter = Meter('meter-name');
```

## Option 2: access from `statman`
Install using npm:
```
npm install statman
```

Reference in your app:
```
var statman = require('statman');
var meter = statman.Meter('meter-name');
```

# Use it!
## Option 1: init, record values, read 
```
var meter = new Meter('webservice-calls');
meter.record(2000); //record that a call occurred for 2000 milliseconds
meter.record(4000); //record that a call occurred for 4000 milliseconds
meter.count();      //reports that there have been 2 calls 
meter.getAverage(); //reports that the average call is taking 3000 milliseconds
```

## Option 2: init, record stopwatch, read 
```
var meter = new Meter('webservice-calls');
var stopwatch = new Stopwatch();
stopwatch.start();
..
stopwatch.stop();
meter.record(stopwatch); //record that a call occurred and gets value from stopwatch.read()
meter.count();      //reports number of calls
meter.getAverage(); //reports the average timing of the calls
```

For more info on stopwatch, see (`statman-stopwatch`)[https://github.com/jasonray/statman-stopwatch]

## Option 3: init, start event, stop event
```
var meter = new Meter('webservice-calls');
var event = meter.startEvent();
..
var event = stop();
meter.count()       //reports number of calls
meter.getAverage(); //reports the average timing of the calls
```

# Build it!
- Make sure that you have `node` and `npm` installed
- Clone source code to you local machine
- Setup dependencies: `npm install`
- run tests: `npm test`

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