/hot-shots-posix

A fork of https://github.com/brightcove/hot-shots with additional support for POSIX-compliant systems

Primary LanguageJavaScriptMIT LicenseMIT

hot-shots-posix

NOTE: This package is deprecated. hot-shots should support UDS going forward.

A StatsD client forked from https://github.com/brightcove/hot-shots with additional support for POSIX-compliant systems.

npm version

API Documentation and usage

Quick Start

const StatsD = require('hot-shots-posix');

// Create the client
const client = new StatsD({
  path: '/path/to/uds',
  protocol: 'unix_dgram',
  errorHandler: (err) => {
    console.error(err);
  }
});

// Start emitting metrics.
client.increment('my.stat');
client.decrement('my.stat');

Requirements

  • Node.js >= 6.0.0

Development

To bootstrap your development environment:

  1. Clone hot-shots-posix
  2. Run npm install

Tests

  • npm run test - runs all tests
  • npm run test-unit - runs unit tests
  • npm run test-integration - runs integration tests
  • npm run lint - runs linter

License

hot-shots-posix is licensed under the MIT license.