@routup/logger

A request logger ported from morgan. Same token DSL, same preset formats (tiny, short, common, combined, dev) — built on routup's IAppEvent + Response.

Installation

npm install @routup/logger

Quick start

import { App, defineCoreHandler, serve } from 'routup';
import { logger } from '@routup/logger';

const router = new App();

router.use(logger('tiny'));

router.get('/', defineCoreHandler(() => 'ok'));

serve(router, { port: 3000 });

The handler logs after the response is resolved so :status, :response-time, and :res[*] tokens reflect real values.

Why a handler, not a plugin

Most routup packages export a Plugin. logger() instead returns a CoreHandler you pass to router.use(...). The reason is structural: a routup Plugin's middleware lives inside a dedicated sub-router, and event.next() from inside that sub-router walks only the sub-router's stack — it never sees the route handler that produced the response. Logging fundamentally needs the resolved Response, so it has to live on the parent router. Same ergonomics (router.use(...)), different shape.

Preset formats

Name	Format
tiny	:method :url :status :res[content-length] - :response-time ms
short	:remote-addr :remote-user :method :url HTTP/:http-version :status :res[content-length] - :response-time ms
common	Apache common log
combined	Apache combined log (adds referrer + user-agent)
dev	Status color-coded; tuned for terminals

router.use(logger('combined'));
router.use(logger('dev'));

Custom format string

router.use(logger(':method :url :status :response-time ms'));

Pluggable write target

router.use(logger('tiny', {
    write: (line) => myStructuredLogger.info({ msg: line }),
}));

Skip predicate

router.use(logger('tiny', {
    skip: (event) => event.path === '/health',
}));

Custom tokens

router.use(logger(':method :url :user', {
    tokens: {
        user: (event) => event.store.userId as string | undefined,
    },
}));

See also

• Helpers — compile, resolveFormat, defaultTokens, formatStrings