Home Reference Source Repository

libhoney Build Status npm version

A node module for interacting with Honeycomb. (For more information, see the documentation and JavaScript SDK guide.)

NOT for use in browser-side JavaScript applications. Write keys are your auth tokens for sending data to Honeycomb and should be kept secure -- they're not per-site keys. Don't leave yourself vulnerable to malicious users.

Installation

npm install libhoney --save-dev

Documentation

An API reference is available at https://doc.esdoc.org/github.com/honeycombio/libhoney-js/

Example

Honeycomb can calculate all sorts of statistics, so send the values you care about and let us crunch the averages, percentiles, lower/upper bounds, cardinality -- whatever you want -- for you.

import Libhoney from 'libhoney';

let hny = new Libhoney({
  writeKey: "YOUR_WRITE_KEY",
  dataset: "honeycomb-js-example"
});

hny.sendNow({
  message: "Test Honeycomb event",
  randomFloat: Math.random(),
  hostname: os.hostname(),
  favoriteColor: "chartreuse"
});

For more, see the examples/ directory for sample code demonstrating how to use events, builders, fields, and dynamic fields in an Express app.

Contributions

Features, bug fixes and other changes to libhoney are gladly accepted. Please open issues or a pull request with your change. Remember to add your name to the CONTRIBUTORS file!

All contributions will be released under the Apache License 2.0.