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

दूसरी पीढ़ी पहली पीढ़ी

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

लॉग लिखना

जबकि अधिकांश स्थितियों के लिए क्लाउड फ़ंक्शंस लॉगर एसडीके की अनुशंसा की जाती है, आप इन कारणों से अन्य विकल्पों में से एक चुन सकते हैं:

• आपके पास एक मौजूदा कोड आधार है और आप console.log से रिफैक्टर नहीं करना चाहते हैं।
• आप क्लाउड लॉगिंग (पूर्व में स्टैकड्राइवर लॉगिंग) से परिचित हैं और कस्टम लॉगिंग के लिए इसका उपयोग करना पसंद करते हैं।

क्लाउड फ़ंक्शंस लॉगर SDK का उपयोग करना

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

लॉगर एसडीके वाइल्डकार्ड आयात के हिस्से के रूप में लॉग प्रविष्टियों का समर्थन करता है। उदाहरण के लिए:

  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 के अलावा लॉग प्रविष्टियों के अलावा लॉग गंभीरता स्तर भी लिख सकते हैं। लॉगसेवरिटी देखें।

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

लॉगर एसडीके के साथ क्लाउड फ़ंक्शंस लॉग क्लाउड लॉगिंग द्वारा समर्थित हैं। आप आसान विश्लेषण और निगरानी को सक्षम करते हुए, संरचित डेटा के साथ ईवेंट लॉग करने के लिए 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);
index.js

नोट: क्लाउड लॉगिंग एक प्रभार्य सेवा है; यदि आप नो-कॉस्ट कोटा से अधिक हो जाते हैं तो आपको बिल भेजा जा सकता है। अधिक जानकारी के लिए, क्लाउड लॉगिंग मूल्य निर्धारण देखें।

console.log उपयोग करना

किसी फ़ंक्शन से लॉगिंग के लिए अनुशंसित समाधान आपके प्लेटफ़ॉर्म के लिए लॉगर एसडीके का उपयोग करना है। Node.js के साथ, आप इसके बजाय console.log और console.error जैसे मानक जावास्क्रिप्ट लॉगिंग कॉल का उपयोग कर सकते हैं, लेकिन सही ढंग से काम करने के लिए मानक तरीकों को पैच करने के लिए आपको पहले एक विशेष मॉड्यूल की आवश्यकता होगी:

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() कमांड में त्रुटि लॉग स्तर होता है।
• console.error() कमांड में ERROR लॉग स्तर होता है।
• आंतरिक सिस्टम संदेशों में DEBUG लॉग स्तर होता है।

लॉग देखना

क्लाउड फ़ंक्शंस के लिए लॉग या तो Google क्लाउड कंसोल , क्लाउड लॉगिंग यूआई, या firebase कमांड-लाइन टूल के माध्यम से देखे जा सकते हैं।

फायरबेस सीएलआई का उपयोग करना

firebase टूल के साथ लॉग देखने के लिए, functions:log कमांड का उपयोग करें:

firebase functions:log

किसी विशिष्ट फ़ंक्शन के लिए लॉग देखने के लिए, फ़ंक्शन नाम को तर्क के रूप में प्रदान करें:

firebase functions:log --only <FUNCTION_NAME>

लॉग देखने के विकल्पों की पूरी श्रृंखला के लिए, functions:log :

firebase help functions:log

Google क्लाउड कंसोल का उपयोग करना

आप Google क्लाउड कंसोल में फ़ंक्शंस के लिए लॉग देख सकते हैं।

क्लाउड लॉगिंग यूआई का उपयोग करना

आप क्लाउड लॉगिंग यूआई में क्लाउड फ़ंक्शंस के लिए लॉग देख सकते हैं।

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

क्लाउड लॉगिंग लॉग विश्लेषण टूल का एक शक्तिशाली सूट प्रदान करता है जिसका उपयोग आप अपने क्लाउड फ़ंक्शंस की निगरानी के लिए कर सकते हैं।

चार्ट और अलर्ट

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

चार्ट और अलर्ट नीतियों में लॉग-आधारित मेट्रिक्स का उपयोग करने के तरीके के बारे में विस्तृत जानकारी के लिए चार्ट और अलर्ट बनाना देखें।