Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 1.39 KB

README.md

File metadata and controls

64 lines (43 loc) · 1.39 KB

Banner

vidi-metrics-emitter

Wrapper to emit metrics to vidi from javascript code

  • Work in progress This module is currently a work in progress.

Install

To install the system locally, simply clone the repo,

git clone https://github.com/vidi-insights/vidi-metrics-emitter

Running as a plugin

Emitter takes JSON message adds time stamp, sends to newly created server and closes connection. To use as a plugin, install via npm:

npm install vidi-metrics-emitter

and use in your code :

var Emitter = require("vidi-metrics-emitter")
...
emitter.emit(goodJson)
...

Demo

To run demo version simply use.

npm run demo

It will create a dummy UDP server, when receives message sends it out through emitter.

Contributing

The nearForm organization encourages open and safe participation.

If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please get in touch.

License

Copyright (c) 2016, Jane Quinn and other contributors. Licensed under MIT.