npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

express-zipkin-instrumentation

v1.1.1

Published

Convenience package for instrumenting an Express application with Zipkin request tracing used in the MCF project.

Downloads

3

Readme

Zipkin Instrumentation for Express

Build Status

Installation

npm add express-zipkin-instrumentation --save;

Usage

Basic

const server = express();
// ...
const expressZipkinInstrumentation = require('express-zipkin-instrumentation');
server.use(expressZipkinInstrumentation(
  'service-name',
  'http://zipkin.yourdomain.com',
));

The above will result in a service identified in the Zipkin dashboard as service-name.

Complete

const server = express();
// ...
const expressZipkinInstrumentation = require('express-zipkin-instrumentation');
server.use(expressZipkinInstrumentation(
  'service-name',
  'http://zipkin.yourdomain.com',
  {
    serviceNamePostfix: 'development'
  }
))

The above will result in a service identified in the Zipkin dashboard as service-name-development.

The API

.constructor()

Using the following to include the package:

const expressZipkinInstrumentation = require('express-zipkin-instrumentation');

The expressZipkinInstrumentation variable will be a function that returns the correct middleware. The arguments are:

  • :serviceName
    • identifies the current application in the zipkin dashboard.
  • :zipkinHostname
    • the hostname for the zipkin server. When this is set to null (the default behaviour if this is not specified), the trace logs will be routed to stdout instead via console.trace.
  • :options (optional)
    • an object that can contain the following properties:
      • :serviceNamePostfix: this will be appended to the :serviceName parameter in dashed-case.
const expressZipkinInstrumentation = require('express-zipkin-instrumentation');
const server = require('express')();
server.use(expressZipkinInstrumentation(/* ... */));
// ...

.getContext()

Retrieves the context used to initialise the zipkin instrumentation.

const expressZipkinInstrumentation = require('express-zipkin-instrumentation');
const server = require('express')();
server.use(expressZipkinInstrumentation(/* ... */));
expressZipkinInstrumentation.getContext();
// ...

.getInstance()

Retrieves the zipkin instrumentation instance.

const expressZipkinInstrumentation = require('express-zipkin-instrumentation');
const server = require('express')();
server.use(expressZipkinInstrumentation(/* ... */));
expressZipkinInstrumentation.getInstance();
// ...

.getParentId()

Retrieves the parent trace ID of the current request.

const expressZipkinInstrumentation = require('express-zipkin-instrumentation');
const server = require('express')();
server.use(expressZipkinInstrumentation(/* ... */));
server.use((req, res, next) => {
  console.info(expressZipkinInstrumentation.getParentId()); // matches /[0-9a-f]{16}/gi
  next();
});
// ...

Throws an error if expressZipkinInstrumentation(/* ... */) was not called yet.

.getRecorder()

Retrieves the recorder used to initialise the zipkin instrumentation.

const expressZipkinInstrumentation = require('express-zipkin-instrumentation');
const server = require('express')();
server.use(expressZipkinInstrumentation(/* ... */));
expressZipkinInstrumentation.getRecorder();
// ...

.getSpanId()

Retrieves the span ID of the current request.

const expressZipkinInstrumentation = require('express-zipkin-instrumentation');
const server = require('express')();
server.use(expressZipkinInstrumentation(/* ... */));
server.use((req, res, next) => {
  console.info(expressZipkinInstrumentation.getSpanId()); // matches /[0-9a-f]{16}/gi
  next();
});
// ...

Throws an error if expressZipkinInstrumentation(/* ... */) was not called yet.

.getTraceId()

Retrieves the trace ID of the current request.

const expressZipkinInstrumentation = require('express-zipkin-instrumentation');
const server = require('express')();
server.use(expressZipkinInstrumentation(/* ... */));
server.use((req, res, next) => {
  console.info(expressZipkinInstrumentation.getTraceId()); // matches /[0-9a-f]{16}/gi
  next();
});
// ...

Throws an error if expressZipkinInstrumentation(/* ... */) was not called yet.

Development

Testing

Run tests using:

npm run test

To run them in watch mode:

npm run test-watch

Continuous Integration

Environment Variables

The following environment variables have to be set in Travis for the pipeline to work

  • GH_USERNAME: GitHub username
  • GH_ACCESS_TOKEN: GitHub personal access token
  • NPM_PACKAGE_PUBLISH_NAME: Package name to publish this as
  • NPM_REGISTRY_URL: Hostname of NPM registry being used
  • NPM_TOKEN: NPM access token
  • GIT_ORIGIN_REMOTE_PATH: Path to repository in GitHub

License

This package is licensed under the MIT license.