ट्रेस टूल का इस्तेमाल करना

Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी

ट्रेस टूल क्या है?

Trace, Apigee Edge पर चल रहे एपीआई प्रॉक्सी की समस्या हल करने और उन्हें मॉनिटर करने का एक टूल है. ट्रेस करने की सुविधा से, एपीआई प्रॉक्सी फ़्लो के ज़रिए हर चरण की जानकारी की जांच की जा सकती है.

ट्रेस इस्तेमाल करने का तरीका

ट्रेस इस्तेमाल करना आसान है. ट्रेस सेशन शुरू करें, फिर Edge प्लैटफ़ॉर्म को एपीआई कॉल करें, और नतीजे पढ़ें.

1. नीचे बताए गए तरीके का इस्तेमाल करके, एपीआई प्रॉक्सी पेज को ऐक्सेस करें.
   

   Edge

   Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, एपीआई प्रॉक्सी पेज को ऐक्सेस करने के लिए:

   1. apigee.com/edge में साइन इन करें.
   2. बाएं नेविगेशन बार में, डेवलप करें > एपीआई प्रॉक्सी चुनें.

   क्लासिक एज (प्राइवेट क्लाउड)

   क्लासिक Edge यूज़र इंटरफ़ेस (यूआई) से एपीआई प्रॉक्सी पेज को ऐक्सेस करने के लिए:

   1. http://ms-ip:9000 में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.
   2. सबसे ऊपर मौजूद नेविगेशन बार में, एपीआई > एपीआई प्रॉक्सी चुनें.
2. API प्रॉक्सी पेज से कोई API प्रॉक्सी चुनें.
3. पक्का करें कि आपको जिस एपीआई को ट्रेस करना है उसे डिप्लॉय किया गया है.
4. ट्रेस टूल व्यू पर जाने के लिए, ट्रेस पर क्लिक करें.
5. यह चुनने के लिए कि आपको किस डिप्लॉयमेंट एनवायरमेंट और प्रॉक्सी रिविज़न को ट्रेस करना है, ट्रेस करने के लिए डिप्लॉयमेंट ड्रॉप-डाउन मेन्यू का इस्तेमाल करें.
6. ट्रेस सेशन शुरू करें पर क्लिक करें. ट्रेस सेशन चालू होने पर एपीआई प्रॉक्सी, प्रोसेसिंग पाइपलाइन में हर चरण की जानकारी रिकॉर्ड करता है. ट्रेस सेशन के दौरान, लाइव ट्रैफ़िक से मैसेज और काम के डेटा को कैप्चर किया जाता है.
   

   

7. अगर आपकी प्रॉक्सी से कोई लाइव ट्रैफ़िक नहीं आ रहा है, तो एपीआई को अनुरोध भेजें. अनुरोध भेजने के लिए, किसी भी टूल का इस्तेमाल किया जा सकता है, जैसे कि curl, पोस्टमैन या कोई भी जाना-पहचाना टूल. इसके अलावा, ट्रेस टूल से भी अनुरोध को सीधे भेजा जा सकता है. बस यूआरएल डालें और भेजें पर क्लिक करें. ध्यान दें: ट्रेस टूल से सिर्फ़ जीईटी अनुरोध भेजा जा सकता है, पोस्ट अनुरोध नहीं.
   
   ध्यान दें: एक ट्रेस सेशन में, चुने गए एपीआई प्रॉक्सी की मदद से, हर मैसेज प्रोसेसर के लिए 10 अनुरोध/रिस्पॉन्स लेन-देन किए जा सकते हैं. Edge क्लाउड में, ट्रैफ़िक मैनेज करने वाले दो मैसेज प्रोसेसर के साथ, 20 अनुरोध/रिस्पॉन्स लेन-देन काम करते हैं. अगर ट्रेस सेशन को मैन्युअल तरीके से नहीं रोका जाता, तो 10 मिनट के बाद यह अपने-आप बंद हो जाता है.
   
8. काफ़ी संख्या में अनुरोध कैप्चर करने के बाद, 'ट्रेस रोकें' सेशन पर क्लिक करें.
9. बाएं मेन्यू में कैप्चर किए गए अनुरोध/रिस्पॉन्स के लेन-देन की सूची दिख रही है. किसी भी लेन-देन पर क्लिक करके, पूरी जानकारी वाले नतीजे देखें.

ट्रेस कैसे पढ़ें

ट्रेस टूल के दो मुख्य हिस्से हैं, ट्रांज़ैक्शन मैप और फ़ेज़ की जानकारी:

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

यहां ट्रेस टूल मैप का एक सैंपल दिया गया है, जिसमें प्रॉक्सी प्रोसेसिंग वाले मुख्य सेगमेंट को लेबल किया गया है:

टूल के लेन-देन का मैप ट्रेस करें

लेन-देन का मैप लेजेंड

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

लेन-देन का मैप आइकॉन

	ऐसा क्लाइंट ऐप्लिकेशन जो एपीआई प्रॉक्सी के प्रॉक्सीEndpoint को अनुरोध भेजता है.
	प्रॉक्सी फ़्लो में, सर्कल मार्क करते हैं. इसके लिए, ट्रांज़िशनल एंडपॉइंट का इस्तेमाल किया जाता है. ये तब दिखते हैं, जब क्लाइंट से अनुरोध मिलता है, टारगेट पर जाता है, जब टारगेट से जवाब आता है, और जब क्लाइंट को जवाब मिलता है.
	ऊंचे बार, एपीआई प्रॉक्सी फ़्लो में फ़्लो सेगमेंट की शुरुआत के बारे में बताते हैं. फ़्लो सेगमेंट हैं: ProxyEndpoint अनुरोध, TargetEndpoint अनुरोध, TargetEndpoint रिस्पॉन्स, और प्रॉक्सीEndpoint रिस्पॉन्स. सेगमेंट में PreFlow, Conditional flow, और PostFlow शामिल हैं. ज़्यादा जानकारी के लिए, फ़्लो कॉन्फ़िगर करना देखें.
	इससे पता चलता है कि Analytics की कार्रवाइयां बैकग्राउंड में हुई हैं.
	एक कंडिशनल फ़्लो, जो सही के तौर पर नतीजा दिखाता है. कंडिशनल फ़्लो के बारे में जानकारी पाने के लिए, फ़्लो कॉन्फ़िगर करना देखें. ध्यान दें कि कुछ स्थितियां Edge से जनरेट की गई होती हैं. उदाहरण के लिए, यह एक ऐसा एक्सप्रेशन है जिसका इस्तेमाल Edge यह पता करने के लिए करता है कि क्या प्रॉक्सीEndpoint में गड़बड़ी हुई है: ((error.state equals PROXY_REQ_FLOW) or (error.state equals PROXY_RESP_FLOW))
	गलत के तौर पर नतीजा दिखाने वाला कंडीशनल फ़्लो. कंडिशनल फ़्लो के बारे में जानने के लिए, यूज़र फ़्लो कॉन्फ़िगर करना लेख पढ़ें. ध्यान दें कि कुछ स्थितियां Edge से जनरेट की गई होती हैं. उदाहरण के लिए, यहां एक एक्सप्रेशन दिया गया है. इसका इस्तेमाल करके Edge यह पता लगाता है कि TargetEndpoint में कोई गड़बड़ी हुई है या नहीं: (((error.state equals TARGET_REQ_FLOW) or (error.state equals TARGET_RESP_FLOW)) or ((error.state equals REQ_SENT) or (error.state equals RESP_START)))
	नीतियां. हर तरह की नीति का एक खास आइकॉन होता है. यह AttributionMessage की नीति के लिए है. इन आइकॉन से पता चलता है कि नीतियां कहां सही क्रम में लागू होती हैं. साथ ही, वे लागू होती हैं या नहीं. किसी नीति आइकॉन पर क्लिक करके, उसके लागू होने के नतीजे देखे जा सकते हैं. साथ ही, यह भी देखा जा सकता है कि उनके चलने की उम्मीद की जाती है या नहीं. उदाहरण के लिए, यह देखा जा सकता है कि मैसेज को ठीक से बदला गया है या उसे कैश मेमोरी में सेव किया जा रहा है. नीतियों का सही तरीके से पालन करने के बारे में, साफ़ तौर पर सही के निशान लगाकर दिखाए जाते हैं. गड़बड़ी होने पर, आइकॉन पर लाल रंग का विस्मयादिबोधक चिह्न दिखेगा. सलाह: टूलटिप या टाइम लाइन पर ध्यान दें और देखें कि किसी नीति में उम्मीद से ज़्यादा समय तो नहीं लग रहा है.
	यह तब दिखता है, जब बैकएंड टारगेट एक Node.js ऐप्लिकेशन हो. Apigee Edge पर Node.js की खास जानकारी देखें.
	एपीआई प्रॉक्सी की मदद से कॉल किया गया बैकएंड टारगेट.
	टाइम लाइन से पता चलता है कि प्रोसेस होने में लगने वाला समय (मिलीसेकंड में) कितना लगा. बीते हुए समय के सेगमेंट की तुलना करने से, आपको उन नीतियों को अलग करने में मदद मिलती है जिन्हें लागू होने में सबसे ज़्यादा समय लग रहा है. इन नीतियों से, आपके एपीआई कॉल की रफ़्तार धीमी हो जाती है.
	एप्सिलॉन, एक मिलीसेकंड से कम समयावधि को दिखाता है.
	सबमिट नहीं किया जा सकता. यह नीति के बंद होने पर, नीति आइकॉन पर दिखती है. सार्वजनिक एपीआई की मदद से, किसी नीति को बंद किया जा सकता है. API प्रॉक्सी कॉन्फ़िगरेशन का संदर्भ देखें.
	कोई गड़बड़ी हुई. यह नीति के चरण की शर्त के 'गलत' होने पर नीति आइकॉन में दिखती है (फ़्लो वैरिएबल और शर्तें देखें) या जब कभी भी दर्शाने के लिए इस नीति के लागू होने पर riseFault नीति के आइकॉन पर दिखता है.
	छोड़ा गया. यह तब नीति आइकॉन पर दिखता है, जब नीति लागू नहीं की गई थी, क्योंकि चरण से जुड़ी शर्त का आकलन 'गलत' पर होता है. ज़्यादा जानकारी के लिए, फ़्लो वैरिएबल और शर्तें देखें.

फ़ेज़ की जानकारी को समझना

टूल के चरण का ब्यौरा वाला हिस्सा, आपको हर प्रोसेसिंग चरण में आपके प्रॉक्सी की स्थिति के बारे में काफ़ी जानकारी देता है. चरण की पूरी जानकारी, यहां दी गई है. चुने गए चरण की जानकारी देखने के लिए, ट्रेस टूल में मौजूद किसी भी आइकॉन पर क्लिक करें या एक चरण से दूसरे चरण पर जाने के लिए, आगे बढ़ें/वापस जाएं बटन का इस्तेमाल करें.

फ़ेज़ की जानकारी	जानकारी
प्रॉक्सी एंडपॉइंट	इससे पता चलता है कि स्क्रिप्ट चलाने के लिए कौनसा प्रॉक्सी Endpoint फ़्लो चुना गया था. एपीआई प्रॉक्सी में, नाम वाले कई प्रॉक्सी एंडपॉइंट हो सकते हैं.
वैरिएबल	उन फ़्लो वैरिएबल की सूची बनाता है जिन्हें किसी नीति को पढ़कर असाइन किया गया था. साथ ही, फ़्लो वैरिएबल की मदद से प्रॉक्सी की स्थिति मैनेज करना भी देखें. ध्यान दें: बराबर का चिह्न (=) से पता चलता है कि वैरिएबल को कितनी वैल्यू असाइन की गई है. क्रॉस-आउट के बराबर का निशान (≠) से पता चलता है कि वैरिएबल को कोई वैल्यू असाइन नहीं की जा सकती, क्योंकि वह रीड ओनली है या नीति को लागू करने में कोई गड़बड़ी हुई है. खाली फ़ील्ड से पता चलता है कि वैरिएबल की वैल्यू पढ़ी गई थी.
हेडर का अनुरोध करें	एचटीटीपी अनुरोध के हेडर की सूची बनाता है.
कॉन्टेंट का अनुरोध करें	यह एचटीटीपी अनुरोध का मुख्य हिस्सा दिखाता है.
प्रॉपर्टी	प्रॉपर्टी, एपीआई प्रॉक्सी की अंदरूनी स्थिति को दिखाती हैं. इन्हें डिफ़ॉल्ट रूप से नहीं दिखाया जाता.
टारगेट एंडपॉइंट	इससे पता चलता है कि एक्ज़ीक्यूट करने के लिए कौनसा TargetEndpoint चुना गया था.
रिस्पॉन्स हेडर	एचटीटीपी रिस्पॉन्स हेडर की सूची बनाता है.
जवाब का कॉन्टेंट	एचटीटीपी रिस्पॉन्स का मुख्य हिस्सा दिखाता है.
PostClientFlow	यह PostClientFlow के बारे में जानकारी दिखाता है, जो अनुरोध करने वाले क्लाइंट ऐप्लिकेशन को अनुरोध मिलने के बाद एक्ज़ीक्यूट होता है. सिर्फ़ MessageLogging नीतियों को PostClientFlow से अटैच किया जा सकता है. फ़िलहाल, PostClientFlow का इस्तेमाल खास तौर पर, रिस्पॉन्स मैसेज के शुरू और खत्म होने के टाइमस्टैंप के बीच के टाइम इंटरवल को मापने के लिए किया जाता है.

फ़िल्टर का इस्तेमाल करके मैसेज कैप्चर करने की प्रोसेस को बेहतर बनाना

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

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

फ़िल्टर करने की सुविधा के बारे में ज़रूरी बातें

• फ़िल्टर फ़ील्ड में फ़िल्टर पैरामीटर तय करने के बाद, आपको अपने ट्रेस सेशन को फिर से शुरू करना होगा.
• फ़िल्टर पैरामीटर एक साथ AND से जुड़े होते हैं. सही तरीके से मिलान करने के लिए, दिए गए सभी क्वेरी और/या हेडर के नाम/वैल्यू पेयर का अनुरोध में मौजूद होना ज़रूरी है.
• फ़िल्टर टूल में पैटर्न मैचिंग की सुविधा काम नहीं करती.
• फ़िल्टर पैरामीटर और वैल्यू, केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होती हैं.

ट्रेस फ़िल्टर बनाने का तरीका

1. अगर कोई ट्रेस सत्र चल रहा है, तो उसे 'ट्रेस रोकें सेशन' पर क्लिक करके बंद करें.
2. फ़िल्टर फ़ील्ड को बड़ा करने के लिए, ट्रेस टूल के ऊपर बाएं कोने में मौजूद फ़िल्टर पर क्लिक करें.
   
   
   
3. फ़िल्टर फ़ील्ड में, वे क्वेरी पैरामीटर और/या हेडर वैल्यू डालें जिनके आधार पर आपको फ़िल्टर करना है. इस उदाहरण में, हमने फ़िल्टर करने के लिए दो क्वेरी पैरामीटर तय किए हैं. बेहतर तरीके से मैच करने के लिए, अनुरोध में दोनों पैरामीटर मौजूद होने चाहिए.
   
   
   
4. ट्रेस सत्र शुरू करें.
5. अपने एपीआई को कॉल करें. सिर्फ़ उन अनुरोधों से मिलान किया जाता है जिनमें दिए गए सभी हेडर और/या क्वेरी पैरामीटर शामिल होते हैं.

ऊपर दिए गए उदाहरण में, यह एपीआई कॉल ट्रेस में दिखेगा:

http://docs-test.apigee.net/cats?name=Penny&breed=Calico

हालांकि, ऐसा करने से:

http://docs-test.apigee.net/cats?name=Penny

ट्रेस की मदद से डीबग करना

ट्रेस की मदद से आप एपीआई प्रॉक्सी के बारे में कई अंदरूनी जानकारी देख सकते हैं. उदाहरण के लिए:

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

दृश्य विकल्प चुनना

ट्रेस सेशन के लिए देखने के विकल्प चुनें.

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

ट्रेस के नतीजे डाउनलोड हो रहे हैं

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

डाउनलोड करने के लिए, ट्रेस सेशन डाउनलोड करें पर क्लिक करें.

अनुरोधों को कर्ल के तौर पर दिखाया जा रहा है

टारगेट सर्वर पर किए गए एपीआई कॉल को ट्रेस करने के बाद, अनुरोध को curl कमांड के तौर पर देखा जा सकता है. यह खास तौर पर, डीबग करने के लिए कई वजहों से काम आता है:

• एपीआई प्रॉक्सी, अनुरोध में बदलाव कर सकता है. इसलिए, यह देखना बेहतर होगा कि टारगेट सर्वर को प्रॉक्सी से मिलने वाला अनुरोध, मूल अनुरोध से किस तरह अलग है. curl कमांड बदले गए अनुरोध को दिखाता है.
• बड़े मैसेज पेलोड के लिए, कर्ल की मदद से एचटीटीपी हेडर और मैसेज का कॉन्टेंट एक ही जगह पर देखा जा सकता है. (फ़िलहाल, इसमें करीब 1,000 वर्ण हो सकते हैं. इस सीमा को पार करने के बारे में सलाह पाने के लिए, यह कम्यूनिटी पोस्ट देखें.)

सुरक्षा के लिए, कर्ल सुविधा एचटीटीपी ऑथराइज़ेशन हेडर को मास्क कर देती है.

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

Apigee की सहायता टीम से ट्रेस को इस्तेमाल करने की सुविधा

Apigee Edge की मदद से, Apigee सहायता को सहायता पाने के लिए, अपने प्रॉक्सी पर ट्रेस टूल का इस्तेमाल किया जा सकता है. इस विकल्प को कभी भी बंद किया जा सकता है. हालांकि, इस विकल्प को बंद करने पर, हो सकता है कि Apigee सहायता टीम आपको सहायता न दे पाए.

Apigee सहायता को ट्रेस करने वाले टूल का इस्तेमाल करने से रोकने के लिए:

1. https://apigee.com/edge में साइन इन करें.
2. बाईं ओर मौजूद नेविगेशन बार में, एडमिन > निजता और सुरक्षा चुनें.
3. ट्रेस को ट्रेस करने के लिए Apigee सपोर्ट चालू करें को टॉगल करें Apigee सहायता का इस्तेमाल करके ट्रेस टूल का इस्तेमाल बंद करने के लिए.