Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

byu-oit/express-logger

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

112 Commits
112 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Express Logger

GitHub Release codecov

Default express logging middleware to match CES Application Development logging standards.

Install

npm i @byu-oit/express-logger

Usage

import { LoggerMiddleware } from '@byu-oit/express-logger'
const app = Express()

app.use(LoggerMiddleware())

// ... add routes to express app
CommonJS Equivalent

const { LoggerMiddleware } = require('@byu-oit/express-logger')

const app = Express()

app.use(LoggerMiddleware())

Any requests to the express server will then write logs that look like:

{
  "level":"info",
  "time":1617128842026,
  "req":{
    "id":"Root=1-abcde",
    "method":"GET",
    "url":"/persons/123456789",
    "remoteAddress":"::1"
  },"res":{
    "statusCode":200
  },
  "responseTime":168,
  "message":"request completed"
}

Embedded Logger

This middleware will attach the Pino logger to the request object, so if needed you can access the logger like:

app.use(LoggerMiddleware())

app.get('/foo', (req, res) => {
  req.log.debug('Inside the /foo route')
  res.send('hello world')
})

Options

Any pinoHttp options can be overridden, but for compliance with our logging standards, we recommend sticking to the defaults provided in this package.

Example of overwriting a default

app.use(LoggerMiddleware({
  level: 'trace' 
}))

Note: If you provide your own logger please use the @byu-oit/logger to ensure you follow the logging standards.

import DefaultLogger from '@byu-oit/logger'

const myLogger = DefaultLogger()

app.use(LoggerMiddleware({
  logger: myLogger
}))

About

Default express logging middleware to match BYU Application Development logging standards

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.