Was ist die Funktion?

Dies ist ein Vorschlag für eine andere Behandlung von Objekten (JSON/Array/andere) für vielseitigere Anwendungsfälle.

Kurz gesagt, dieser Vorschlag deckt zwei Dinge ab.

1. Teilen Sie das info.meta-Parsing von logform.splat auf
2. Erstellen Sie eine neue Transformation, die Objekte in options.meta verschiebt

Welches Problem soll die Funktion lösen?

Verschiedene Benutzer (zB #1377, #1381, ich selbst) haben festgestellt, dass die Behandlung von Objekten/Arrays in V3 anders ist als in V2. In V2 würden diese Objekttypen im options.meta -Feld gespeichert und könnten getrennt von der Nachricht, Ebene und Objekten verarbeitet werden.

In V3 gibt es nur ein Szenario/eine Transformation, in der options.meta genauso verarbeitet wird wie in V2. Dies ist der Fall, wenn die logform.splat-Transformation verwendet wird. Splat analysiert Meta nur dann korrekt, wenn ein Token im Protokoll vorhanden ist. Z.B:
logger.log('info', 'this is a string I want to splat %s', 'together', {an: 'object'})
wird darin enden, dass:
info: this is a string I want to splat together {"meta":{"an":"object"}} // with .simple() transform

Wenn Benutzer logform.splat nicht verwenden möchten, wird info.meta nicht verarbeitet. Stattdessen werden die Metaobjekte in info[SPLAT] unberührt gelassen.

Das Hinzufügen eines Protokollformulars, das alle info[SPLAT] nach info[meta] kopiert, wird sowohl die Erwartungen von V2-Benutzern erfüllen als auch flexibler sein. (Alternativ könnte das direkte Hinzufügen von info[SPLAT] zur Loggerausgabe und das Bereitstellen von Dokumentation zu info[meta] => info[SPLAT] akzeptabel sein.)

Eine neue Transformation (z. B. logform.captureAllMeta, nur um der Namensgebung willen) könnte so einfach sein wie:

// file captureAllMeta.js psuedo-code

module.exports = transform((info, opts) => {
  if (info[SPLAT]) {
    info.meta = info[SPLAT]
  return info;
});

Das Äquivalent von

format.combine(
        format.splat(),
        ...
    )

würde werden

format.combine(
        format.splat(),
        format.captureAllMeta(),
        ...
        // still need to have a formatter for options.meta.  maybe a separate feature request.
    )

Der extraSplat -Code könnte aus splat() entfernt werden, da er in der nachfolgenden (neuen) Transformation behandelt wird.

Ein zusätzlicher Vorteil besteht darin, dass Benutzer, die format.splat() nicht verwenden möchten, immer noch format.captureAllMeta() als eigenständige Transformation einschließen können.

Blockiert das Fehlen dieser Funktion Sie oder Ihr Team? Wenn das so ist, wie?

Jetzt wissend, dass info[SPLAT] speichert, was in info[meta] fehlt, könnte dies als Wissens-/Dokumentationslücke angesehen werden.

Ist diese Funktion einer vorhandenen Funktion in einem anderen Tool ähnlich?

Erweitert die Kompatibilität von V2 auf V3.

Ist dies eine Funktion, die Sie mit Unterstützung von uns implementieren möchten?

Ja, ich kann mein Bestes tun, um dies zu unterstützen.

Um das Problem zu reproduzieren

• _ winston -Version?_
  
  
  
  • [ ] winston@2
  
  
  • [X] winston@3
  
  
• _ node -v Ausgaben:_ 6.10.0
• _Betriebssystem?_ (Windows, macOS oder Linux) Beliebig
• _Sprache?_ (alle | TypeScript XX | ES6/7 | ES5 | Dart) alle

Was ist das Problem?

Hier ist ein Beispiel für einen V2-Transportcode mit Ausgabe:

        logger = winston.createLogger({
            transports: [
                new (winston.transports.Console)({
                    timestamp: function () {
                        return dateFormat(Date.now(), "HH:MM:ss.l");
                    },
                    formatter: function (options) {
                        // Return string will be passed to logger.
                        return options.timestamp() + ' ' + winston.config.colorize(options.level, options.level.toUpperCase()) + ' ' + (undefined !== options.message ? options.message : '') +
                            (options.meta && Object.keys(options.meta).length ? '\n\t' + JSON.stringify(options.meta) : '');
                    },
                    colorize: true,
                    level: container.settings.get('logLevel') || 'info',
                    stderrLevels: [],
                    handleExceptions: true,
                    humanReadableUnhandledException: true
                })
            ]
        });


// results of Winston<strong i="33">@2</strong>
08:31:30.363 DEBUG Server starting complete.
        ["Server https started.","Server http started.","Server SSDP started.","Server MDNS started."]

In V3 habe ich versucht, dies mit dem folgenden Code zu replizieren, aber das Ergebnis zeigte das Array nicht an.

    const processObj = logform.format(info => {
             console.log('raw: ', raw)
            return info
        }
    )

    const myFormat = printf(info => {
        info.timestamp = dateFormat(Date.now(), "m/d/yy HH:MM:ss.l")
        return `${info.timestamp} ${info.level}: ${info.message}`;
    });

        logger = createLogger({
            level: container.settings.get('logLevel') || 'info',
            format: combine(
                processObj(),
                format.json(),
                timestamp({format: () => new Date().toLocaleString()}),
                format.colorize(),
                format.align(),
                format.splat(),
                myFormat
            ),
            transports: [new transports.Console()]
        });
        logger.exceptions.handle()
        logger.exitOnError = false;

results = [ 'Not starting https server.', 'Server http started.', 'Server SSDP started.', 'Server MDNS started.']
logger.debug('Server status', results)

// results of winston<strong i="6">@3</strong> -- missing the results array
6/25/18 08:16:30.501 debug:     Server starting complete.