https://github.com/byteshiva/zipkin-js-es5
zipkin-js-es5
https://github.com/byteshiva/zipkin-js-es5
Last synced: 7 months ago
JSON representation
zipkin-js-es5
- Host: GitHub
- URL: https://github.com/byteshiva/zipkin-js-es5
- Owner: byteshiva
- License: mit
- Created: 2016-09-28T06:45:45.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-06-06T13:55:14.000Z (7 months ago)
- Last Synced: 2025-06-06T14:36:12.684Z (7 months ago)
- Language: JavaScript
- Size: 61.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/openzipkin/zipkin-js)
WARNING: This library is still a work in progress. You may encounter a few bugs!
# Zipkin.js
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.
## Installation:
`npm install zipkin --save`
## Instrumentations
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.
## Transports
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.
## Developing
The code base is a monorepo. We use [Lerna](https://lernajs.io/) 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`
## Publishing
Log in to npm with the "OpenZipkin" user. Then, run `npm run lerna-publish`.