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


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

लॉग लिखना

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

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

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

क्लाउड फ़ंक्शन लॉगर 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() कमांड में WARNING का लॉग लेवल होता है.
  • logger.error() कमांड में ERROR लॉग लेवल है.
  • इंटरनल सिस्टम मैसेज में DEBUG लॉग लेवल होता है.

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

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

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

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);

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...');
});
  • console.log() कमांड का लॉग लेवल INFO होता है.
  • console.info() कमांड का लॉग लेवल INFO होता है.
  • console.warn() कमांड में ERROR लॉग लेवल है.
  • console.error() कमांड में ERROR लॉग लेवल है.
  • इंटरनल सिस्टम मैसेज में DEBUG लॉग लेवल होता है.

लॉग देखना

Cloud फ़ंक्शन के लॉग या तो Google Cloud कंसोल, क्लाउड लॉगिंग यूज़र इंटरफ़ेस (यूआई) या 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 Logging यूज़र इंटरफ़ेस (यूआई) में, Cloud फ़ंक्शन के लिए लॉग देखे जा सकते हैं.

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

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

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

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

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