API Analytics के बारे में खास जानकारी

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

इस विषय में Edge API के Analytics के बारे में बताया गया है.

वीडियो: Edge API Analytics की सेवाओं की खास जानकारी पाने के लिए एक छोटा वीडियो देखें.

आंकड़ों की मदद से एपीआई को बेहतर बनाएं

Edge API Analytics, एपीआई प्रॉक्सी के ज़रिए जानकारी इकट्ठा करता है और उसकी गणना करता है. इसे EDGE यूज़र इंटरफ़ेस (यूआई) में ग्राफ़ और चार्ट के साथ विज़ुअलाइज़ किया जा सकता है या Edge मैनेजमेंट एपीआई का इस्तेमाल करके, ऑफ़लाइन विश्लेषण के लिए रॉ डेटा डाउनलोड किया जा सकता है.

Analytics की मदद से, आम तौर पर पूछे जाने वाले सवालों के जवाब पाए जा सकते हैं, जैसे:

  • समय के साथ मेरे एपीआई ट्रैफ़िक में क्या बदलाव हो रहा है?
  • एपीआई के कौनसे तरीके सबसे लोकप्रिय हैं?
  • मेरे टॉप डेवलपर कौन हैं?
  • एपीआई से जवाब मिलने में लगने वाला समय कब सबसे तेज़ होता है? सबसे धीमा?
  • भौगोलिक रूप से, मुझे सबसे ज़्यादा एपीआई ट्रैफ़िक कहां दिखता है?

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

API Analytics सभी को बेहतर अनुभव देने में मदद करता है

डेटा इकट्ठा करने, उसका विश्लेषण करने, और उसे विज़ुअलाइज़ करने की लगातार प्रक्रिया से, Edge API Analytics की एपीआई टीम को अपने एपीआई बेहतर बनाने में मदद करता है और ऐप्लिकेशन डेवलपर को अपने ऐप्लिकेशन बेहतर बनाने में मदद करता है:

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

किस तरह का डेटा इकट्ठा किया जाता है और उसका विश्लेषण किया जाता है?

Edge API Analytics, एपीआई प्रॉक्सी में कई तरह के डेटा को इकट्ठा करके उसका विश्लेषण करता है, जैसे:

  • जवाब देने का समय
  • अनुरोध के इंतज़ार का समय
  • अनुरोध का साइज़
  • टारगेट से जुड़ी गड़बड़ियां
  • एपीआई प्रॉडक्ट का नाम
  • डेवलपर का ईमेल पता
  • ऐप्लिकेशन का नाम
  • कई अन्य लोग

एपीआई Analytics से इकट्ठा किए गए डेटा की पूरी सूची देखने के लिए, Analytics मेट्रिक, डाइमेंशन, और फ़िल्टर रेफ़रंस देखें.

मैं कस्टम Analytics डेटा कैसे इकट्ठा करूं?

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

आंकड़े इकट्ठा करने वाले की नीति का इस्तेमाल करके, आप कस्टम Analytics डेटा इकट्ठा करते हैं. कस्टम डेटा एक्सट्रैक्ट करने के बाद, Analytics यूज़र इंटरफ़ेस (यूआई) या एपीआई का इस्तेमाल करके डेटा की जांच की जा सकती है. कस्टम Analytics डेटा इकट्ठा करने के तरीके का पूरा उदाहरण देखने के लिए, कस्टम ऐनलिटिक्स का इस्तेमाल करके एपीआई मैसेज के कॉन्टेंट का विश्लेषण करना लेख पढ़ें.

Analytics डेटा और एपीआई की निगरानी वाले डेटा में अंतर

इस सेक्शन में, Edge Analytics और एपीआई मॉनिटरिंग से इकट्ठा किए गए डेटा के बीच के मामूली अंतर के बारे में बताया गया है. एपीआई मॉनिटरिंग और Analytics, अलग-अलग डेटा पाइपलाइन का इस्तेमाल करते हैं, इसलिए आपको मॉनिटरिंग से जनरेट की गई कस्टम रिपोर्ट और Analytics से जनरेट की गई रिपोर्ट में मामूली अंतर दिख सकता है. उदाहरण के लिए, आपको टाइम आउट की गड़बड़ियों की वजह से, रिपोर्ट किए गए नतीजों में अंतर दिख सकता है. ये दोनों, बैकएंड टाइम आउट (अनुरोध पर मिलने वाला एचटीटीपी स्टेटस कोड 504) और क्लाइंट टाइम आउट (एचटीटीपी स्टेटस कोड 499) दोनों के लिए अंतर होता है. ये Analytics कस्टम रिपोर्ट में स्टेटस कोड 200 के साथ दिख सकते हैं, लेकिन कस्टम रिपोर्ट की निगरानी में स्टेटस कोड 504 या 499 के साथ दिखेंगे.

मेरा Analytics डेटा कब और कितने समय के लिए उपलब्ध होता है?

आंकड़ों का डेटा कब और कितनी देर तक देखा जा सकता है, यह दो समय अंतरालों से तय होता है:

  • डेटा डिले इंटरवल - एपीआई प्रॉक्सी पर कॉल करने के बाद, डेटा को डिसप्ले या मैनेजमेंट एपीआई कॉल के ज़रिए ऐक्सेस करने में 10 मिनट तक लग सकते हैं.
  • डेटा का रखरखाव - Edge के हिसाब से, आंकड़ों के डेटा को सेव रखने की अवधि प्लान के हिसाब से अलग-अलग होती है. आपके प्लान के हिसाब से, पिछले 30, 60, 90 या 365 दिनों का आंकड़ों का डेटा उपलब्ध हो सकता है.

मैं Analytics का डेटा कैसे ऐक्सेस करूं?

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

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

Analytics डैशबोर्ड

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

इस डैशबोर्ड में इन चीज़ों के चार्ट शामिल हैं:

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

पहले से तय किए गए अन्य डैशबोर्ड में ये शामिल हैं:

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

कस्टम रिपोर्ट

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

कस्टम रिपोर्ट बनाते समय, अपनी ज़रूरत के हिसाब से डेटा (मेट्रिक) चुनें, डेटा को सही तरीकों (डाइमेंशन) के हिसाब से ग्रुप में रखें, और विकल्प के तौर पर, डेटा की खास विशेषताओं (फ़िल्टरिंग) के आधार पर डेटा को सीमित करें.

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

  • कॉलम - हर एपीआई प्रॉक्सी को एक अलग कॉलम से दिखाया जाता है:

    कस्टम कॉलम चार्ट

  • लाइन - हर एपीआई प्रॉक्सी को एक अलग लाइन में दिखाया जाता है:

    पसंद के मुताबिक लाइन चार्ट

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

Analytics API

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

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

curl  https://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \
-u email:password

इस कॉल से यह जानकारी मिलती है:

  • हर एपीआई प्रॉक्सी के लिए मिले अनुरोधों की कुल संख्या (मैसेज की संख्या)
  • 24 घंटे के लिए
  • घंटे के अनुसार समूहीकृत

timeRange क्वेरी पैरामीटर से पता चलता है कि फ़ॉर्म में समयावधि कितनी है:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

HH:MM से पहले %20 पर ध्यान दें. timeRange पैरामीटर में, HH:MM से पहले, यूआरएल के हिसाब से कोड में बदले गए स्पेस वर्ण या + वर्ण की ज़रूरत होती है, जैसे कि: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

ज़्यादा जानकारी के लिए, एपीआई प्रोग्राम की परफ़ॉर्मेंस को मेज़र करने के लिए मेट्रिक एपीआई इस्तेमाल करना देखें.

आंकड़ों के डेटा को Google Cloud में एक्सपोर्ट करना

आप पूरे दिन के आंकड़ों के डेटा को Edge से लेकर Google Cloud Storage या BigQuery जैसे अपने डेटा रिपॉज़िटरी में एक्सपोर्ट करने के लिए, Edge मैनेजमेंट एपीआई का इस्तेमाल कर सकते हैं. डेटा का विश्लेषण करने के लिए, Google Cloud BigQuery और TensorFlow से मिलने वाली बेहतर क्वेरी और मशीन लर्निंग की सुविधाओं का इस्तेमाल करें.

ज़्यादा जानकारी के लिए, Analytics से डेटा एक्सपोर्ट करें लेख पढ़ें.

मैं ऐप्लिकेशन डेवलपर के साथ डेटा कैसे शेयर करूं?

जब आप ऐप्लिकेशन डेवलपर को अपना ग्राहक मानें, तो यह पक्का करना होगा कि उनके पास ऐसे टूल और जानकारी मौजूद हो जो आपके एपीआई का बेहतर तरीके से इस्तेमाल कर सकें.

alt_text

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

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

ज़्यादा जानकारी के लिए, देखें:

इसके अलावा, इन तरीकों से अपने डेवलपर के साथ आंकड़े शेयर किए जा सकते हैं:

मैं आंकड़ों का पूरा डेटा कैसे जनरेट करूं?

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

Edge को यह पता लगाने के लिए कुछ कदम उठाने की ज़रूरत है कि कौनसे डेवलपर और कौनसे डेवलपर ऐप्लिकेशन आपकी एपीआई प्रॉक्सी को कॉल कर रहे हैं. यहां उन चरणों की सूची दी गई है जिसमें ज़्यादा जानकारी वाले लिंक दिए गए हैं:

  1. एक या उससे ज़्यादा एपीआई प्रॉडक्ट बनाएं. ये प्रॉडक्ट, सेवा प्लान के साथ एपीआई प्रॉक्सी को ग्रुप करते हैं. एपीआई प्रॉडक्ट को मैनेज करना लेख पढ़ें.
  2. Edge के साथ ऐप्लिकेशन डेवलपर को रजिस्टर करें. ऐप्लिकेशन डेवलपर को रजिस्टर करें देखें.
  3. ऐप्लिकेशन रजिस्टर करें और अपने डेवलपर के लिए एपीआई पासकोड जनरेट करें. ऐप्लिकेशन रजिस्टर करें और एपीआई कुंजियां मैनेज करें देखें.
  4. अपनी एपीआई प्रॉक्सी में सुरक्षा नीतियां जोड़ें, जो एपीआई कुंजियों और/या सुरक्षा टोकन की पुष्टि करती हैं. ये विषय देखें:एपीआई पासकोड की नीति की पुष्टि करें, OAuthV2 नीति, और JWT की नीति की पुष्टि करें.
  5. अगर Edge Microgateway का इस्तेमाल किया जा रहा है, तो पक्का करें कि आपने Analytics प्लगिन को चालू किया हो (यह डिफ़ॉल्ट रूप से चालू होता है). अगर आंकड़ों का प्लग इन बंद कर दिया जाता है, तो Edge Microgateway, Edge Analytics को Analytics का डेटा नहीं भेजेगा.

नीचे दिए गए ट्यूटोरियल, डेवलपर और ऐप्लिकेशन के आंकड़े देखने का तरीका बताते हैं: एपीआई पासकोड की मदद से एपीआई को सुरक्षित करना और OAuth की मदद से एपीआई को सुरक्षित करना.

एपीआई Analytics की तुलना एपीआई मॉनिटरिंग से

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

एपीआई मॉनिटरिंग और एपीआई Analytics के बीच के मुख्य अंतर में से एक है: एपीआई मॉनिटरिंग में सूचना देने का तरीका. चेतावनियों के साथ, आपको एक एचटीटीपी स्टेटस कोड (2xx/4xx/5xx), इंतज़ार का समय या गड़बड़ी कोड की सीमा तय करनी होती है. यह सीमा पार होने पर, आपकी ऑपरेशंस टीम को सूचना के लिए सूचना ट्रिगर करती है. सूचना की सूचनाएं कई तरह के चैनलों जैसे कि ईमेल, Slack, पेजर या वेबहुक से भेजी जा सकती हैं. इनसे आपको समस्याओं का तुरंत जवाब देने में मदद मिलती है.

इन सेवाओं के बीच बेहतर तरीके से तुलना करने के लिए, Edge API Analytics के साथ एपीआई मॉनिटरिंग की तुलना करें लेख देखें.

ज़्यादा जानकारी