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


कोड को डीबग और मॉनिटर करने के लिए, लॉग करना एक अहम टूल है. Cloud Functions, आपको अपने लॉगर SDK, कस्टम Google का इस्तेमाल करने का विकल्प देता है क्लाउड लॉगिंग या वेब के लिए डेवलप करने के लिए 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 के साथ इसके बजाय स्टैंडर्ड JavaScript लॉगिंग का इस्तेमाल करें जैसे कि console.log और console.error कॉल के लिए, लेकिन पहले आपको एक खास मॉड्यूल जोड़ें, ताकि स्टैंडर्ड तरीकों को ठीक से काम करने में मदद मिल सके:

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

लॉग देखना

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

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

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

Cloud Functions के लिए लॉग देखे जा सकते हैं को भी हटा सकते हैं.

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

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

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

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

इसके बारे में ज़्यादा जानकारी के लिए चार्ट और अलर्ट बनाना देखें का इस्तेमाल करें.