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

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

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

अपने कॉन्टेक्स्ट के हिसाब से कस्टम रिपोर्ट बनाना

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   <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. मेट्रिक के लिए, प्रॉक्सी से जुड़ी गड़बड़ियां चुनें. इसके बाद, एग्रीगेट फ़ंक्शन को Sum पर सेट करें. अगर चाहें, तो और भी मेट्रिक जोड़ी जा सकती हैं.

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

    

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

    

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

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

    

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

    

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

    

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