WARNING: This library is still a work in progress. You may encounter a few bugs!
This is a library for instrumenting Node.js applications. It uses a lot of new JavaScript features and syntax, so Node.js version 6 or newer is required.
npm install zipkin --save
Various Node.js libraries have been instrumented with Zipkin support. Every instrumentation has an npm package called zipkin-instrumentation-*.
At the time of writing, zipkin-js instruments these libraries:
- cujojs/rest (zipkin-instrumentation-cujojs-rest)
- express (zipkin-instrumentation-express)
- restify (zipkin-instrumentation-restify)
- fetch (zipkin-instrumentation-fetch)
- memcached (zipkin-instrumentation-memcached)
Every module has a README.md file that describes how to use it.
You can choose between multiple transports; they are npm packages called zipkin-transport-*, where * is e.g. "http", "kafka" or "scribe". Every package has its own README.md which describes how to use it.
The code base is a monorepo. We use Lerna for managing inter-module
dependencies, which makes it easier to develop coordinated changes between the modules.
Instead of running lerna directly, the commands are wrapped with npm; npm run lerna-bootstrap
and npm run lerna-publish.
To setup the development environment, run:
npm install
npm run lerna-bootstrap
Running tests: npm test
Note that the memcached integration test requires you to have a local memcached instance running. The Kafka integration test will start an embedded Kafka server for the test, which requires you to have Java installed on your machine.
Running code style linting: npm run lint
Log in to npm with the "OpenZipkin" user. Then, run npm run lerna-publish.