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


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

लॉग लिखना

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

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

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

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

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

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

  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() कमांड का लॉग लेवल ERROR होता है.
  • संगठन में एक से दूसरे उपयोगकर्ता को भेजे गए मैसेज का लॉग लेवल डीबग होता है.

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

कस्टम Cloud Logging लॉग

लॉगर 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() कमांड का लॉग लेवल ERROR होता है.
  • console.error() कमांड का लॉग लेवल 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 कंसोल का इस्तेमाल करना

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

Cloud Logging यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करना

Cloud Logging यूज़र इंटरफ़ेस में, Cloud Functions के लिए लॉग देखे जा सकते हैं.

लॉग का विश्लेषण करना

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

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

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

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