कस्टम रिपोर्ट बनाना

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

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

अपने संदर्भ के आधार पर कस्टम रिपोर्ट बनाएं

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

कस्टम रिपोर्ट का कॉन्टेक्स्ट	कस्टम रिपोर्ट को नाम देने के डिफ़ॉल्ट तरीके
हाल ही का डैशबोर्ड	API Monitoring Recent Generated
टाइमलाइन डैशबोर्ड	API Monitoring Timeline Generated
डैशबोर्ड की जांच करें	API Monitoring Investigate Generated
चेतावनी की स्थिति	API Monitoring Generated: alert-name

डिफ़ॉल्ट डाइमेंशन और मेट्रिक

कस्टम रिपोर्ट में, नीचे दी गई टेबल में दिए गए डाइमेंशन और मेट्रिक शामिल होंगे. ये डाइमेंशन और मेट्रिक, एपीआई मॉनिटरिंग से जनरेट की गई सभी रिपोर्ट के लिए डिफ़ॉल्ट तौर पर शामिल होंगे.

कॉम्पोनेंट	डिफ़ॉल्ट
डाइमेंशन	अनुरोध URI
मेट्रिक	जवाब देने में लगने वाला कुल समय जवाब देने में लगने वाला टारगेट समय प्रॉक्सी से जुड़ी गड़बड़ियां टारगेट से जुड़ी गड़बड़ियां

कस्टम रिपोर्ट में बदलाव करना

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

इस कस्टम रिपोर्ट में, पहले से तय Gateway Flow ID डाइमेंशन जोड़ा गया है. इसमें Gateway Flow ID में Edge से किए गए हर एपीआई अनुरोध का यूनीक यूयूआईडी शामिल होता है. ध्यान दें कि रिपोर्ट पहले से ही Request URI डाइमेंशन का इस्तेमाल कर रही है:

नीचे दिए गए उदाहरण में, कस्टम रिपोर्ट में Client ID डाइमेंशन जोड़ा गया है. Client ID डाइमेंशन में, एपीआई कॉल करने वाले डेवलपर की उपभोक्ता कुंजी (एपीआई पासकोड) शामिल होती है. भले ही, अनुरोध को एपीआई पासकोड के तौर पर पास किया गया हो या OAuth टोकन में शामिल किया गया हो:

कस्टम रिपोर्ट में सभी Client ID वैल्यू की जानकारी होती है. अगले उदाहरण में एक फ़िल्टर जोड़ा गया है, ताकि आप किसी खास Client ID के लिए कस्टम रिपोर्ट बना सकें:

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

अगले उदाहरण में, कस्टम रिपोर्ट में एक फ़िल्टर जोड़ा गया है, जो policies.ratelimit.QuotaViolation गड़बड़ी कोड और 5xx स्टेटस कोड के लिए डिफ़ॉल्ट मेट्रिक और डाइमेंशन को कैप्चर करता है:

कस्टम रिपोर्ट में बदलाव करने के तरीके से जुड़ी पूरी जानकारी पाने के लिए, कस्टम रिपोर्ट मैनेज करना लेख पढ़ें.

उदाहरण: डिप्लॉयमेंट से जुड़ी समस्याओं का पता लगाने के लिए कस्टम रिपोर्ट का इस्तेमाल करना

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

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

curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi

इसके बाद, अपने एपीआई प्रॉक्सी से जुड़ी रनटाइम की समस्याओं का पता लगाने के लिए, हेडर में दी गई जानकारी का इस्तेमाल करें.

इन हेडर के लिए कस्टम रिपोर्ट बनाने के लिए:

1. कस्टम हेडर की वैल्यू को कैप्चर करने के लिए, अपने एपीआई में आंकड़े कलेक्टर नीति जोड़ें:

   <StatisticsCollector name="publishPurchaseDetails">
     <Statistics>
       <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic>
       <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic>
       <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic>
     </Statistics>
   </StatisticsCollector>
   

2. अपना प्रॉक्सी डिप्लॉय करें और इसे ऐक्सेस करने के लिए समय दें.

3. अपने एपीआई से जुड़ी किसी भी समस्या को देखने के लिए, Edge यूज़र इंटरफ़ेस (यूआई) में विश्लेषण > एपीआई मॉनिटरिंग > हाल ही के पर क्लिक करें. ध्यान दें कि आपको myapi प्रॉक्सी के लिए 4xx और 5xx गड़बड़ियां मिल रही हैं:

   

4. हाल ही के डैशबोर्ड के दाएं पैनल में ज़्यादा जानकारी देखने के लिए, myapi प्रॉक्सी पंक्ति को चुनें.

5. 'हाल ही के' डैशबोर्ड के दाएं पैनल में, 'जांच करें' डैशबोर्ड को ऐक्सेस करने के लिए, > जांच में देखें को चुनें:

   

6. myapi प्रॉक्सी की मदद से जांच डैशबोर्ड को फ़िल्टर करें और फिर टॉप चार्ट में स्थिति कोड देखें. ध्यान दें कि आपको 403 और 501 कोड वाली गड़बड़ियां मिल रही हैं:

   

7. Edge यूज़र इंटरफ़ेस (यूआई) में, एक कस्टम रिपोर्ट बनाने के लिए Analytics > कस्टम रिपोर्ट > रिपोर्ट चुनें, जिसमें इन कस्टम मेट्रिक की वैल्यू डाइमेंशन के रूप में शामिल हों.

8. myapi_errors नाम की कस्टम रिपोर्ट बनाने के लिए, + कस्टम रिपोर्ट चुनें.

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

10. पहले से तय रिस्पॉन्स स्टेटस कोड डाइमेंशन चुनें. इसके बाद, डाइमेंशन में तीन कस्टम आंकड़े Red, targetersion, और userid जोड़ें:

    

11. सिर्फ़ myapi एपीआई प्रॉक्सी (apiproxy eq 'myapi') का डेटा शामिल करने के लिए फ़िल्टर सेट करें:

    

12. रिपोर्ट सेव करें.

13. पिछले 24 घंटों के लिए रिपोर्ट चलाएं. रिपोर्ट पहली बार खुलने पर, आपको एचटीटीपी 403 और 501 गड़बड़ियों का चार्ट दिखता है:

    

14. खास जानकारी में, 403 या 510 पर क्लिक करके देखें कि किस प्रॉडक्ट में गड़बड़ियां जनरेट हो रही हैं. उदाहरण के लिए, आपने 403 चुना:

    

15. टारगेट वर्शन (ऐल्फ़ा या बीटा) के हिसाब से गड़बड़ियां देखने के लिए, खास जानकारी में किसी प्रॉडक्ट आईडी पर क्लिक करें:

    

16. उपयोगकर्ता के हिसाब से गड़बड़ियां देखने के लिए, खास जानकारी में टारगेट वर्शन पर क्लिक करें: