https://github.com/opencomponents/oc-statsd

OpenComponents statsd plugin
https://github.com/opencomponents/oc-statsd

oc-plugin opencomponents statsd

Last synced: about 2 months ago
JSON representation

OpenComponents statsd plugin

• Host: GitHub
• URL: https://github.com/opencomponents/oc-statsd
• Owner: opencomponents
• License: mit
• Created: 2016-05-20T15:52:56.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-05-19T04:00:49.000Z (about 6 years ago)
• Last Synced: 2024-04-30T18:48:32.815Z (2 months ago)
• Topics: oc-plugin, opencomponents, statsd
• Language: JavaScript
• Size: 18.6 KB
• Stars: 4
• Watchers: 22
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-oc - Statsd plugin - Plugin for integrating [StatsD](https://github.com/etsy/statsd) (Registry Plugins/Utilities)

README

        
oc-statsd [![Build Status](https://secure.travis-ci.org/opencomponents/oc-statsd.png?branch=master)](http://travis-ci.org/opencomponents/oc-statsd)

==========

[![Greenkeeper badge](https://badges.greenkeeper.io/opencomponents/oc-statsd.svg)](https://greenkeeper.io/)

[OpenComponents](https://github.com/opentable/oc) plugin for interacting with [StatsD](https://github.com/etsy/statsd) inside OC components.

# Requirements:

* Node version: min: **6**

* OC registry

* StatsD server

### Install

```js

npm i oc-statsd --save

```

### Registry setup

More info about integrating OC plugins: [here](https://github.com/opentable/oc/wiki/Registry#plugins)

```js

...

const registry = oc.registry(configuration);

registry.register({

  name: 'statsd',

  register: require('oc-statsd'),

  options: {

    host: 'statsd.hosts.com',

    prefix: 'oc-registry.prod.vm12345',

    port: 8125,

    debug: false

  }

}, (err) => {

  if(err){

    console.log('plugin initialisation failed:', err);

  } else {

    console.log('statsd now available');

  }

});

...

registry.start(callback);

```

### Using it inside components

Example for a components' server.js:

```js

module.exports.data = (context, callback) => {

  const before = new Date();

  const stats = context.plugins.statsd('mycomponent.doSomething');

  doSomething(() => {

    ...

    stats.timing('something.happened', new Date() - before);

    callback(null, { ... });

  });

};

```

### API

#### Api for plugin setup:

|parameter|type|mandatory|description|

|---------|----|---------|-----------|

|debug|`boolean`|no|Debug mode|

|host|`string`|yes|The statsd host|

|port|`number`|no|Default 8152, the statsd port|

|prefix|`string`|yes|The statsd prefix|

#### Api for plugin usage

The plugin name is declared when initialising a plugin. Following assumes `statsd` is the designated name.

##### context.plugins.statsd(namespace)

Gets instance of statsd client in the supplied namespace.

# Contributing

Yes please. Open an issue first.

### License

MIT