Logging HTTP Requests

[justindasilva]

How would I go about adding logging HTTP requests to my Nitro server?

If Nitro doesn't support this in an easy way, is there a way I can use something like Morgan (https://www.npmjs.com/package/morgan), although this module seems to be more integrated with Express.

Basically, if I run yarn dev, and if I access one of my routes such as /hello, I would like the terminal to log something like:

GET /hello 200

Would be nice to have some control over what is being logged, but not required as long as all the important stuff is there.
Not sure if this functionality exists somewhere already?

[oppianmatt]

this worked for me:

import { defineNitroPlugin } from 'nitropack/dist/runtime/plugin'
import morgan from 'morgan'
import userAgentParser from 'ua-parser-js'

const morganJSONFormat = () =>
  JSON.stringify({
    method: ':method',
    url: ':url',
    http_version: ':http-version',
    remote_addr: ':remote-addr',
    response_time: ':response-time',
    status: ':status',
    content_length: ':res[content-length]',
    '@timestamp': ':date[iso]',
    user_agent: ':user-agent',
    referrer: ':referrer',
    accept: ':req[accept]',
    accept_language: ':req[accept-language]',
    accept_encoding: ':req[accept-encoding]',
    host: ':req[host]',
  })

export default defineNitroPlugin((nitroApp) => {
  const logger = morgan(morganJSONFormat(), {
    stream: {
      write: (message) => {
        const data = JSON.parse(message)
        parseUserAgent(data)
        process.stdout.write(JSON.stringify(data))
        return true
      },
    },
  })
  nitroApp.hooks.hook('render:response', (_response, { event }) => {
    const node = event.node
    logger(node.req, node.res, function () {
      return
    })
  })
})

const parseUserAgent = function (data) {
  if (data.user_agent) {
    const ua = userAgentParser(data.user_agent)
    if (ua.browser) {
      data.user_agent_browser_name = ua.browser.name
      data.user_agent_browser_version = ua.browser.major || ua.browser.version
    }
    if (ua.os) {
      data.user_agent_os_name = ua.os.name
      data.user_agent_os_version = ua.os.version
    }
  }
}

[tobychidi]

But how do I log API requests? This seems to only work for renders.

I am trying to build a Treblle plugin for Nitro

[Hebilicious]

How about using a server middleware that will run globally before all your requests?

[tobychidi]

Thanks @Hebilicious this works. Now, the plugin I want to create requires I append something to the body of the response.

Here is what was done in express. How do I replicate in H3/Nitro

const originalSend = res.send;
   res.send = function sendOverWrite(body) {
      originalSend.call(this, body);
      this._treblleResponsebody = body;
   };