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


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

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

लॉग लिखना

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

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

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 के अतिरिक्त लॉग गंभीरता के लेवल वाली लॉग एंट्री लिखी जा सकती हैं. लॉग की गंभीरता देखें.

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 का इस्तेमाल करना

किसी फ़ंक्शन से लॉग इन करने के लिए, आपको अपने प्लैटफ़ॉर्म के लिए लॉगर 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 को मॉनिटर करने के लिए किया जा सकता है.

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

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

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