@defra/cdp-auditing/src/auditing.js

A hapi plugin for sending audit messages to the CDP audit pipeline

import pino from 'pino'
import { auditLoggerConfig } from './audit-logger-config.js'

let auditLogger = pino(auditLoggerConfig)

if (process.env.CDP_AUDIT_ENABLED === 'false') {
  enableAuditing(false)
}

/**
 * Replaces the current audit logger.
 *
 * @param {Logger} logger
 */
function setAuditLogger(logger) {
  auditLogger = logger
}

/**
 * Globally enables or disables auditing
 * @param {boolean|null} isEnabled
 */
function enableAuditing(isEnabled = true) {
  if (isEnabled) {
    auditLogger.level = 'audit'
  } else {
    auditLogger.level = 'silent'
  }
}

/**
 * Writes an audit message to stdout with a `log.level` of `audit`.
 * API is exactly the same as pino's logger api.
 *
 * @param { ...Object|String|Error } args - Either:
 *   - one String
 *   - one Object or Error
 *   - one Object or Error and one String
 */
function audit(...args) {
  auditLogger.audit.apply(auditLogger, args)
}

export { audit, enableAuditing, setAuditLogger }