Winston: अनुरोध: डिफ़ॉल्ट मेटाडेटा में कार्य

यहां अंतर्निहित समस्या कुछ जटिल है इसलिए मैं संक्षेप में बताऊंगा कि हम यहां क्या मांग रहे हैं -- हम फ़ील्ड के रूप में फ़ंक्शन प्रदान करके गतिशील रूप से जेनरेट किए गए मानों को शामिल करने के लिए defaultMetadata की क्षमता को देखने में रुचि रखते हैं। उदाहरण के लिए:

const logger = createLogger({
  defaultMeta: {
    // Function to be evaluated every time a log is written.
    timeWritten: () => { return `Date.now()`; }
  },
  // ...
});

पूर्ण औचित्य के लिए नीचे देखें।

कृपया हमें अपने पर्यावरण के बारे में बताएं:

• _ winston संस्करण?_
  
  
  
  • [ ] winston@2
  
  
  • [एक्स] winston@3
  
  
• _ node -v आउटपुट:_ v10.15.2
• _ऑपरेटिंग सिस्टम?_ macOS (अप्रासंगिक)
• _भाषा?_ ES7 (अप्रासंगिक)

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

विंस्टन के लिए स्टैकड्राइवर लॉगिंग ट्रांसपोर्ट के लेखक के रूप में, हम लॉग-अनुरोध सहसंबंध का समर्थन करना चाहेंगे। async_hooks मॉड्यूल हमें अनुरोध-विशिष्ट जानकारी जैसे अनुरोध आईडी को संग्रहीत करने की क्षमता देता है। हालांकि, हमारे पास Transport की ओर से इसे विश्वसनीय रूप से पुनर्प्राप्त करने का कोई साधन नहीं है।

उदाहरण के द्वारा समस्या का सबसे अच्छा वर्णन किया गया है। निम्न कोड इस आउटपुट को तब उत्पन्न करता है जब ~ 100 अनुरोध त्वरित उत्तराधिकार में किए जाते हैं:

const ah = require('async_hooks');
const express = require('express');
const { createLogger } = require('winston');
const TransportStream = require('winston-transport');

// Activate async hooks.
let requestIdHighWater = 0;
const requestIdTable = {};
ah.createHook({
  init: (child, resource, parent) => {
    requestIdTable[child] = requestIdTable[parent];
  }
}).enable();

// OUR CODE

class MyTransport extends TransportStream {
  log(info, next) {
    // From the transport, the request ID is not reliable.
    const actualRequestId = requestIdTable[ah.executionAsyncId()];
    console.log(`Expected: ${info.expectedRequestId}, Actual: ${actualRequestId}`);
    setImmediate(next);
  }
}

// OUR USER'S CODE

const logger = createLogger({
  transports: [new MyTransport()]
});

const app = express();

app.get('/', async (req, res) => {
  // Store a request ID.
  const requestId = requestIdHighWater++;
  requestIdTable[ah.executionAsyncId()] = requestId;
  logger.info('hello', { expectedRequestId: requestId });
  res.sendStatus(200);
});

app.listen(3000);

"अपेक्षित" और "वास्तविक" अनुरोध आईडी में बेमेल पर ध्यान दें। यदि हम MyTransport के लेखक हैं, तो हमारे पास वर्तमान निष्पादन आईडी ("वास्तविक") से परामर्श करके सही अनुरोध आईडी प्राप्त करने का कोई तरीका नहीं होगा। इसके बजाय, हमें मेटाडेटा ("अपेक्षित") के रूप में सही अनुरोध आईडी में पास करने वाले उपयोगकर्ता पर भरोसा करना चाहिए। ऐसा इसलिए है क्योंकि विंस्टन 3 बैच लॉग करता है ( readable-stream के माध्यम से) जब कोई ट्रांसपोर्ट अपने log कॉलबैक के आह्वान को स्थगित कर देता है।

समस्या यह है कि हम अपने लिए अनुरोध आईडी में पास करने वाले उपयोगकर्ताओं पर भरोसा नहीं करना चाहते हैं; हम चाहते हैं कि यह स्वचालित रूप से हो। आखिरकार, उपयोगकर्ता शायद केवल लिखना चाहेंगे

app.get('/', async (req, res) => {
  logger.info('hello');
  res.sendStatus(200);
});

और हमारे ऊपर विश्राम करने के लिए छोड़ दो।

इसके बजाय आप क्या होने की उम्मीद करते हैं?

अपेक्षित और वास्तविक अनुरोध आईडी (लिंक किए गए आउटपुट से) मेल खाते हैं।

अन्य सूचना

कोड को ठीक करना संभव नहीं है ताकि वास्तविक अनुरोध आईडी मेल खा सकें, इसलिए इस समस्या का समाधान उपयोगकर्ताओं को defaultMetadata पर फ़ील्ड के रूप में कार्यों को निर्दिष्ट करने की अनुमति देना होगा जो लॉगर को कॉल किए जाने पर लागू हो जाते हैं। इस तरह, कोड इस में बदल जाएगा, जो उपयोगकर्ताओं को अनुरोध आईडी के बारे में किसी भी जागरूकता के बिना अपना कोड लिखने की अनुमति देता है, छोटे चेतावनी के साथ कि वे defaultMetadata फ़ील्ड के रूप में एक थंक प्रदान करते हैं (शायद हमारा मॉड्यूल इसके लिए प्रदान करेगा उन्हें उपयोग करने के लिए)।