क्लाउड फ़ंक्शन के लिए स्टैकड्राइवर लॉगिंग और स्टैकड्राइवर ट्रेस का इस्तेमाल करें

1. परिचय

इस कोडलैब में, आपको लॉगिंग और मॉनिटरिंग टूल का इस्तेमाल करने का तरीका बताया जाएगा. ये टूल, Cloud Functions का इस्तेमाल करने वाले सभी डेवलपर के लिए उपलब्ध हैं. ये टूल, Cloud Functions की हर उस सुविधा के साथ उपलब्ध होते हैं जिसे Google Ads पर टारगेटिंग के लिए मौजूद सभी भाषाओं में डिप्लॉय किया जाता है. इनकी मदद से, बिना सर्वर वाले कोड को लिखने और उसे चलाने के दौरान, आपको ज़्यादा काम करने में मदद मिलती है.

आपको एचटीटीपी ट्रिगर किए गए Cloud फ़ंक्शन का इस्तेमाल करना होगा. हालांकि, आपने जो भी सीखा है वह अन्य भाषाओं और अन्य इवेंट से ट्रिगर किए गए Cloud फ़ंक्शन पर भी लागू होता है.

2. सेटअप और ज़रूरी शर्तें

अपने हिसाब से एनवायरमेंट सेट अप करना

1. Cloud Console में साइन इन करें. इसके बाद, नया प्रोजेक्ट बनाएं या किसी मौजूदा प्रोजेक्ट का फिर से इस्तेमाल करें. (अगर आपके पास पहले से Gmail या G Suite खाता नहीं है, तो आपको एक खाता बनाना होगा.)

ध्यान दें: Cloud Console के यूआरएल को याद रखकर, इसे आसानी से ऐक्सेस किया जा सकता है. इसका यूआरएल console.cloud.google.com है.

प्रोजेक्ट आईडी याद रखें. यह सभी Google Cloud प्रोजेक्ट के लिए एक यूनीक नाम होता है. ऊपर दिया गया नाम पहले ही इस्तेमाल किया जा चुका है. इसलिए, यह आपके लिए काम नहीं करेगा. माफ़ करें! इस कोडलैब में इसे बाद में PROJECT_ID के तौर पर दिखाया जाएगा.

ध्यान दें: अगर Gmail खाते का इस्तेमाल किया जा रहा है, तो डिफ़ॉल्ट जगह को कोई संगठन नहीं पर सेट किया जा सकता है. अगर G Suite खाते का इस्तेमाल किया जा रहा है, तो अपने संगठन के हिसाब से कोई जगह चुनें.

2. इसके बाद, Google Cloud संसाधनों का इस्तेमाल करने के लिए, आपको Cloud Console में बिलिंग चालू करनी होगी.

इस कोडलैब को पूरा करने में ज़्यादा खर्च नहीं आएगा. "सफ़ाई करना" सेक्शन में दिए गए निर्देशों का पालन करना न भूलें. इसमें आपको संसाधनों को बंद करने का तरीका बताया गया है, ताकि इस ट्यूटोरियल के बाद आपको बिलिंग न करनी पड़े. Google Cloud के नए उपयोगकर्ता, 300 डॉलर का क्रेडिट मुफ़्त में आज़माने के प्रोग्राम के लिए ज़रूरी शर्तें पूरी करते हैं.

Cloud Shell

Cloud Functions के साथ-साथ, इसकी लॉगिंग और मॉनिटरिंग की सुविधाओं को अपने लैपटॉप से दूर से ही इस्तेमाल किया जा सकता है. हालांकि, आपको Cloud Shell का इस्तेमाल करना होगा. यह Google Cloud में चलने वाला कमांड-लाइन एनवायरमेंट है.

यह Debian पर आधारित वर्चुअल मशीन है. इसमें आपको डेवलपमेंट के लिए ज़रूरी सभी टूल मिलेंगे. यह 5 जीबी की होम डायरेक्ट्री उपलब्ध कराता है और Google Cloud में चलता है. इससे नेटवर्क की परफ़ॉर्मेंस और पुष्टि करने की प्रोसेस बेहतर होती है. इसका मतलब है कि इस कोडलैब के लिए, आपको सिर्फ़ एक ब्राउज़र की ज़रूरत होगी. हां, यह Chromebook पर भी काम करता है.

1. Cloud Console से Cloud Shell चालू करने के लिए, बस Cloud Shell चालू करें पर क्लिक करें. इसे चालू होने और एनवायरमेंट से कनेक्ट होने में कुछ ही समय लगेगा.

Cloud Shell से कनेक्ट होने के बाद, आपको दिखेगा कि आपकी पुष्टि पहले ही हो चुकी है और प्रोजेक्ट पहले से ही आपके PROJECT_ID पर सेट है.

gcloud auth list

कमांड का आउटपुट

Credentialed accounts:
 - <myaccount>@<mydomain>.com (active)

ध्यान दें: gcloud कमांड-लाइन टूल, Cloud Shell में पहले से इंस्टॉल होता है. साथ ही, आपको टैब पूरा करने की सुविधा का फ़ायदा ज़रूर मिलेगा. ज़्यादा जानकारी के लिए, gcloud कमांड-लाइन टूल की खास जानकारी देखें.

gcloud config list project

कमांड का आउटपुट

[core]
project = <PROJECT_ID>

अगर किसी वजह से प्रोजेक्ट सेट नहीं है, तो यह कमांड दें:

gcloud config set project <PROJECT_ID>

क्या आपको PROJECT_ID की तलाश है? देखें कि आपने सेटअप के चरणों में किस आईडी का इस्तेमाल किया है या इसे Cloud Console के डैशबोर्ड में देखें:

Cloud Shell, कुछ एनवायरमेंट वैरिएबल को डिफ़ॉल्ट रूप से भी सेट करता है. ये वैरिएबल, आने वाले समय में कमांड चलाने के दौरान आपके काम आ सकते हैं.

echo $GOOGLE_CLOUD_PROJECT

कमांड का आउटपुट

<PROJECT_ID>

2. आखिर में, डिफ़ॉल्ट ज़ोन और प्रोजेक्ट कॉन्फ़िगरेशन सेट करें.

gcloud config set compute/zone us-central1-f

आपके पास अलग-अलग ज़ोन चुनने का विकल्प होता है. ज़्यादा जानकारी के लिए, रीजन और ज़ोन देखें.

ध्यान दें: अपनी मशीन पर gcloud चलाने पर, कॉन्फ़िगरेशन सेटिंग सभी सेशन में बनी रहती हैं. हालांकि, Cloud Shell में आपको हर नए सेशन या फिर से कनेक्ट करने के लिए, इसे सेट करना होगा.

3. कोई सामान्य Cloud फ़ंक्शन डिप्लॉय करना

मॉनिटर करने के लिए, "Hello, World" Cloud फ़ंक्शन बनाएं. Google Cloud Console के बाईं ओर मौजूद मेन्यू में, Cloud Functions पर क्लिक करें. इसके बाद, Create Function पर क्लिक करें.

अपनी नई Cloud फ़ंक्शन का नाम "hello-monitor" डालें.

सोर्स कोड के लिए सभी डिफ़ॉल्ट सेटिंग को बनाए रखें. (हालांकि, अगर आपको कोई दूसरी भाषा/रनटाइम चुनना है, तो ऐसा किया जा सकता है.)

आखिर में, बनाएं पर क्लिक करें.

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

4. Cloud Function की जांच करें और लोड जनरेटर का इस्तेमाल करके ट्रैफ़िक भेजें

Cloud Functions को डिप्लॉय करने के बाद, कमांड लाइन से इसकी जांच करें.

सबसे पहले, Cloud Shell का इस्तेमाल करके यह निर्देश चलाएं:

$ gcloud functions describe hello-monitor

इससे Cloud Function का ब्यौरा मिलेगा. इसमें httpsTrigger के लिए यूआरएल भी शामिल होगा. यह Cloud Function को शुरू करने के लिए एचटीटीपी(एस) एंडपॉइंट है. यह इस तरह दिखना चाहिए: https://<region>-<project-id>.cloudfunctions.net/hello-monitor.

अब Cloud Function को ट्रिगर करना उतना ही आसान होना चाहिए जितना उस यूआरएल पर curl कमांड का इस्तेमाल करना.

$ curl https://<region>-<project-id>.cloudfunctions.net/hello-monitor
Hello World!

अब Vegeta का इस्तेमाल करें. यह एक सामान्य एचटीटीपी लोड-टेस्टिंग टूल है. इसे इंस्टॉल करने के लिए, Cloud Shell में यह कमांड टाइप करें :

$ go get -u github.com/tsenart/vegeta

अपने Cloud फ़ंक्शन पर कुछ ट्रैफ़िक भेजने के लिए, यहां दिए गए निर्देश का इस्तेमाल करें. इससे कुछ मिनटों के लिए, हर सेकंड पांच अनुरोध भेजे जा सकेंगे:

$ echo "GET https://<region>-<project-id>.cloudfunctions.net/hello-monitor" \
   | vegeta attack -rate=5 -duration=120s \
   > results.bin

5. लॉग में नेविगेट करना

Cloud Functions की जानकारी वाले पेज पर, लॉग देखें पर क्लिक करें.

इससे आपको अपने प्रोजेक्ट के Stackdriver Logging सेक्शन पर ले जाना चाहिए. इसमें आपको सिर्फ़ अपने Cloud Function के लॉग दिखेंगे.

आपके Cloud Function को भेजे गए सभी अनुरोधों के लिए, 200 स्टेटस कोड दिखना चाहिए.

लॉग देखते समय, ये काम किए जा सकते हैं:

• लॉग लेवल के हिसाब से फ़िल्टर करें. आपके मामले में, सभी लॉग debug लेवल के हैं.
• कोई खास समयावधि चुनें (रिलेटिव या ऐब्सलूट).
• लॉग स्ट्रीमिंग की सुविधा चालू करें (स्क्रीन पर सबसे ऊपर Play होना चाहिए).
• लॉग एंट्री का लिंक कॉपी करें, ताकि इसे टीम के सदस्यों के साथ शेयर किया जा सके.
• संसाधन के कॉन्टेक्स्ट में लॉग एंट्री दिखाएं.
• किसी लॉग एंट्री को पिन करें (विज़ुअल क्यू के तौर पर).
• लॉग को BigQuery, Cloud Storage या Pub/Sub में एक्सपोर्ट करें. इसके अलावा, इन्हें JSON या CSV फ़ाइलों के तौर पर डाउनलोड भी किया जा सकता है.

ध्यान दें: आपके Cloud Functions कोड में, स्टैंडर्ड आउटपुट के लॉग, __INFO__ लॉग लेवल के साथ दिखेंगे. साथ ही, स्टैंडर्ड एरर के लॉग, __ERROR__ लॉग लेवल के साथ दिखेंगे. सिस्टम के इंटरनल मैसेज का लॉग लेवल __DEBUG__ होता है.

ध्यान दें: सबसे ऊपर बाईं ओर मौजूद सिलेक्टर की मदद से, फ़ंक्शन के हिसाब से लॉग फ़िल्टर किए जा सकते हैं. इसके अलावा, विंडो में सबसे ऊपर मौजूद खोज बार में जाकर, लेबल खोजे जा सकते हैं या पूरा टेक्स्ट खोजा जा सकता है. आपके मामले में, लेबल hello-monitor (फ़ंक्शन का नाम) और हर अनुरोध के लिए एक एक्ज़ीक्यूशन आइडेंटिफ़ायर है.

फ़िल्टर को शेयर करने के लिए कॉपी भी किया जा सकता है. इसके लिए, खोज बॉक्स में मौजूद ड्रॉप-डाउन मेन्यू देखें.

ध्यान दें: ग्राफ़िकल टूल के अलावा, Cloud Functions के लॉग को gcloud functions logs read का इस्तेमाल करके भी ऐक्सेस किया जा सकता है. साथ ही, यहां दिए गए एपीआई के ज़रिए भी इन्हें ऐक्सेस किया जा सकता है.

6. फ़ंक्शन को अपडेट करना

Cloud Console का इस्तेमाल करके, फ़ंक्शन की जानकारी वाले व्यू पर जाएं. इसके बाद, लोड टेस्टर का इस्तेमाल करके, हर सेकंड में किए गए अनुरोधों की संख्या और उनके एक्ज़ीक्यूशन टाइम में हुई बढ़ोतरी देखें.

लेटेंसी और आरपीसी कॉल को मॉनिटर करने के लिए, Stackdriver Trace एक और टूल है. हालांकि, इसका इस्तेमाल करने से पहले आपको अपनी Cloud Functions में कुछ बदलाव करने होंगे. तो निम्न कार्य करें:

1. लाइफ़ सेविंग node-emoji पैकेज को डिपेंडेंसी के तौर पर जोड़ें.
2. node-emoji मॉड्यूल का इस्तेमाल करने के लिए, फ़ंक्शन कोड को अपडेट करें और कुछ समय के लिए इंतज़ार करें.
3. Cloud Functions के लिए Stackdriver Trace चालू करने के लिए, एनवायरमेंट वैरिएबल जोड़ें.

फ़ंक्शन में बदलाव करने के लिए, फ़ंक्शन की जानकारी में जाकर, बदलाव करें पर क्लिक करें.

node-emoji पैकेज के लिए डिपेंडेंसी जोड़ने के लिए, package.json फ़ाइल में बदलाव करें.

{
  "name": "sample-http",
  "version": "0.0.1",
  "dependencies": {
    "node-emoji": "^1.8.1"
  }
}

फ़ंक्शन में बदलाव करने के लिए, index.js के कॉन्टेंट को बदलकर यह करें:

const emoji = require('node-emoji');

exports.helloWorld = (req, res) => {
  let message = req.query.message || req.body.message || 'Hello World!';

  // add some latency, functions are too quick!
  setTimeout(function() {
     message += emoji.random().emoji;  
     res.status(200).send(message);
  }, (3 * 100));  // 300ms
  
};

इससे Cloud Functions के जवाब में एक रैंडम इमोजी जुड़ जाता है. हालांकि, ऐसा 300 मिलीसेकंड के बाद होता है.

आखिर में, GOOGLE_CLOUD_TRACE_ENABLED नाम का Cloud फ़ंक्शन एनवायरमेंट वैरिएबल जोड़ें और उसे true पर सेट करें. ऐसा इस तरह करें:

सेव करें पर क्लिक करें.

Cloud Shell पर वापस जाएं और नए डिप्लॉय किए गए Cloud Function पर कुछ लोड जनरेट करने के लिए, कमांड को फिर से कॉल करें:

$ echo "GET https://<region>-<project-id>.cloudfunctions.net/hello-monitor" \
   | vegeta attack -rate=5 -duration=120s \
   > results.bin

अब आपको किसी अन्य सेटअप की ज़रूरत नहीं है. साथ ही, आपके कोड में कोई खास ट्रेसिंग लाइब्रेरी भी नहीं है. अब जनरेट किए गए ट्रेस की सूची देखी जा सकती है!

7. अपडेट किए गए Cloud फ़ंक्शन को ट्रेस करना

बाईं ओर मौजूद मेन्यू का इस्तेमाल करके, ट्रेस की सूची पर जाएं. यह Stackdriver Trace में मौजूद है.

आपको इस स्क्रीनशॉट की तरह कुछ दिखेगा:

इससे यह साफ़ तौर पर पता चलता है कि आपके Cloud फ़ंक्शन में हुई देरी को 300 मिलीसेकंड पर मापा गया है.

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

अगर आपको ज़ूम इन करना है, तो ग्राफ़ पर क्लिक करके खींचें और छोड़ें.

ज़ूम आउट करने के लिए, पेज पर सबसे ऊपर मौजूद, ज़ूम लेवल पहले जैसा करें पर क्लिक करें.

आपने एक ही Cloud फ़ंक्शन डिप्लॉय किया है. इसलिए, ग्राफ़ में सिर्फ़ GET यूआरआई पर किए गए hello-monitor अनुरोध दिख रहे हैं. हालांकि, एचटीटीपी स्टेटस (2XX, 3XX) या अनुरोध फ़िल्टर का इस्तेमाल करके, एचटीटीपी तरीके (GET, POST, DELETE) के हिसाब से ट्रेस फ़िल्टर किए जा सकते हैं.

बाईं ओर मौजूद मेन्यू में जाकर, खास जानकारी पर जाएं:

इस खास जानकारी वाले पेज पर, आपको हाल ही के ट्रेस और अन्य अहम जानकारी मिल सकती है.

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

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

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

8. संसाधन हटाने का समय

यह कोडलैब यहीं खत्म होता है!

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

9. आगे क्या करना है?

यहां कुछ और जानकारी दी गई है:

• Stackdriver Monitoring की लॉग-आधारित मेट्रिक
• Stackdriver Error Reporting

/