git.squeep.com Git - squeep-logger-json-console/blob - README.md

   1 # @squeep/logger
   2
   3 A simple logger class, which mostly just structures messages, data, and some metadata as JSON and spews it, by default, to Console.
   4
   5 Supports basic scrubbing of well-defined sensitive data, and an extensible set of JSON replacer functions for common objects.
   6
   7 Intended to be specific to Squeep Framework Applications, this module has opinions.
   8
   9 ## API
  10
  11 Expects these fields in any log call:
  12
  13 - `scope` - file:method
  14 - `message` - text
  15 - `data` - object
  16 - any additional parameters are included as an array, but not scrubbed