Class LogController

lib/log-controller.js:12–167

* Internal logger layer that wraps Fastify's log calls with * request-lifecycle awareness (disable-check, level selection). * Keeps the surface intentionally small so hot paths stay fast. * * Users can extend this class to customize internal log lines.

 * Users can extend this class to customize internal log lines.
 */
class LogController {
  /**
   * @param {object} [options]
   * @param {boolean | ((req: object) => boolean)} [options.disableRequestLogging=false]
   *   When `true` (or a function returning `true`), per-request log lines
   *   (incoming, completed, errors) are suppressed.
   * @param {string} [options.requestIdLogLabel='reqId']
   *   The label used for the request identifier when logging the request.
   */
  constructor (options) {
    const opts = options || {}
    this.disableRequestLogging = opts.disableRequestLogging || defaultInitOptions.disableRequestLogging
    this.isDisableRequestLoggingFunction = typeof this.disableRequestLogging === 'function'
    this.requestIdLogLabel = opts.requestIdLogLabel || defaultInitOptions.requestIdLogLabel
  }

  /**
   * Checks whether request logging is disabled for the given request.
   *
   * @param {object} req  Raw or Fastify request object.
   * @returns {boolean}   `true` when logging should be skipped.
   */
  isLogDisabled (req) {
    return this.isDisableRequestLoggingFunction
      ? this.disableRequestLogging(req)
      : this.disableRequestLogging
  }

  /**
   * Logs an incoming request at `info` level.
   *
   * @param {object} request      Fastify request object.
   * @param {object} reply        Fastify reply object.
   * @param {object} [metadata]   Extra contextual data (unused).
   */
  incomingRequest (request, reply, metadata) {
    if (this.isLogDisabled(request)) { return }

    request.log.info({ req: request }, 'incoming request')
  }

  /**
   * Logs the outcome of a completed request.
   * Uses `error` level when an error is present, `info` otherwise.
   *
   * @param {Error | null} error  Error that occurred during the response, if any.
   * @param {object} request      Fastify request object.
   * @param {object} reply        Fastify reply object.
   * @param {object} [metadata]   Extra contextual data (unused).
   */
  requestCompleted (error, request, reply, metadata) {
    if (this.isLogDisabled(request)) { return }

    if (error) {
      reply.log.error({ res: reply, err: error, responseTime: reply.elapsedTime }, 'request errored')
    } else {
      reply.log.info({ res: reply, responseTime: reply.elapsedTime }, 'request completed')
    }