3.0.1 • Published 9 months ago

@map-colonies/express-access-log-middleware v3.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
9 months ago

express-access-log-middleware

An access and error logger for express based on pino-http.

API documentation

Check the autogenerated documentation here.

Usage

import * as express from 'express';
import jsLogger from '@map-colonies/js-logger';
import httpLogger from '@map-colonies/express-access-log-middleware';

const app = express()

const logger = jsLogger();

app.use(httpLogger({logger}));

app.get('/', (req,res) => {
  res.json({hello: 'world'});
});

app.listen(8080);

for more detailed usage check the pino-http documentation.

Configuration

nametypedefault valuedescription
loggerLoggerrequiredThe logger instance used for logging requests and responses
ignorePaths(string | RegExp)[]undefinedArray of paths or regular expressions to ignore from logging
ignoreAutoLoggingOptions'ignore'undefinedCustom ignore options for automatic logging
customLogLevel(req, res, err) => LogLevelerror for >=400, info otherwiseCustom function to determine log level based on request, response and error
customSuccessMessage(res: ServerResponse) => stringundefinedCustom function to generate success messages
customSuccessObject(req: IncomingMessage, res: ServerResponse, val: any) => objectundefinedCustom function to modify the success log object
customErrorMessage(error: Error, res: ServerResponse) => stringundefinedCustom function to generate error messages
customErrorObject(req: IncomingMessage, res: ServerResponse, error: Error) => objectundefinedCustom function to modify the error log object