Line simplification for development (#366)

* Use local time by default when prettifying logs Signed-off-by: Matteo Collina <[email protected]> * Ignore hostname by default Signed-off-by: Matteo Collina <[email protected]> * Update docs Signed-off-by: Matteo Collina <[email protected]> * Update test/basic.test.js Co-authored-by: James Sumners <[email protected]> * fixup Signed-off-by: Matteo Collina <[email protected]> Co-authored-by: James Sumners <[email protected]>
pinojs · Aug 10, 2022 · 429d5f1 · 429d5f1
1 parent 405415c
commit 429d5f1
Show file tree

Hide file tree

Showing 12 changed files with 133 additions and 104 deletions.
diff --git a/.taprc b/.taprc
@@ -1,6 +1,5 @@
 ts: false
 jsx: false
 flow: false
-jobs: 1
 files:
   - 'test/**/*.test.js'
diff --git a/Readme.md b/Readme.md
@@ -6,7 +6,7 @@
 [![Coverage Status](https://img.shields.io/coveralls/github/pinojs/pino-pretty)](https://coveralls.io/github/pinojs/pino-pretty?branch=master)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
 
-This module provides a basic [ndjson](http://ndjson.org/) formatter. If an
+This module provides a basic [ndjson](http://ndjson.org/) formatter to be used in __development__. If an
 incoming line looks like it could be a log line from an ndjson logger, in
 particular the [Pino](https://getpino.io/) logging library, then it will apply
 extra formatting by considering things like the log level and timestamp.
@@ -20,7 +20,7 @@ A standard Pino log line like:
 Will format to:
 
 ```
-[1522431328992] INFO (42 on foo): hello world
+[17:35:28.992] INFO (42): hello world
 ```
 
 If you landed on this page due to the deprecation of the `prettyPrint` option
@@ -84,13 +84,15 @@ node app.js | pino-pretty
   date and time string. This flag also can set the format string to apply when
   translating the date to a human-readable format. For a list of available pattern
   letters, see the [`dateformat` documentation](https://www.npmjs.com/package/dateformat).
-  - The default format is `yyyy-mm-dd HH:MM:ss.l o` in UTC.
+  - The default format is `HH:MM:ss.l` in the local timezone.
+  - Require a `UTC:` prefix to translate time to UTC, e.g. `UTC:yyyy-mm-dd HH:MM:ss.l o`.
   - Require a `SYS:` prefix to translate time to the local system's time zone. A
     shortcut `SYS:standard` to translate time to `yyyy-mm-dd HH:MM:ss.l o` in
     system time zone.
 - `--ignore` (`-i`): Ignore one or several keys, nested keys are supported with each property delimited by a dot character (`.`),
   keys may be escaped to target property names that contains the delimiter itself:
   (`-i time,hostname,req.headers,log\\.domain\\.corp/foo`)
+  Default: `hostname`.
 - `--hideObject` (`-H`): Hide objects from output (but not error object)
 - `--singleLine` (`-S`): Print each log message on a single line (errors will still be multi-line)
 - `--config`: Specify a path to a config file containing the pino-pretty options.  pino-pretty will attempt to read from a `.pino-prettyrc` in your current directory (`process.cwd`) if not specified

diff --git a/index.js b/index.js
@@ -39,11 +39,12 @@ const defaultOptions = {
   messageKey: MESSAGE_KEY,
   messageFormat: false,
   timestampKey: TIMESTAMP_KEY,
-  translateTime: false,
+  translateTime: true,
   useMetadata: false,
   outputStream: process.stdout,
   customPrettifiers: {},
   hideObject: false,
+  ignore: 'hostname',
   singleLine: false
 }
 

diff --git a/lib/constants.js b/lib/constants.js
@@ -2,6 +2,7 @@
 
 module.exports = {
   DATE_FORMAT: 'yyyy-mm-dd HH:MM:ss.l o',
+  DATE_FORMAT_SIMPLE: 'HH:MM:ss.l',
 
   ERROR_LIKE_KEYS: ['err', 'error'],
 

diff --git a/lib/utils.js b/lib/utils.js
@@ -14,7 +14,8 @@ const {
   LEVEL_LABEL,
   TIMESTAMP_KEY,
   LOGGER_KEYS,
-  LEVELS
+  LEVELS,
+  DATE_FORMAT_SIMPLE
 } = require('./constants')
 
 module.exports = {
@@ -74,7 +75,7 @@ function formatTime (epoch, translateTime = false) {
   }
 
   if (translateTime === true) {
-    return dateformat(instant, 'UTC:' + DATE_FORMAT)
+    return dateformat(instant, DATE_FORMAT_SIMPLE)
   }
 
   const upperFormat = translateTime.toUpperCase()