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-server-timing-middleware

v2.0.15

Published

Express middleware to track server time spent on operations and write Server-Timing headers

Downloads

12

Readme

Build Status tested with jest codecov

express-server-timing-middleware

Express middleware to measure application performance and add Server-Timing headers to response

Motivation

  • To get more control over server side performance on the level of logging and monitoring.
  • To have ability to conditionally add Server-Timing headers based on request parameters
  • To be able to extract Server-Timing metrics for further logging

Usage

Add serverTiming middleware to your app router or subrouter
import express from 'express';

import { createServerTimingMiddleware } from 'express-server-timing-middleware';

// example controllers
import { createRenderController } from './controllers/app-render.controller';
import { shouldWriteDebugHeaders } from './utils';

const app = express();

app.use([
  serverTiming({
    // define if headers should be included into response.
    // Use boolean value or a function that should return true to include Server-Timing header
    writeHeaders: process.env.NODE_ENV !== 'production' || shouldWriteDebugHeaders,
  }),
  // any other middlewares
]);

app.get(/.*/, createRenderController());

app.listen(APP_PORT, (error) => {
  if (error) {
  } else {
    console.log(`Express app started on port ${APP_PORT}`);
  }
});
// utils.ts example
import type { Request } from 'express';

export const extractToken = (req: Request): string | undefined => {
  return req.header('my-secret-token');
};

export const checkTokenPermission = (token: string): boolean => {
  const parsedToken = decodeJWT(token);

  if (parsedToken === null) {
    return false;
  }
  return parsedToken.scopes.includes('my-secret-permission');
};

export const shouldWriteDebugHeaders = (req: Request) => {
  const token = extractTokenAndCheckPermissions(req);
  if (!token) {
    return false;
  }
  const hasValidPermissions = checkTokenPermission(token);

  return hasValidPermissions;
};

Use serverTiming tracker withing your controllers or middlewares

// app-render.controller.ts example
import type { Request, Response, NextFunction } from 'express';

export const createRenderController =
  () => async (req: Request, res: Response, _next: NextFunction) => {
    try {
      // any tracking calls that were are not explicitly ended
      // will be fulfilled with final values right before sending response
      req.serverTiming.start('Request started', 'Optional description');

      req.serverTiming.start('render', 'render-application');
      const applicationResponse = await getSomeApplicationResponse();
      req.serverTiming.end('render');

      // do some other stuff

      res.send(applicationResponse);
    } catch (error) {
      req.log.error(error, 'Application rendering failed');
      next(error);
    }
  };

Use serverTiming tracker withing you middleware to collect all completed metrics

// server-timing-logger.middleware.ts example
import type { Request, Response, NextFunction } from 'express';
import type { ExpressServerTimingMetric } from 'express-server-timing-middleware';

export const serverTimingLogger = () => (req: Request, res: Response, next: NextFunction) => {
  try {
    const serverTimings: ExpressServerTimingMetric[] = req.serverTiming.getSnapshot();
    // use any of loggers defined on request/app level to log data
    req.log.info(serverTimings, 'server timings');
    next();
  } catch (error) {
    req.log.error(error, 'Server timing logging failed.');
    next();
  }
};

Alternatives you might be interested