Honeycomb Beeline for NodeJS

Note: Honeycomb embraces OpenTelemetry as the effective way to instrument applications. For any new observability efforts, we recommend instrumenting with OpenTelemetry.

This package makes it easy to instrument your Express/NodeJS application to send useful events to Honeycomb, a service for debugging your software in production.

• Usage and Examples
• API Reference

Dependencies

• Node 14+

Known Issues

• Using a bundler (esbuild, webpack, etc.) or ESM with the Beeline is unsupported. You may be able to use the Beeline in those cases, but auto-instrumentations will likely not work.

• An error like 'api.traceActive is not a function' error may occur for some auto-instrumentation and can be resolved by manually requiring https before requiring other libraries such as request-promise.

Contributions

Features, bug fixes and other changes to beeline-nodejs 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.

Running postgresql tests locally

If you don't have postgresql running locally, you can launch postgresql in docker.

docker run -p 5432:5432 -e POSTGRES_USER=root circleci/postgres:9-alpine-ram

Then run the tests using

PGUSER=root PGDATABASE=postgres npm test