Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/segment-boneyard/metrics
Simple and pluggable business metrics
https://github.com/segment-boneyard/metrics
Last synced: about 5 hours ago
JSON representation
Simple and pluggable business metrics
- Host: GitHub
- URL: https://github.com/segment-boneyard/metrics
- Owner: segment-boneyard
- Created: 2014-03-07T03:09:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-09-10T06:37:22.000Z (about 9 years ago)
- Last Synced: 2024-11-11T12:51:57.281Z (4 days ago)
- Language: JavaScript
- Homepage:
- Size: 813 KB
- Stars: 91
- Watchers: 9
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: Readme.md
- Changelog: History.md
Awesome Lists containing this project
README
[](https://circleci.com/gh/segmentio/metrics)
# metrics
Simple and _pluggable_ business **metrics**. It makes internal reporting _much_ easier.
[Segment](https://segment.com) uses **metrics** as an internal API to power our dashboards, auto-updating spreadsheets, and other admin services.
```js
var Metrics = require('metrics');
Metrics()
.every('5m', charges('stripe-key'))
.every('10m', subscriptions('stripe-key'))
.every('1h', helpscout('helpscout-key'))
.use(function (metrics) {
metrics.on('stripe mrr', function (metric) {
geckoboard('widget-id').number(metric.latest()));
});
});
```
Plugins add their own metrics using keys like `stripe charges last 30 days`. Each company can customize their reporting by writing their own [plugins](#plugins).
The code above calculates revenue and support metrics that can then be visualized with a dashboard, like [Geckoboard](https://geckoboard.com):
**It's easy to get started:** there's already plugins for [Stripe][1], [Helpscout][2], [AWS][3], [Close.io][9] and its super easy to build your own.
**It separates data and views:** separate raw data from how its presented.
**It helps your team achieve consistency:** instead of defining KPIs using whatever source is easiest (like your database, Google Analytics, KISSMetrics, etc), you use one source and stay consistent.
**It's dashboard agnostic:** so you can use [Geckoboard][4], [Ducksboard][5], [Leftronic][6], or your own internal dashboard.
**Its an internal metrics API:** [Segment](https://segment.com) uses the [metrics-express](https://github.com/segmentio/metrics-express) plugin to serve our metrics to other internal services (like admin tools and auto-updating spreadsheets).
[1]: https://github.com/segmentio/metrics-stripe-charges
[2]: https://github.com/segmentio/metrics-helpscout
[3]: https://github.com/segmentio/metrics-aws-billing
[4]: http://www.geckoboard.com/
[5]: https://ducksboard.com/
[6]: https://www.leftronic.com/
[7]: https://segment.com/
[8]: https://segment.com/academy/dashboard-metrics-that-actually-work/
[9]: https://github.com/rarestep/metrics-closeio
## Installation
$ npm install segmentio/metrics
## How does it work?
**Metrics** is super simple. Plugins write data into a key value store, and other plugins then send that data to dashboards or other reporting tools.
A plugin can learn about how much you're making on Stripe, and make that data available:
```js
var stripe = require('stripe')(key);
module.exports = function (metrics) {
stripe.charges.list(function (err, charges) {
metrics.set('stripe charges', charges.length);
});
};
```
and another plugin can push the data to a geckoboard:
```js
var geckoboard = require('geckobard')('api-key');
module.exports = function (metrics) {
metrics.on('stripe charges', function (metric) {
geckoboard('widget-id').number(metric.latest());
});
}
```
and now you have your first dashboard.
```js
Metrics()
.every('5m', charges)
.use(dashboard);
```
## Plugins
Existing plugins for metrics can tell you:
- [metrics-aws-billing](https://github.com/segmentio/metrics-aws-billing) - how much your AWS hosting costs
- [metrics-helpscout](https://github.com/segmentio/metrics-helpscout) - how many active [Helpscout](http://helpscout.com) support tickets you have, and who they're assigned to
- [metrics-stripe-charges](https://github.com/segmentio/metrics-stripe-charges) - how much money you're making every month (and today!)
- [metrics-stripe-subscriptions](https://github.com/segmentio/metrics-stripe-charges) - how much subscriptions you have, and how much recurring revenue you're generating
- [metrics-express](https://github.com/segmentio/metrics-express) - serves your metrics as an HTTP API using an express subapp
- [metrics-closeio](https://github.com/rarestep/metrics-closeio) - information about your leads and opportunities in [Close.io](http://close.io/)
It's normal for every company to care about different metrics. If your plugin can help others do easier reporting, pull request this [Readme.md](https://github.com/segmentio/metrics/blob/master/Readme.md) to add your own plugin to this list.
## API
At its core, **metrics** is a simple key value store. Plugins put data into a hashtable, and other plugins then use that data to update dashboards, send emails, or really anything you want.
#### new Metrics()
Create a new `Metrics` instance.
#### .set(key, value, timestamp)
Set a `key` / `value` pair at a `timestamp` for a [Metric](#new-metric). If no `timestamp` is provided, current time is assumed.
#### .get(key)
Get a [Metric](#new-metric) at `key`.
#### .keys()
Get a list of keys.
#### .every(interval, plugin)
Add a metrics plugin to run on an `interval`.
```js
var metrics = new Metrics()
.every('5m', function (metrics) {
metrics.set('mrr', 1000);
metrics.set('arr', 1000*12);
});
```
#### .on(keys.., cb)
Listen for when one or more keys become available.
```js
var metrics = new Metrics()
.every('5m', function (metrics) {
metrics.set('mrr', 1000);
metrics.set('arr', 1000*12);
});
metrics.on('mrr', 'arr', function (mrr, arr) {
console.log('mrr update: ' + mrr.latest() + ', arr: ' + arr.latest());
});
```
#### .use(plugin)
Add a plugin that consumes metrics data.
```js
new Metrics()
.every('5m', function (metrics) {
metrics.set('mrr', 1000);
metrics.set('arr', 1000*12);
})
.use(function (metrics) {
metrics.on('mrr', 'arr', function (mrr, arr) {
console.log('mrr update: ' + mrr.latest() + ', arr: ' + arr.latest());
});
});
```
#### new Metric()
A `Metric` instance wraps a single metric `key`.
```js
var m = new Metric()
.set(42, new Date(1388563200000))
.set(57, new Date(1389168000000));
m.latest()
// 57
```
#### .set(value[, timestamp])
Set a metric `value` at a `timestamp`. If there's no `timestamp` provided, the current time will be used.
```js
var m = new Metric().set(68);
m.latest();
// 68
```
#### .timestamps()
Return an array of timestamps for which this timestamp has recorded values.
```js
[
ISODate('Wed Jan 07 2015 12:14:16 GMT-0800 (PST)'),
new Date('Tue Jan 06 2015 12:14:16 GMT-0800 (PST)')
]
```
#### .values()
Return a map of the timestamps to values that are recorded for this metric.
```js
{
'1420661709503': 35
'1420660609503': 24
}
```
#### .latest()
Get the latest recorded metric value.
#### .from(date)
Return the value from `date`, accepting any valid [date.js](https://github.com/MatthewMueller/date#examples) input or a `Date` object.
```js
m.from(new Date('1/4/2015'))
m.from('now')
m.from('10 minutes from now')
m.from('at 5pm')
m.from('at 12:30')
m.from('at 23:35')
m.from('tuesday at 9am')
m.from('monday at 1:00am')
m.from('last monday at 1:00am')
m.from('yesterday at 12:30am')
m.from('2 weeks from wednesday')
m.from('tomorrow night at 9')
m.from('tomorrow afternoon')
m.from('this morning at 9')
m.from('2 years from yesterday at 5pm')
m.from('last month')
m.from('at 12:30')
m.from('tuesday at 9')
m.from('tomorrow at 15')
```
You can also pass a second optional argument `window` to `.from(date, window)`. The `window` controls the distance by which a timestamp can differ from the desired `date` to still be acceptible.
For example, `metric.from('2 months ago', 1000*60*60*24)` says that we want the metric value from `2 months ago` but we'll accept anything from `2 months ago - 1 day` to `2 months ago + 1 day`.
## License
```
WWWWWW||WWWWWW
W W W||W W W
||
( OO )__________
/ | \
/o o| MIT \
\___/||_||__||_|| *
|| || || ||
_||_|| _||_||
(__|__|(__|__|
```