next-logger

JSON logging patcher for Next.js

Description

This is a library to patch the logging functions used by Next.js, to have them output to stdout as newline-delimited JSON. This allows a Next.js application to log service events in a format that's compatible with log aggregators, without needing a custom Next.js server.

This works by importing Next.js' inbuilt logger via require, and replacing the logging methods with custom ones. It uses pino to output JSON formatted logs, preserving Next.js' message and prefix, but adding timestamp, hostname and more. Although the library was mainly developed based on pino, it also supports winston as the logger backend. See the Custom Logger section below for more details.

From v2.0.0 onwards, this library also patches the global console methods, to catch additional logs that Next.js makes directly to console. While pino logging remains intact, this may cause issues with other libraries which patch or use console methods. Use the next-only preset to opt-out of this patching.

Example Logs

Before:

ready - started server on http://localhost:3000
info  - Using external babel configuration from .babelrc
event - compiled successfully

After:

{"level":30,"time":1609160882850,"pid":18493,"hostname":"MyHostname","name":"next.js","msg":"started server on http://localhost:3000","prefix":"ready"}
{"level":30,"time":1609160883607,"pid":18493,"hostname":"MyHostname","name":"next.js","msg":"Using external babel configuration from .babelrc","prefix":"info"}
{"level":30,"time":1609160885675,"pid":18493,"hostname":"MyHostname","name":"next.js","msg":"compiled successfully","prefix":"event"}

Usage

First, install this package and pino. You can do this with whatever Node package manager you're using in your project.

npm install next-logger pino

# or for Yarn

yarn add next-logger pino

Then use the Next Instrumentation hook to load this library.

Create instrumentation.ts|js file in the root directory of your project (or inside the src folder if using one)

export async function register() {
  if (process.env.NEXT_RUNTIME === 'nodejs') {
    await require('pino')
    await require('next-logger')
  }
}

Enable the instrumentation hook in next.config.js

const nextConfig = {
  // [...]
  experimental: {
    instrumentationHook: true,
  },
}

Presets

To support opting out of some patches, this library supports "presets". These can be used as above, with /presets/<PRESET_NAME> appended, for example: await require("next-logger/presets/next-only").

The following presets are supported:

next-logger/presets/all - this includes all the patches this library supports. Using the library without a preset specified will use this preset.
next-logger/presets/next-only - this only includes patches specifically for the Next.js logger object.

Custom Logger

By default, this library uses an instance of Pino with a modified logMethod, to give reasonable out-the-box behaviour for JSON logging. If you need logs in a different format, for example to change the message field or transform logged objects, you can provide your own instance of Pino to the library.

This is done by creating a next-logger.config.js file in the root of your project. The file should be a CommonJS module, and a function returning your custom Pino instance should be exported in a field called logger. This function will be called with the library's default Pino configuration, to allow you to extend it's behaviour (or completely replace it).

The instance returned by the function must implement a .child method, which will be called to create the child loggers for each log method.

For example:

// next-logger.config.js
const pino = require('pino')

const logger = defaultConfig =>
  pino({
    ...defaultConfig,
    messageKey: 'message',
    mixin: () => ({ name: 'custom-pino-instance' }),
  })

module.exports = {
  logger,
}

Or with winston:

npm install winston

const { createLogger, format, transports } = require('winston')

const logger = defaultConfig =>
  createLogger({
    transports: [
      new transports.Console({
        handleExceptions: true,
        format: format.json(),
      }),
    ],
  })

module.exports = {
  logger,
}

Breaking Changes on >=1.0.0

This package name, next-logger has been inherited from @frank47, who had deprecated their published logging middleware for Next.js. The original package and this one aim to solve similar problems for JSON logging in Next.js. However, the implementation and usage of this solution is significantly different from the original, which was published up to v0.4.0. To minimise unexpected issues for previous users of the original next-logger, the new package begins at major v1.0.0.

Release changes

Changes are published to npm, however with 2FA rules in place for security, this cannot be achieved through GitHub Actions at this time. To release a new version, merge all work intended to be in the release, and then follow these steps:

npm version <major|minor|patch>
git push --follow-tags
npm publish

Then create a new release on GitHub, pointing to the tag created by npm version.

sainsburys-tech/next-logger