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

http-tracer-component

v1.0.0

Published

Add tracing spans to each request handler.

Downloads

7

Readme

HTTP Tracer component

This component uses the tracer component over the HTTP server component to build a middleware where each request gets wrapped into a trace span, making it traceable.

The middleware created by the component follows the Trace Context W3C Recommendation which defines how by using the traceparent and tracestate headers, a distributed tracing system can be implemented. It receives the traceparent and tracestate headers, sets them into the trace span context and then outputs them into the response header, following the specs in the W3C document.

Usage

The http tracer component is pretty straightforward to use, just initialize the tracer and HTTP server components and then create the HTTP tracer component with them:

import { createTracerComponent } from '@well-known-components/tracer-component'
import { createHttpTracerComponent } from '@well-known-components/http-tracer-component'

const tracer = createTracerComponent()
const server = await createServerComponent<GlobalContext>({ config, logs }, { cors })
createHttpTracerComponent({ server, tracer })

When inside of a handler, the code can access the trace span context at any time by using the tracer component API.

To complete the implementation of the W3C Trace Context tracing mechanism, it is required to propagate the trace headers to any request performed in the service to the other services that are consumed.

There are many ways to do this, but the easiest is to wrap the fetch function to always set the traceparent and tracestate headers:

const fetch = (url: string, init?: nodeFetch.RequestInit) => {
  const headers: nodeFetch.HeadersInit = { ...init?.headers }
  const traceParent = tracer.isInsideOfTraceSpan() ? tracer.getTraceChildString() : null
  if (traceParent) {
    ;(headers as { [key: string]: string }).traceparent = traceParent
    const traceState = tracer.getTraceStateString()
    if (traceState) {
      ;(headers as { [key: string]: string }).tracestate = traceState
    }
  }
  return realFetch(url, { ...init, headers })
}

As seen in the example above, each time a fetch is performed, the receiving service will receive the traceparent and tracestate headers. If the receiving services implement the Trace Context W3C Recommendation, the request will be traceable alongside the services that receive the request.