लॉग लिखें और देखें


कोड को डीबग और मॉनिटर करने के लिए, लॉग करना एक अहम टूल है. Cloud Functions, आपको इसके लॉगर SDK टूल, पसंद के मुताबिक Google Cloud Logging या वेब के लिए डेवलप करने के लिए console ऑब्जेक्ट स्टैंडर्ड का इस्तेमाल करने का विकल्प देता है.

लेखन लॉग

हालांकि, ज़्यादातर मामलों में Cloud Functions लॉगर SDK टूल इस्तेमाल करने का सुझाव दिया जाता है. हालाँकि, इन वजहों से अन्य विकल्पों में से किसी एक को चुना जा सकता है:

  • आपके पास एक मौजूदा कोड बेस है. इसलिए, आपको console.log से इस कोड को रीफ़ैक्टर नहीं करना है.
  • आपको Cloud Logging के बारे में पता है, जिसे पहले StackDriver लॉगिंग कहा जाता था. साथ ही, आपको कस्टम लॉगिंग के लिए इसका इस्तेमाल करना पसंद है.

Cloud Functions लॉगर SDK टूल का इस्तेमाल करना

Cloud Functions लॉगर SDK टूल एक स्टैंडर्ड इंटरफ़ेस उपलब्ध कराता है, जिसमें console.log स्टेटमेंट से मिलता-जुलता एपीआई होता है. साथ ही, यह अन्य लॉग लेवल के साथ काम करता है. इस SDK टूल का इस्तेमाल करके, स्ट्रक्चर्ड डेटा की मदद से इवेंट लॉग किए जा सकते हैं. इससे विश्लेषण और निगरानी करना आसान हो जाएगा.

लॉगर SDK टूल, वाइल्डकार्ड इंपोर्ट के हिस्से के तौर पर लॉग एंट्री की सुविधा देता है. जैसे:

  const functions = require("firebase-functions");

  functions.logger.log("Hello from info. Here's an object:", someObj);

इसके अलावा, आपके पास अलग-अलग एक्सपोर्ट का इस्तेमाल करने का विकल्प भी है. इस उदाहरण में, लॉग में जोड़े गए स्ट्रक्चर्ड डेटा को आखिरी तर्क के तौर पर दिखाया गया है:

const { warn } = require("firebase-functions/logger");


// Attach structured data to the log as the last argument.
warn("This is a 'WARNING' severity message with some metadata.", {
  key1: 'val1',
  key2: 'val2'
});
  • logger.log() निर्देशों में INFO लॉग लेवल होता है.
  • logger.info() निर्देशों में INFO लॉग लेवल होता है.
  • logger.warn() निर्देशों में चेतावनी का लॉग लेवल होता है.
  • logger.error() निर्देशों में गड़बड़ी का लॉग लेवल होता है.
  • इंटरनल सिस्टम मैसेज में डीबग लॉग लेवल होता है.

logger.write() का इस्तेमाल करके, CRITICAL, ALERT, और EMERGENCY लॉग एंट्री के लॉग में, गंभीरता के लेवल जोड़े जा सकते हैं. LogSeverity देखें.

कस्टम क्लाउड लॉगिंग लॉग

लॉगर SDK टूल के साथ Cloud Functions के लॉग, Cloud Logging का इस्तेमाल करते हैं. Node.js के लिए Cloud Logging लाइब्रेरी का इस्तेमाल करके, स्ट्रक्चर्ड डेटा के साथ इवेंट लॉग किए जा सकते हैं. इससे विश्लेषण और निगरानी करना आसान हो जाता है.

const { Logging } = require('@google-cloud/logging');

// ...

// Instantiate the logging SDK. The project ID will
// be automatically inferred from the Cloud Functions environment.
const logging = new Logging();
const log = logging.log('my-custom-log-name');

// This metadata is attached to each log entry. This specifies a fake
// Cloud Function called 'Custom Metrics' in order to make your custom
// log entries appear in the Cloud Functions logs viewer.
const METADATA = {
  resource: {
    type: 'cloud_function',
    labels: {
      function_name: 'CustomMetrics',
      region: 'us-central1'
    }
  }
};

// ...

// Data to write to the log. This can be a JSON object with any properties
// of the event you want to record.
const data = {
  event: 'my-event',
  value: 'foo-bar-baz',

  // Optional 'message' property will show up in the Firebase
  // console and other human-readable logging surfaces
  message: 'my-event: foo-bar-baz'
};

// Write to the log. The log.write() call returns a Promise if you want to
// make sure that the log was written successfully.
const entry = log.entry(METADATA, data);
log.write(entry);
index.js

console.log का इस्तेमाल करना

किसी फ़ंक्शन से लॉग इन करने के लिए, हमारा सुझाव है कि आप अपने प्लैटफ़ॉर्म के लिए लॉगर SDK का इस्तेमाल करें. Node.js के साथ console.log और console.error जैसे स्टैंडर्ड JavaScript लॉगिंग कॉल का इस्तेमाल किया जा सकता है, लेकिन आपको सबसे पहले एक खास मॉड्यूल की ज़रूरत होगी, ताकि स्टैंडर्ड तरीकों को सही तरीके से पैच किया जा सके:

require("firebase-functions/logger/compat");

लॉगर के साथ काम करने वाले मॉड्यूल की ज़रूरत पड़ने के बाद, अपने कोड में console.log() तरीके को सामान्य तरीके से इस्तेमाल किया जा सकता है:

exports.helloError = functions.https.onRequest((request, response) => {
  console.log('I am a log entry!');
  response.send('Hello World...');
});
index.js
  • console.log() निर्देशों में INFO लॉग लेवल होता है.
  • console.info() निर्देशों में INFO लॉग लेवल होता है.
  • console.warn() निर्देशों में गड़बड़ी का लॉग लेवल होता है.
  • console.error() निर्देशों में गड़बड़ी का लॉग लेवल होता है.
  • इंटरनल सिस्टम मैसेज में डीबग लॉग लेवल होता है.

लॉग देखना

Cloud Functions के लॉग या तो Google Cloud कंसोल, Cloud Logging के यूज़र इंटरफ़ेस (यूआई) में या firebase कमांड-लाइन टूल के ज़रिए देखे जा सकते हैं.

Firebase CLI का इस्तेमाल करना

firebase टूल की मदद से लॉग देखने के लिए, functions:log निर्देश का इस्तेमाल करें:

firebase functions:log

किसी खास फ़ंक्शन के लॉग देखने के लिए, फ़ंक्शन का नाम आर्ग्युमेंट के तौर पर डालें:

firebase functions:log --only <FUNCTION_NAME>

लॉग देखने के सभी विकल्पों की पूरी रेंज के लिए, functions:log के लिए सहायता देखें:

firebase help functions:log

Google Cloud Console का इस्तेमाल करना

Google Cloud Console में, फ़ंक्शन के लॉग देखे जा सकते हैं.

क्लाउड लॉगिंग यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करना

क्लाउड लॉगिंग यूज़र इंटरफ़ेस (यूआई) में Cloud Functions के लिए लॉग देखें.

लॉग का विश्लेषण किया जा रहा है

'क्लाउड लॉगिंग', लॉग के विश्लेषण टूल का एक बेहतरीन सुइट देता है. इसका इस्तेमाल करके अपने Cloud Functions को मॉनिटर किया जा सकता है.

चार्ट और सूचनाएं

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

चार्ट और सूचना से जुड़ी नीतियों में लॉग पर आधारित मेट्रिक का इस्तेमाल करने के तरीके के बारे में ज़्यादा जानने के लिए, चार्ट और सूचनाएं बनाना लेख पढ़ें.