Winston: जानकारी का प्रस्तावित संचालन [SPLAT]

को निर्मित 12 जुल॰ 2018 · 4टिप्पणियाँ · स्रोत: winstonjs/winston

विशेषता क्या है?

यह अधिक बहुमुखी उपयोग के मामलों के लिए वस्तुओं (JSON/सरणी/अन्य) के विभिन्न प्रबंधन के लिए एक प्रस्ताव है।

संक्षेप में, इस प्रस्ताव में दो बातें शामिल हैं।

logform.splat से info.meta पार्सिंग को अलग करें
एक नया रूपांतरण बनाएं जो ऑब्जेक्ट को विकल्प में ले जाए। मेटा

हल करने के उद्देश्य से कौन सी समस्या है?

विभिन्न उपयोगकर्ताओं (जैसे #1377, #1381, स्वयं) ने नोट किया है कि वस्तुओं/सरणियों का उपचार V3 में V2 से भिन्न है। V2 में इन ऑब्जेक्ट प्रकारों को options.meta फ़ील्ड में संग्रहीत किया जाएगा और संदेश और स्तर और ऑब्जेक्ट से अलग से संसाधित किया जा सकता है।

V3 में, केवल एक ही परिदृश्य/रूपांतरण होता है जिसमें options.meta को V2 की तरह ही संसाधित किया जाता है। यह तब होता है जब logform.splat ट्रांसफॉर्म का उपयोग किया जाता है। लॉग में टोकन मौजूद होने पर ही स्प्लैट मेटा को सही ढंग से पार्स करेगा। ईजी:
logger.log('info', 'this is a string I want to splat %s', 'together', {an: 'object'})
में परिणाम होगा:
info: this is a string I want to splat together {"meta":{"an":"object"}} // with .simple() transform

यदि उपयोगकर्ता logform.splat का उपयोग नहीं करना चाहते हैं, तो info.meta संसाधित नहीं किया जाएगा। इसके बजाय, मेटा ऑब्जेक्ट्स को जानकारी [SPLAT] में अछूता छोड़ दिया जाएगा।

एक लॉगफॉर्म जोड़ना जो सभी जानकारी [SPLAT] को info[meta] में कॉपी करता है, दोनों V2 उपयोगकर्ताओं की अपेक्षाओं को पूरा करेंगे और अधिक लचीले होंगे। (वैकल्पिक रूप से, सीधे लॉगर आउटपुट में info[SPLAT] जोड़ना और info[meta] => info[SPLAT] पर प्रलेखन प्रदान करना स्वीकार्य हो सकता है।)

एक नया परिवर्तन (उदाहरण के लिए logform.captureAllMeta सिर्फ नामकरण के लिए) इतना आसान हो सकता है:

// file captureAllMeta.js psuedo-code

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

के बराबर

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

बन जाएगा

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

एक्स्ट्रास्प्लैट कोड को splat() से हटाया जा सकता है क्योंकि इसे बाद के (नए) ट्रांसफॉर्म में नियंत्रित किया जाता है।

एक अतिरिक्त लाभ यह है कि यदि उपयोगकर्ता format.splat() का उपयोग नहीं करना चाहते हैं, तो वे अभी भी format.captureAllMeta() को एक स्टैंडअलोन परिवर्तन के रूप में शामिल कर सकते हैं।

क्या इस सुविधा की अनुपस्थिति आपको या आपकी टीम को अवरुद्ध कर रही है? यदि हां, तो कैसे?

अब यह जानकर कि जानकारी [स्प्लैट] जानकारी [मेटा] में क्या गुम है, इसे ज्ञान/दस्तावेज़ीकरण अंतर माना जा सकता है।

क्या यह सुविधा किसी अन्य टूल में मौजूदा सुविधा के समान है?

V2 से V3 संगतता बढ़ाता है।

क्या यह एक ऐसी सुविधा है जिसे आप हमारे समर्थन से लागू करने के लिए तैयार हैं?

हां, मैं इसका समर्थन करने की पूरी कोशिश कर सकता हूं।

समस्या को पुन: उत्पन्न करने के लिए

_ winston संस्करण?_
- [ ] winston@2
- [एक्स] winston@3
_ node -v आउटपुट:_ 6.10.0
_ऑपरेटिंग सिस्टम?_ (Windows, macOS, या Linux) कोई भी
_भाषा?_ (सभी | टाइपस्क्रिप्ट XX | ES6/7 | ES5 | डार्ट) सभी

समस्या क्या है?

आउटपुट के साथ V2 ट्रांसपोर्ट कोड का एक नमूना यहां दिया गया है:

        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."]

V3 में, मैंने इसे निम्नलिखित कोड के साथ दोहराने की कोशिश की, लेकिन परिणाम ने सरणी प्रदर्शित नहीं की।

    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.

investigate

स्रोत

tagyoureit

👍3

सबसे उपयोगी टिप्पणी

तो मुझे अभी एहसास हुआ कि format.splat() का उपयोग जानकारी में मेटा ऑब्जेक्ट जोड़ता है, लेकिन केवल तभी जब आप इंटरपोलेशन का भी उपयोग करते हैं। यदि आप प्रक्षेप का उपयोग नहीं करते हैं, तो मेटा को केवल सूचना वस्तु में मिलाया जाता है।

इंटरपोलेशन और मेटा का उपयोग करते समय, format.simple() मेटा को {मेटा: {METAOBJ}} के रूप में केवल {METAOBJ} जैसे v2.

tony-gutierrez 7 अग॰ 2018

👍3

सभी 4 टिप्पणियाँ

मैंने पिछली रात इस पर काम किया और उपरोक्त लागू करने वाले कोड के साथ एक शाखा बनाई। मुझे बताएं कि क्या आप चाहते हैं कि मैं इसके लिए लॉगफॉर्म में पीआर बनाऊं।

यहां एक परीक्षण फ़ाइल है जिसका मैंने उपयोग किया है ...

'use strict';

const winston = require('winston');
const logform = require('logform')
const {SPLAT} = require('triple-beam');


const {createLogger, format, transports} = require('winston');
var logger = createLogger({
    format: format.combine(

        format.splat()
        , format.captureAllMeta()
        ,
        logform.format.printf(info => {

            // return `${info.timestamp} [${info.label}] ${info.level}: ${info.message}`;
            if ((!info.meta.length)) {
                return (`${info.level}: ${info.message}`);

            }
            else {
                return (`${info.level}: ${info.message}\n\t${JSON.stringify(info.meta)}`);

            }
        })
    ),
    transports: [new transports.Console()]
});


let count = 1

logger.log('info', count + '. this is a string I want to splat %s', 'together', {an: 'object'})
count += 1
console.log('---')

logger.log('info', count + '.this is a string followed by an object and an array', {an: 'object'}, ['an', 'array'])
count += 1
console.log('---')

logger.log('info', count + '.this is a string followed by an object and an array', ['an', 'array'], {an: 'object'})
count += 1
console.log('---')


logger.log('info', count + '. string followed by', 'a string')
console.log('---')
count += 1

logger.log('info', count + '. string followed by 2', 'separate', 'strings')
console.log('---')
count += 1

logger.log('info', count + '. string followed by', {an: 'object'})
console.log('---')
count += 1

logger.log('info', count + '. string followed by 2', {an: 'object'}, ['an', 'array'])
console.log('---')
count += 1

logger.log('info', count + '. string with token followed by string %s', 'string')
console.log('---')
count += 1

logger.log('info', count + '. string with token followed by obj %j', {idunno: 'notsure'})
console.log('---')
count += 1

logger.log('info', count + '. string with token followed by string %s and then objects', 'or here', {an: 'object'}, ['i', 'am', 'missed'])
console.log('---')
count += 1

logger.log('info', count + '. string with two tokens %s %s followed by one ', 'string')
console.log('---')
count += 1

logger.log('info', count + '. string with two tokens %s %j followed by one string and one object', 'string', {an: 'object'}, [1,2,3])
count += 1
console.log('---')


logger.info({message: 'just an object', [SPLAT]: {more:'stuff'}})
count += 1
console.log('---')

logger.info(['an','array'])
count += 1
console.log('---')

logger.info(['an','array',{with:'object'}])
count += 1
console.log('---')


logger.log({
    level: 'info',
    message: '%d: The answer to life, the universe and everything',
    splat: [42]
})
count += 1
console.log('---')

logger.log({
    level: 'info',
    message: '%d: The answer to life, the universe and everything',
    splat: [43],
    [Symbol.for('splat')]: [44]
})
count += 1
console.log('---')

logger.log({
    level: 'info',
    message: '%d: The answer to life, the universe and everything'
})
count += 1
console.log('---')

निम्नलिखित आउटपुट के साथ ...

info: 1. this is a string I want to splat together
    [{"an":"object"}]
---
info: 2.this is a string followed by an object and an array
    [{"an":"object"},["an","array"]]
---
info: 3.this is a string followed by an object and an array
    [["an","array"],{"an":"object"}]
---
info: 4. string followed by
    ["a string"]
---
info: 5. string followed by 2
    ["separate","strings"]
---
info: 6. string followed by
    [{"an":"object"}]
---
info: 7. string followed by 2
    [{"an":"object"},["an","array"]]
---
info: 8. string with token followed by string string
---
info: 9. string with token followed by obj {"idunno":"notsure"}
---
info: 10. string with token followed by string or here and then objects
    [{"an":"object"},["i","am","missed"]]
---
info: 11. string with two tokens string %s followed by one
---
info: 12. string with two tokens string {"an":"object"} followed by one string and one object
    [[1,2,3]]
---
info: just an object
    [{"more":"stuff"}]
---
info: an,array
---
info: an,array,[object Object]  // expected... no %j token
---
info: 42: The answer to life, the universe and everything
---
info: 44: The answer to life, the universe and everything
---
info: %d: The answer to life, the universe and everything
---

tagyoureit 13 जुल॰ 2018

जानकारी के अलावा info.splat के लिए मेरे कोड में समर्थन जोड़ा गया [SPLAT]।

tagyoureit 16 जुल॰ 2018

कुछ इस तरह की जरूरत है। मूल रूप से, यदि आप अपने मौजूदा लॉग स्टेटमेंट को छुए बिना v3 में अपग्रेड नहीं कर सकते हैं, और इंटरपोलेशन के बाद मेटा को एक अलग ऑब्जेक्ट के रूप में प्राप्त करने में सक्षम हैं, तो v3 अधिकांश बाहर निकलने वाले उपयोगकर्ताओं के लिए एक गैर-स्टार्टर है। मुझे नहीं पता कि किसी ने क्यों सोचा कि स्तर, संदेश और मेटा को एक बड़ी वस्तु में मिलाना एक अच्छा विचार था। यह संघर्षों के लिए परिपक्व है। info[Symbol.for('splat)] भी विश्वसनीय नहीं है क्योंकि यह इंटरपोलेशन वैल्यू और मेटा को एक साथ मिलाएगा। हम मेटा SEPARATE चाहते हैं।

tony-gutierrez 7 अग॰ 2018

👍3

tony-gutierrez 7 अग॰ 2018

👍3

क्या यह पृष्ठ उपयोगी था?

0 / 5 - 0 रेटिंग्स

Winston: जानकारी का प्रस्तावित संचालन [SPLAT]

विशेषता क्या है?

हल करने के उद्देश्य से कौन सी समस्या है?

क्या इस सुविधा की अनुपस्थिति आपको या आपकी टीम को अवरुद्ध कर रही है? यदि हां, तो कैसे?

क्या यह सुविधा किसी अन्य टूल में मौजूदा सुविधा के समान है?

क्या यह एक ऐसी सुविधा है जिसे आप हमारे समर्थन से लागू करने के लिए तैयार हैं?

समस्या को पुन: उत्पन्न करने के लिए

समस्या क्या है?

सबसे उपयोगी टिप्पणी

सभी 4 टिप्पणियाँ

संबंधित मुद्दों