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

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

Cloud Logging, पैसे लेकर दी जाने वाली एक सेवा है. अगर आप बिना किसी शुल्क वाले कोटे से ज़्यादा इस्तेमाल करते हैं, तो आपसे शुल्क लिया जा सकता है. ज़्यादा जानकारी के लिए, Cloud Logging की कीमत देखें.

लॉग लिखना

Cloud Functions logger SDK का इस्तेमाल करना

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

logger सबपैकेज से इंपोर्ट करें:

Node.js

// All available logging functions
const {
  log,
  info,
  debug,
  warn,
  error,
  write,
} = require("firebase-functions/logger");

Python

from firebase_functions import logger

  • logger.log() कमांड का लॉग लेवल INFO होता है.

  • logger.info() कमांड का लॉग लेवल INFO होता है.

  • logger.warn() कमांड का लॉग लेवल WARNING होता है.

  • logger.error() कमांड का लॉग लेवल ERROR होता है.

  • logger.debug() कमांड का लॉग लेवल DEBUG होता है.

  • इंटरनल सिस्टम मैसेज का लॉग लेवल DEBUG होता है.

इस उदाहरण में, एक फ़ंक्शन बुनियादी लॉग लिख रहा है:

Node.js

exports.helloWorld = onRequest((request, response) => {
  // sends a log to Cloud Logging
  log("Hello logs!");

  response.send("Hello from Firebase!");
});

Python

@https_fn.on_request()
def hello_world(req: https_fn.Request) -> https_fn.Response:
    # sends a log to Cloud Logging
    logger.log("Hello logs!")

    return https_fn.Response("Hello from Firebase!")

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

Node.js

exports.getInspirationalQuote = onRequest(async (request, response) => {
  const db = getFirestore();
  const today = new Date();
  const quoteOfTheMonthRef = db
      .collection("quotes")
      .doc(`${today.getFullYear()}`)
      .collection("months")
      .doc(`${today.getMonth()}`);

  const DEFAULT_QUOTE =
      "You miss 100% of the shots you don't take. -Wayne Gretzky";
  let quote;
  try {
    const quoteOfTheMonthDocSnap = await quoteOfTheMonthRef.get();

    // Attach relevant debugging information with debug()
    debug("Monthly quote fetch result", {
      docRef: quoteOfTheMonthRef.path,
      exists: quoteOfTheMonthDocSnap.exists,
      createTime: quoteOfTheMonthDocSnap.createTime,
    });

    if (quoteOfTheMonthDocSnap.exists) {
      quote = quoteOfTheMonthDocSnap.data().text;
    } else {
      // Use warn() for lower-severity issues than error()
      warn("Quote not found for month, sending default instead", {
        docRef: quoteOfTheMonthRef.path,
        dateRequested: today.toLocaleDateString("en-US"),
      });

      quote = DEFAULT_QUOTE;
    }
  } catch (err) {
    // Attach an error object as the second argument
    error("Unable to read quote from Firestore, sending default instead",
        err);

    quote = DEFAULT_QUOTE;
  }

  // Attach relevant structured data to any log
  info("Sending a quote!", {quote: quote});
  response.json({inspirationalQuote: quote});
});

Python

@https_fn.on_request()
def get_inspirational_quote(req: https_fn.Request) -> https_fn.Response:
    firestore_client = firestore.client()
    today = datetime.date.today()
    quote_of_the_month_ref = (
        firestore_client.collection("quotes")
        .doc(str(today.year))
        .collection("months")
        .doc(str(today.month))
    )

    default_quote = "Python has been an important part of Google since the beginning, and remains so as the system grows and evolves."

    quote = None
    try:
        quote_of_the_month = quote_of_the_month_ref.get()

        # Attach relevant debugging information with debug()
        logger.debug(
            "Monthly quote fetch result",
            docRef=quote_of_the_month.path,
            exists=quote_of_the_month.exists,
            createTime=quote_of_the_month.createTime,
        )

        if quote_of_the_month.exists:
            quote = quote_of_the_month.to_dict()["text"]
        else:
            # Use warn() for lower-severity issues than error()
            logger.warn(
                "Quote not found for month, sending default instead",
                doc_reference=quote_of_the_month.path,
                date_requested=today.strftime("%Y-%m-%d"),
            )
            quote = default_quote
    except:
        e = sys.exc_info()[0]
        # Attach an error object as the second argument
        logger.error("Unable to read quote from Firestore, sending default instead", error=e)
        quote = default_quote

    # Attach relevant structured data to any log
    logger.info("Sending a quote!", quote=quote)
    return https_fn.Response("Hello from Firebase!")

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

Node.js

exports.appHasARegression = onRegressionAlertPublished((event) => {
  write({
    // write() lets you set additional severity levels
    // beyond the built-in logger functions
    severity: "EMERGENCY",
    message: "Regression in production app",
    issue: event.data.payload.issue,
    lastOccurred: event.data.payload.resolveTime,
  });
});

Python

@crashlytics_fn.on_regression_alert_published()
def app_has_regression(alert: crashlytics_fn.CrashlyticsRegressionAlertEvent) -> None:
    logger.write(
        severity="EMERGENCY",
        message="Regression in production app",
        issue=alert.data.payload.issue,
        last_occurred=alert.data.payload.resolve_time,
    )
    print(alert)

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

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

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

logger के साथ काम करने वाले मॉड्यूल की ज़रूरत होने के बाद, अपने कोड में 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 Functions के लॉग, Google Cloud console, 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 Console में, फ़ंक्शन के लॉग देखे जा सकते हैं.Google Cloud

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

आप Cloud Logging यूज़र इंटरफ़ेस (यूआई) में Cloud Functions के लॉग देख सकते हैं.

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

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

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

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

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

एक्ज़ीक्यूशन आईडी को समझना और उसका इस्तेमाल करना

डिफ़ॉल्ट रूप से, Cloud Run फ़ंक्शन (दूसरी जनरेशन), एक ही फ़ंक्शन इंस्टेंस में कई अनुरोधों को एक साथ लागू करने की सुविधा देता है. इसका मतलब है कि अलग-अलग अनुरोधों के लॉग एक साथ दिख सकते हैं. इससे, एक ही एक्ज़ीक्यूशन के फ़्लो को समझना मुश्किल हो सकता है.

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

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

अपनी लॉग एंट्री में, एक्ज़ीक्यूशन आईडी को लॉग करने की सुविधा बंद करने के लिए, dotenv फ़ाइल में, एनवायरमेंट वैरिएबल LOG_EXECUTION_ID को 'false' पर सेट करें.

एक्ज़ीक्यूशन आईडी के हिसाब से लॉग ढूंढना और उन्हें आपस में जोड़ना

Cloud Logs Explorer में, एक्ज़ीक्यूशन आईडी के हिसाब से लॉग की जांच की जा सकती है और उन्हें आपस में जोड़ा जा सकता है.

  1. अपने फ़ंक्शन से लॉग एंट्री को बड़ा करें. एक्ज़ीक्यूशन आईडी, स्ट्रक्चर्ड लॉग डेटा में मौजूद होता है. यह लेबल में labels.execution_id के तौर पर नेस्ट किया गया होता है.

  2. उसी फ़ंक्शन के एक्ज़ीक्यूशन से जुड़े अन्य सभी लॉग देखने के लिए, execution_id की वैल्यू पर क्लिक करें और ड्रॉप-डाउन मेन्यू से "मिलती-जुलती एंट्री दिखाएं" को चुनें.

एक्ज़ीक्यूशन आईडी का इस्तेमाल करके, एक ही अनुरोध से जुड़े सभी लॉग मैसेज को एक साथ ग्रुप किया जा सकता है. भले ही, आपका फ़ंक्शन एक साथ कई अनुरोधों को हैंडल कर रहा हो.

कस्टम समरी फ़ील्ड की मदद से, लॉग की विज़िबिलिटी बढ़ाना

Logs Explorer में, एक्ज़ीक्यूशन आईडी को आसानी से दिखाने के लिए, इसे [कस्टम समरी फ़ील्ड][cloud-logging-preference] के तौर पर जोड़ा जा सकता है. एक्ज़ीक्यूशन आईडी को समरी फ़ील्ड के तौर पर जोड़ने के बाद, हर लॉग एंट्री में, लॉग लाइन की शुरुआत में एक्ज़ीक्यूशन आईडी, चिप के तौर पर दिखेगा. यह ठीक उसी तरह दिखेगा जैसे पहली जनरेशन के फ़ंक्शन में, सभी लॉग एंट्री के लिए एक्ज़ीक्यूशन आईडी दिखता था.

एक्ज़ीक्यूशन आईडी को समरी फ़ील्ड में जोड़ने के लिए:

  1. labels.execution_id में, स्ट्रक्चर्ड लॉग एंट्री में मौजूद एक्ज़ीक्यूशन आईडी की वैल्यू पर क्लिक करें.

  2. ड्रॉप-डाउन मेन्यू से, "फ़ील्ड को समरी लाइन में जोड़ें" को चुनें.

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