axe 10.0.0 → 10.0.2

package/README.md

@@ -5,6 +5,7 @@
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://github.com/lassjs/lass)
 [![license](https://img.shields.io/github/license/cabinjs/axe.svg)](LICENSE)
+[![npm downloads](https://img.shields.io/npm/dt/axe.svg)](https://npm.im/axe)
 
 > Axe is a logger-agnostic wrapper that normalizes logs regardless of argument style. Great for large development teams, old and new projects, and works with Pino, Bunyan, Winston, console, and more. It is lightweight, performant, highly-configurable, and automatically adds OS, CPU, and Git information to your logs. It supports hooks (useful for masking sensitive data) and dot-notation remapping, omitting, and picking of log metadata properties. Made for [Forward Email][forward-email], [Lad][], and [Cabin][].
 
@@ -33,6 +34,7 @@
 * [Examples](#examples)
   * [Send Logs to HTTP Endpoint](#send-logs-to-http-endpoint)
   * [Send Logs to Slack](#send-logs-to-slack)
+  * [Send Logs to Sentry](#send-logs-to-sentry)
   * [Suppress Logger Data](#suppress-logger-data)
 * [Contributors](#contributors)
 * [License](#license)
@@ -401,7 +403,7 @@ See [Browser](#browser-1) usage below for more information.
 | ----------------------- | ----------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - |
 | `showStack`             | Boolean           | `true`                            | Attempts to parse a boolean value from `process.env.AXE_SHOW_STACK`). **If this value is `true`, then if `message` is an instance of an Error, it will be invoked as the first argument to logger methods. If this is `false`, then only the `err.message` will be invoked as the first argument to logger methods.** Basically if `true` it will call `logger.method(err)` and if `false` it will call `logger.method(err.message)`. If you pass `err` as the first argument to a logger method, then it will show the stack trace via `err.stack` typically. |   |
 | `meta`                  | Object            | See below                         | Stores all meta config information (see the following nested properties below).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |   |
-| `meta.show`             | Boolean           | `true`                            | Attempts to parse a boolean value from `process.env.AXE_SHOW_META` – meaning you can pass a flag `SHOW_META=true node app.js` when needed for debugging), whether or not to output metadata to logger methods. If set to `false`, then fields will not be omitted nor picked; the entire meta object will be hidden from logger output.                                                                                                                                                                                                                        |   |
+| `meta.show`             | Boolean           | `true`                            | Attempts to parse a boolean value from `process.env.AXE_SHOW_META` – meaning you can pass a flag `AXE_SHOW_META=true node app.js` when needed for debugging), whether or not to output metadata to logger methods. If set to `false`, then fields will not be omitted nor picked; the entire meta object will be hidden from logger output.                                                                                                                                                                                                                    |   |
 | `meta.remappedFields`   | Object            | `{}`                              | Attempts to parse an Object mapping from `process.env.AXE_REMAPPED_META_FIELDS` (`,` and `:` delimited, e.g. `REMAPPED_META_FIELDS=foo:bar,beep.boop:beepBoop` to remap `meta.foo` to `meta.bar` and `meta.beep.boop` to `meta.beepBoop`). Note that this will clean up empty objects by default unless you set the option `meta.cleanupRemapping` to `false`). Supports dot-notation.                                                                                                                                                                         |   |
 | `meta.omittedFields`    | Array             | `['level','err','app', 'args']`   | Attempts to parse an array value from `process.env.AXE_OMIT_META_FIELDS` (`,` delimited) - meaning you can pass a flag `OMIT_META_FIELDS=user,id node app.js`), determining which fields to omit in the metadata passed to logger methods. Supports dot-notation.                                                                                                                                                                                                                                                                                              |   |
 | `meta.pickedFields`     | Array             | `[]`                              | Attempts to parse an array value from `process.env.AXE_PICK_META_FIELDS` (`,` delimited) - meaning you can pass a flag, e.g. `PICK_META_FIELDS=request.headers,response.headers node app.js` which would pick from `meta.request` and `meta.response` *only* `meta.request.headers` and `meta.response.headers`), **This takes precedence after fields are omitted, which means this acts as a whitelist.** Supports dot-notation.                                                                                                                             |   |
@@ -423,37 +425,35 @@ See [Browser](#browser-1) usage below for more information.
   ```
 
   ```sh
-  and_chr 102
-  and_ff 101
-  and_qq 10.4
-  and_uc 12.12
-  android 101
-  chrome 103
-  chrome 102
-  chrome 101
-  chrome 100
-  edge 103
-  edge 102
-  edge 101
-  firefox 101
-  firefox 100
-  firefox 91
+  and_chr 107
+  and_ff 106
+  and_qq 13.1
+  and_uc 13.4
+  android 107
+  chrome 107
+  chrome 106
+  chrome 105
+  edge 107
+  edge 106
+  edge 105
+  firefox 106
+  firefox 105
+  firefox 102
+  ios_saf 16.1
+  ios_saf 16.0
+  ios_saf 15.6
   ios_saf 15.5
-  ios_saf 15.4
-  ios_saf 15.2-15.3
-  ios_saf 15.0-15.1
   ios_saf 14.5-14.8
-  ios_saf 14.0-14.4
-  ios_saf 12.2-12.5
   kaios 2.5
   op_mini all
   op_mob 64
-  opera 86
-  opera 85
-  safari 15.5
-  safari 15.4
+  opera 91
+  opera 90
+  safari 16.1
+  safari 16.0
+  safari 15.6
+  samsung 18.0
   samsung 17.0
-  samsung 16.0
   ```
 
 ### Node
@@ -844,7 +844,7 @@ This is an example of using hooks to send a message to Slack with logs of the "f
 
    // create an instance of the Slack Web Client API for posting messages
    const web = new WebClient('INSERT-YOUR-TOKEN', {
-     // <https://slack.dev/node-slack-sdk/web-api#logging>
+     // https://slack.dev/node-slack-sdk/web-api#logging
      logger,
      logLevel: logger.config.level
    });
@@ -911,6 +911,42 @@ This is an example of using hooks to send a message to Slack with logs of the "f
    logger.error(new Error('Uh oh something went wrong!'));
    ```
 
+### Send Logs to Sentry
+
+See below example and the reference at <https://docs.sentry.io/platforms/node/> for more information.
+
+```sh
+npm install @sentry/node
+```
+
+```js
+const Axe = require('axe');
+const Sentry = require('@sentry/node');
+
+const logger = new Axe();
+
+Sentry.init({
+  // TODO: input your DSN here from Sentry once you're logged in at:
+  // https://docs.sentry.io/platforms/node/#configure
+  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
+});
+
+for (const level of logger.config.levels) {
+  logger.post(level, (next, message, meta) => {
+    // https://docs.sentry.io/clients/node/usage/
+    if (message instanceof Error) {
+      Sentry.captureException(message, meta);
+    } else {
+      Sentry.captureMessage(message, meta);
+    }
+    next();
+  });
+}
+
+// do stuff
+logger.error(new Error('uh oh'));
+```
+
 ### Suppress Logger Data
 
 This is an example of using a custom hook to manipulate logger arguments to suppress sensitive data.