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

appinsights-express-middleware

v0.1.0

Published

Middleware for handling Microsoft Application Insights inside an express application.

Downloads

105

Readme

Express Middleware for Microsoft Application Insights

A simple middleware for exposing Microsoft Application Insights in your Express application.

Getting started

npm install appinsights-express-middleware@latest

Example Usage

For setting up logging in your application you need to import the logger function and pass your application as the first parameter and your Application Insights key in the option object as the second parameter.

import * as express from 'express';
import { logger } from 'appinsights-express-middleware';

const app = express();
app.use(logger(app, { key: 'YOUR_INSTRUMENTATION_KEY' }));

app.listen(3000, () => {
  console.log('Example app listening on port 3000!');
});

For tracking errors you need to import the middleware explictly and pass it to express after all other app.use() and route calls.

import * as express from 'express';
import * as bodyParser from 'body-parser'
import { logError } from 'appinsights-express-middleware';

const app = express();
app.use(logger(app, { key: 'YOUR_INSTRUMENTATION_KEY', traceErrors: true }));
app.use(bodyParser.json());
app.use(logError);

app.listen(3000, () => {
  console.log('Example app listening on port 3000!');
});

With this setup Express will log every request and track every error and send it to Application Insights. But how about logging inside your routes, or different parts of your application?

Logging during a request

After you set up the logger it is available through the res object.

import * as express from 'express';
import { logger } from 'appinsights-express-middleware';

const app = express();
app.use(logger(app, { key: 'YOUR_INSTRUMENTATION_KEY' }));

app.get('/', (req, res) => {
  res.locals.logger.trackEvent('page', {
    val: 'extra information',
    requestId: res.locals.requestId
  });

  res.send('hello world');
});

app.listen(3000, () => {
  console.log('Example app listening on port 3000!');
});

Keep in mind that the requestId is not required, it is provided as a convenience to correlate logs for request.

Logging outside of the request loop

Logging can also be done outside the HTTP Request context. For that use the app.locals.logger object:

app.js

import * as express from 'express';
import { logger } from 'appinsights-express-middleware';

export const app = express();

app.use(logger(app, { key: 'YOUR_INSTRUMENTATION_KEY' }));

app.listen(3000, () => {
  console.log('Example app listening on port 3000!');
});

server.js

import { app } from './app';
import * as http from 'http';

const server = http.createServer(app);

const errorHandler = error => {
  app.locals.logger.traceError(error, 'Error during startup.');
}

const listeningHandler = () => {
  app.locals.logger.traceInfo('Server listening.', {
    port: server.address().port
  });
}

server.on('error', errorHandler);
server.on('listening', listeningHandler);

Logging API

traceInfo(message: string, properties?: {[key: string]: string}): void;
traceError(error: Error, message: string, properties?: {[key: string]: string}): void;
traceWarning(message: string, properties?: {[key: string]: string}): void;
traceVerbose(message: string, properties?: {[key: string]: string}): void;
traceCritical(message: string, properties?: {[key: string]: string});

trackEvent(name: string, properties?: {[key: string]: string}): void;
trackMetric(name: string, value: number): void;
trackRequest(req: express.Request, res: express.Response): void