Logger Integrations

Hiroki uses HirokiLogger internally. By default it ships with ConsoleLogger. Two optional packages wrap popular loggers:

Package	Logger
hiroki-pino	pino
hiroki-winston	winston

PinoLogger

Installation

npm install hiroki-pino pino

Usage

import hiroki from 'hiroki';
import { PinoLogger } from 'hiroki-pino';
import pino from 'pino';

hiroki.setConfig({
  logger: new PinoLogger(pino()),
});

Custom pino options

import pino from 'pino';
import { PinoLogger } from 'hiroki-pino';

const logger = new PinoLogger(
  pino({
    level: 'debug',
    transport: {
      target: 'pino-pretty',
    },
  })
);

Constructor

new PinoLogger(pinoInstance: PinoInstance)

PinoInstance is structurally typed — any object with info, error, warn, debug methods works.

---

WinstonLogger

Installation

npm install hiroki-winston winston

Usage

import hiroki from 'hiroki';
import { WinstonLogger } from 'hiroki-winston';
import winston from 'winston';

const winstonLogger = winston.createLogger({
  level: 'debug',
  transports: [new winston.transports.Console()],
});

hiroki.setConfig({
  logger: new WinstonLogger(winstonLogger),
});

Constructor

new WinstonLogger(winstonInstance: WinstonInstance)

WinstonInstance is structurally typed — any object with info, error, warn, debug methods works.

---

Custom logger

Implement HirokiLogger directly to wrap any logger:

import type { HirokiLogger } from 'hiroki';

export class MyLogger implements HirokiLogger {
  info(message: string): void { /* ... */ }
  error(message: string): void { /* ... */ }
  warn(message: string): void { /* ... */ }
  debug(message: string): void { /* ... */ }
}

hiroki.setConfig({ logger: new MyLogger() });

Log levels

Hiroki emits at these levels:

Level	When
debug	All operations — filter/options/result on every request
info	Mutating operations — create, update, delete
error	Caught errors passed to response