जावास्क्रिप्ट एसिंक कॉन्टेक्स्ट वेरिएबल्स: रिक्वेस्ट ट्रैकिंग का एक गहरा विश्लेषण

एसिंक्रोनस प्रोग्रामिंग आधुनिक जावास्क्रिप्ट डेवलपमेंट का आधार है, विशेष रूप से Node.js जैसे वातावरण में। हालांकि, एसिंक्रोनस ऑपरेशनों में स्टेट और कॉन्टेक्स्ट का प्रबंधन करना चुनौतीपूर्ण हो सकता है। यहीं पर एसिंक कॉन्टेक्स्ट वेरिएबल्स (ACV) काम आते हैं। यह लेख मजबूत रिक्वेस्ट ट्रैकिंग और बेहतर डायग्नोस्टिक्स के लिए एसिंक कॉन्टेक्स्ट वेरिएबल्स को समझने और लागू करने के लिए एक व्यापक गाइड प्रदान करता है।

एसिंक कॉन्टेक्स्ट वेरिएबल्स क्या हैं?

एसिंक कॉन्टेक्स्ट वेरिएबल्स, जिन्हें Node.js में AsyncLocalStorage के रूप में भी जाना जाता है, डेटा को संग्रहीत और एक्सेस करने के लिए एक तंत्र प्रदान करते हैं जो वर्तमान एसिंक्रोनस निष्पादन कॉन्टेक्स्ट के लिए स्थानीय है। इसे अन्य भाषाओं में थ्रेड-लोकल स्टोरेज की तरह समझें, लेकिन जावास्क्रिप्ट की सिंगल-थ्रेडेड, इवेंट-ड्रिवन प्रकृति के लिए अनुकूलित। यह आपको एक एसिंक्रोनस ऑपरेशन के साथ डेटा को संबद्ध करने और उस ऑपरेशन के पूरे जीवनचक्र में इसे लगातार एक्सेस करने की अनुमति देता है, चाहे कितने भी एसिंक्रोनस कॉल किए जाएं।

रिक्वेस्ट ट्रैकिंग के पारंपरिक दृष्टिकोण, जैसे कि फंक्शन आर्गुमेंट्स के माध्यम से डेटा पास करना, एप्लिकेशन की जटिलता बढ़ने पर बोझिल और त्रुटि-प्रवण हो सकते हैं। एसिंक कॉन्टेक्स्ट वेरिएबल्स एक स्वच्छ, अधिक रखरखाव योग्य समाधान प्रदान करते हैं।

रिक्वेस्ट ट्रैकिंग के लिए एसिंक कॉन्टेक्स्ट वेरिएबल्स का उपयोग क्यों करें?

रिक्वेस्ट ट्रैकिंग कई कारणों से महत्वपूर्ण है:

• डीबगिंग: जब कोई त्रुटि होती है, तो आपको उस संदर्भ को समझने की आवश्यकता होती है जिसमें यह हुई थी। रिक्वेस्ट आईडी, यूजर आईडी और अन्य प्रासंगिक डेटा समस्या के स्रोत का पता लगाने में मदद कर सकते हैं।
• लॉगिंग: रिक्वेस्ट-विशिष्ट जानकारी के साथ लॉग संदेशों को समृद्ध करने से रिक्वेस्ट के निष्पादन प्रवाह को ट्रेस करना और प्रदर्शन की बाधाओं को पहचानना आसान हो जाता है।
• परफॉरमेंस मॉनिटरिंग: रिक्वेस्ट की अवधि और संसाधन उपयोग को ट्रैक करने से धीमे एंडपॉइंट्स की पहचान करने और एप्लिकेशन के प्रदर्शन को अनुकूलित करने में मदद मिल सकती है।
• सुरक्षा ऑडिटिंग: उपयोगकर्ता कार्यों और संबंधित डेटा को लॉग करना सुरक्षा ऑडिट और अनुपालन उद्देश्यों के लिए मूल्यवान अंतर्दृष्टि प्रदान कर सकता है।

एसिंक कॉन्टेक्स्ट वेरिएबल्स रिक्वेस्ट-विशिष्ट डेटा के लिए एक केंद्रीय, आसानी से सुलभ भंडार प्रदान करके रिक्वेस्ट ट्रैकिंग को सरल बनाते हैं। यह कई फंक्शन कॉल्स और एसिंक्रोनस ऑपरेशनों के माध्यम से कॉन्टेक्स्ट डेटा को मैन्युअल रूप से प्रसारित करने की आवश्यकता को समाप्त करता है।

Node.js में एसिंक कॉन्टेक्स्ट वेरिएबल्स को लागू करना

Node.js async_hooks मॉड्यूल प्रदान करता है, जिसमें एसिंक्रोनस कॉन्टेक्स्ट के प्रबंधन के लिए AsyncLocalStorage क्लास शामिल है। यहाँ एक मूल उदाहरण है:

उदाहरण: AsyncLocalStorage के साथ बेसिक रिक्वेस्ट ट्रैकिंग

सबसे पहले, आवश्यक मॉड्यूल आयात करें:

            const { AsyncLocalStorage } = require('async_hooks');
const http = require('http');

            

              
                Copy
              
            
          

AsyncLocalStorage का एक इंस्टेंस बनाएं:

            const asyncLocalStorage = new AsyncLocalStorage();

            

              
                Copy
              
            
          

एक HTTP सर्वर बनाएं जो रिक्वेस्ट आईडी को स्टोर करने और पुनर्प्राप्त करने के लिए AsyncLocalStorage का उपयोग करता है:

            const server = http.createServer((req, res) => {
  const requestId = Math.random().toString(36).substring(2, 15);

  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('requestId', requestId);

    console.log(`Request ID: ${asyncLocalStorage.getStore().get('requestId')}`);

    setTimeout(() => {
      console.log(`Request ID inside timeout: ${asyncLocalStorage.getStore().get('requestId')}`);
      res.end('Hello, world!');
    }, 100);
  });
});

            

              
                Copy
              
            
          

सर्वर शुरू करें:

            server.listen(3000, () => {
  console.log('Server listening on port 3000');
});

            

              
                Copy
              
            
          

इस उदाहरण में, asyncLocalStorage.run() एक नया एसिंक्रोनस कॉन्टेक्स्ट बनाता है। इस कॉन्टेक्स्ट के भीतर, हम requestId सेट करते हैं। setTimeout फ़ंक्शन, जो एसिंक्रोनस रूप से निष्पादित होता है, अभी भी requestId तक पहुंच सकता है क्योंकि यह उसी एसिंक्रोनस कॉन्टेक्स्ट के भीतर है।

व्याख्या

• AsyncLocalStorage: एसिंक्रोनस कॉन्टेक्स्ट के प्रबंधन के लिए API प्रदान करता है।
• asyncLocalStorage.run(store, callback): एक नए एसिंक्रोनस कॉन्टेक्स्ट के भीतर callback फ़ंक्शन को निष्पादित करता है। store तर्क कॉन्टेक्स्ट के लिए एक प्रारंभिक मान है (उदाहरण के लिए, एक Map या एक ऑब्जेक्ट)।
• asyncLocalStorage.getStore(): वर्तमान एसिंक्रोनस कॉन्टेक्स्ट का स्टोर लौटाता है।

उन्नत रिक्वेस्ट ट्रैकिंग परिदृश्य

मूल उदाहरण मौलिक सिद्धांतों को प्रदर्शित करता है। यहाँ और अधिक उन्नत परिदृश्य हैं:

परिदृश्य 1: डेटाबेस के साथ एकीकरण

आप डेटाबेस क्वेरी में रिक्वेस्ट आईडी को स्वचालित रूप से शामिल करने के लिए एसिंक कॉन्टेक्स्ट वेरिएबल्स का उपयोग कर सकते हैं। यह डेटाबेस इंटरैक्शन की ऑडिटिंग और डीबगिंग के लिए विशेष रूप से उपयोगी है।

            const { AsyncLocalStorage } = require('async_hooks');
const http = require('http');
const { Pool } = require('pg'); // Assuming PostgreSQL

const asyncLocalStorage = new AsyncLocalStorage();

const pool = new Pool({
  user: 'your_user',
  host: 'your_host',
  database: 'your_database',
  password: 'your_password',
  port: 5432,
});

// Function to execute a query with request ID
async function executeQuery(queryText, values = []) {
  const requestId = asyncLocalStorage.getStore()?.get('requestId') || 'unknown';
  const enrichedQueryText = `/* requestId: ${requestId} */ ${queryText}`;
  try {
     const res = await pool.query(enrichedQueryText, values);
     return res;
  } catch (err) {
     console.error("Error executing query:", err);
     throw err;
  }

}

const server = http.createServer(async (req, res) => {
  const requestId = Math.random().toString(36).substring(2, 15);

  asyncLocalStorage.run(new Map(), async () => {
    asyncLocalStorage.getStore().set('requestId', requestId);

    console.log(`Request ID: ${asyncLocalStorage.getStore().get('requestId')}`);

    try {
      // Example: Insert data into a table
      const result = await executeQuery('SELECT NOW()');
      console.log("Query result:", result.rows);
      res.end('Hello, database!');
    } catch (error) {
      console.error("Request failed:", error);
      res.statusCode = 500;
      res.end('Internal Server Error');
    }

  });
});

server.listen(3000, () => {
  console.log('Server listening on port 3000');
});

            

              
                Copy
              
            
          

इस उदाहरण में, executeQuery फ़ंक्शन AsyncLocalStorage से रिक्वेस्ट आईडी प्राप्त करता है और इसे SQL क्वेरी में एक कमेंट के रूप में शामिल करता है। यह आपको आसानी से डेटाबेस क्वेरी को विशिष्ट रिक्वेस्ट से ट्रेस करने की अनुमति देता है।

परिदृश्य 2: डिस्ट्रिब्यूटेड ट्रेसिंग

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

इसमें आम तौर पर एक रिक्वेस्ट की शुरुआत में एक अद्वितीय ट्रेस आईडी बनाना और इसे सभी डाउनस्ट्रीम सेवाओं में प्रसारित करना शामिल है। यह HTTP हेडर में ट्रेस आईडी शामिल करके किया जा सकता है।

            const { AsyncLocalStorage } = require('async_hooks');
const http = require('http');
const https = require('https');

const asyncLocalStorage = new AsyncLocalStorage();

const server = http.createServer((req, res) => {
  const traceId = Math.random().toString(36).substring(2, 15);

  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('traceId', traceId);

    console.log(`Trace ID: ${asyncLocalStorage.getStore().get('traceId')}`);

    // Make a request to another service
    makeRequestToAnotherService(traceId)
      .then(data => {
        res.end(`Response from other service: ${data}`);
      })
      .catch(err => {
        console.error('Error making request:', err);
        res.statusCode = 500;
        res.end('Error from upstream service');
      });

  });
});

async function makeRequestToAnotherService(traceId) {
  return new Promise((resolve, reject) => {
    const options = {
      hostname: 'example.com',
      port: 443,
      path: '/',
      method: 'GET',
      headers: {
        'X-Trace-ID': traceId, // Propagate trace ID in HTTP header
      },
    };

    const req = https.request(options, (res) => {
      let data = '';

      res.on('data', (chunk) => {
        data += chunk;
      });

      res.on('end', () => {
        resolve(data);
      });
    });

    req.on('error', (error) => {
      reject(error);
    });

    req.end();
  });
}

server.listen(3000, () => {
  console.log('Server listening on port 3000');
});

            

              
                Copy
              
            
          

प्राप्त करने वाली सेवा तब HTTP हेडर से ट्रेस आईडी निकाल सकती है और इसे अपने स्वयं के AsyncLocalStorage में संग्रहीत कर सकती है। यह ट्रेस आईडी की एक श्रृंखला बनाता है जो कई सेवाओं तक फैली हुई है, जिससे एंड-टू-एंड रिक्वेस्ट ट्रेसिंग सक्षम होती है।

परिदृश्य 3: लॉगिंग कोरिलेशन

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

स्वचालित लॉगिंग सहसंबंध के लिए Winston को कॉन्फ़िगर करने का तरीका यहां दिया गया है:

            const { AsyncLocalStorage } = require('async_hooks');
const http = require('http');
const winston = require('winston');

const asyncLocalStorage = new AsyncLocalStorage();

// Configure Winston logger
const logger = winston.createLogger({
  level: 'info',
  format: winston.format.combine(
    winston.format.timestamp(),
    winston.format.printf(({ timestamp, level, message }) => {
      const requestId = asyncLocalStorage.getStore()?.get('requestId') || 'unknown';
      return `${timestamp} [${level}] [requestId:${requestId}] ${message}`;
    })
  ),
  transports: [
    new winston.transports.Console(),
  ],
});

const server = http.createServer((req, res) => {
  const requestId = Math.random().toString(36).substring(2, 15);

  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('requestId', requestId);

    logger.info('Request received');

    setTimeout(() => {
      logger.info('Processing request...');
      res.end('Hello, logging!');
    }, 100);
  });
});

server.listen(3000, () => {
  console.log('Server listening on port 3000');
});

            

              
                Copy
              
            
          

Winston लॉगर को AsyncLocalStorage से रिक्वेस्ट आईडी शामिल करने के लिए कॉन्फ़िगर करके, रिक्वेस्ट कॉन्टेक्स्ट के भीतर सभी लॉग संदेश स्वचालित रूप से रिक्वेस्ट आईडी के साथ टैग हो जाएंगे।

एसिंक कॉन्टेक्स्ट वेरिएबल्स का उपयोग करने के लिए सर्वोत्तम प्रथाएं

• AsyncLocalStorage को जल्दी प्रारंभ करें: अपने एप्लिकेशन के जीवनचक्र में जितनी जल्दी हो सके अपने AsyncLocalStorage इंस्टेंस को बनाएं और प्रारंभ करें। यह सुनिश्चित करता है कि यह आपके पूरे एप्लिकेशन में उपलब्ध है।
• एक सुसंगत नामकरण परंपरा का उपयोग करें: अपने कॉन्टेक्स्ट वेरिएबल्स के लिए एक सुसंगत नामकरण परंपरा स्थापित करें। इससे आपके कोड को समझना और बनाए रखना आसान हो जाता है। उदाहरण के लिए, आप सभी कॉन्टेक्स्ट वेरिएबल नामों को acv_ के साथ प्रीफिक्स कर सकते हैं।
• कॉन्टेक्स्ट डेटा को कम करें: एसिंक कॉन्टेक्स्ट में केवल आवश्यक डेटा संग्रहीत करें। बड़े कॉन्टेक्स्ट ऑब्जेक्ट प्रदर्शन को प्रभावित कर सकते हैं। ऑब्जेक्ट्स को स्वयं संग्रहीत करने के बजाय अन्य ऑब्जेक्ट्स के संदर्भ संग्रहीत करने पर विचार करें।
• त्रुटियों को सावधानी से संभालें: सुनिश्चित करें कि आपकी त्रुटि प्रबंधन तर्क एसिंक कॉन्टेक्स्ट को ठीक से साफ करता है। अनकैच्ड अपवाद कॉन्टेक्स्ट को एक असंगत स्थिति में छोड़ सकते हैं।
• प्रदर्शन निहितार्थों पर विचार करें: जबकि AsyncLocalStorage आम तौर पर प्रदर्शनकारी होता है, अत्यधिक उपयोग या बड़े कॉन्टेक्स्ट ऑब्जेक्ट प्रदर्शन को प्रभावित कर सकते हैं। AsyncLocalStorage को लागू करने के बाद अपने एप्लिकेशन के प्रदर्शन को मापें।
• लाइब्रेरी में सावधानी के साथ उपयोग करें: दूसरों द्वारा उपभोग की जाने वाली लाइब्रेरी के भीतर AsyncLocalStorage का उपयोग करने से बचें, क्योंकि यह अप्रत्याशित व्यवहार और उपभोक्ता एप्लिकेशन के AsyncLocalStorage के अपने उपयोग के साथ टकराव का कारण बन सकता है।

एसिंक कॉन्टेक्स्ट वेरिएबल्स के विकल्प

हालांकि एसिंक कॉन्टेक्स्ट वेरिएबल्स रिक्वेस्ट ट्रैकिंग के लिए एक शक्तिशाली समाधान प्रदान करते हैं, वैकल्पिक दृष्टिकोण भी मौजूद हैं:

• मैनुअल कॉन्टेक्स्ट प्रोपेगेशन: कॉन्टेक्स्ट डेटा को फंक्शन आर्गुमेंट्स के रूप में पास करना। यह दृष्टिकोण छोटे अनुप्रयोगों के लिए सरल है, लेकिन जटिलता बढ़ने पर बोझिल और त्रुटि-प्रवण हो जाता है।
• मिडलवेयर: रिक्वेस्ट ऑब्जेक्ट्स में कॉन्टेक्स्ट डेटा इंजेक्ट करने के लिए मिडलवेयर का उपयोग करना। यह दृष्टिकोण Express.js जैसे वेब फ्रेमवर्क में आम है।
• कॉन्टेक्स्ट प्रोपेगेशन लाइब्रेरी: वे लाइब्रेरी जो कॉन्टेक्स्ट प्रोपेगेशन के लिए उच्च-स्तरीय एब्स्ट्रैक्शन प्रदान करती हैं। ये लाइब्रेरी जटिल ट्रेसिंग परिदृश्यों के कार्यान्वयन को सरल बना सकती हैं।

दृष्टिकोण का चुनाव आपके एप्लिकेशन की विशिष्ट आवश्यकताओं पर निर्भर करता है। एसिंक कॉन्टेक्स्ट वेरिएबल्स विशेष रूप से जटिल एसिंक्रोनस वर्कफ़्लोज़ के लिए उपयुक्त हैं जहां मैनुअल कॉन्टेक्स्ट प्रोपेगेशन को प्रबंधित करना मुश्किल हो जाता है।

निष्कर्ष

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