+- `new Logger(options, commonObject, asyncLocalStorage, backend)`
+ - `commonObject` will be merged into every log
+ - `asyncLocalStorage`, if provided, should store an object, which will also be merged into log
+ - `backend` is `console` by default, but may be anything implementing the same log-level functions
+
+- `error(scope, message, data, ...)`
+ - `scope` - identifies source of message, e.g. 'class:method'
+ - `message` - text to be logged
+ - `data` - object to be logged, can be scrubbed of sensitive fields, and will be serialized with provided replacers
+ - any additional arguments are included as an array
+- `warn(scope, message, data, ...)`
+- `info(scope, message, data, ...)`
+- `log(scope, message, data, ...)`
+- `debug(scope, message, data, ...)`
+
+## JSON Replacers
+
+Includes replacers for these objects:
+
+- Error
+- BigInt
+- http.IncomingMessage
+- http.OutgoingMessage
+- http.ServerResponse
+
+Additional replacers may be inserted into the logger instance's `jsonReplacers` array.
+
+## Data Sanitizers
+
+Sanitizers may be inserted into the logger instance's `dataSanitizers` array.
+
+## Example
+
+```javascript
+const http = require('node:http');
+const { AsyncLocalStorage } = require('node:async_hooks');
+const uuid = require('uuid');
+const Logger = require('@squeep/logger-json-console');
+
+const loggerOptions = {
+ ignoreBelowLevel: 'info',
+};
+const commonObject = {
+ nodeIdentifier: uuid.v1(),
+};
+const asyncLocalStorage = new AsyncLocalStorage();
+const logger = new Logger(loggerOptions, commonObject, asyncLocalStorage);
+
+const scope = 'exampleServer';
+http.createServer((req, res) => {
+ asyncLocalStorage.run({ requestId: uuid.v1() }, () => {
+ logger.debug(scope, 'start', { req, res });
+ setImmediate(() => {
+ res.end();
+ logger.info(scope, 'finish', { req, res }, 'other stuff');
+ });
+ });
+}).listen(8088);
+```
+
+Results in messages such as this: