आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
इस सेक्शन में, एपीआई मॉनिटरिंग की तुलना Edge Analytics से की गई है. एपीआई मॉनिटरिंग और Edge Analytics, दोनों की मदद से एपीआई डेटा इकट्ठा किया जा सकता है और उसे देखा जा सकता है. हालांकि, इनके मकसद अलग-अलग हैं:
- एपीआई मॉनिटरिंग का लक्ष्य यह पक्का करना है कि आपके एपीआई, उम्मीद के मुताबिक काम कर रहे हों. इसके लिए, आपको सबसे नया डेटा देखना है. एपीआई मॉनिटरिंग से ऐसा डेटा मिलता है जो रीयल-टाइम के बहुत करीब होता है. साथ ही, इसकी मदद से ऐसी सूचनाएं बनाई जा सकती हैं जो समस्या आने पर आपको सूचना देती हैं.
- Edge Analytics का मकसद, आपके एपीआई के लंबे समय तक के व्यवहार को समझना है. इससे यह पक्का किया जा सकता है कि वे आपके कारोबार की ज़रूरतों को पूरा कर रहे हैं या नहीं. अगर ज़रूरी हो, तो उनमें बदलाव भी किए जा सकते हैं. इन कामों के लिए, रीयल-टाइम डेटा देखना ज़रूरी नहीं है. इसलिए, Analytics का डेटा थोड़ा देर से अपडेट होता है. हालांकि, आम तौर पर इसमें ज़्यादा से ज़्यादा 10 मिनट लगते हैं.
ध्यान दें कि एपीआई मॉनिटरिंग का डेटा, Analytics के डेटा का एक छोटा सबसेट होता है. यह डेटा, ज़्यादातर गड़बड़ी के कोड और लेटेन्सी से जुड़ा होता है.
एपीआई मॉनिटरिंग डेटा और Analytics डेटा के बीच अंतर
इस सेक्शन में, Edge Analytics और API मॉनिटरिंग से इकट्ठा किए गए डेटा के बीच कुछ छोटे-मोटे अंतर के बारे में बताया गया है. एपीआई मॉनिटरिंग और Analytics, दोनों अलग-अलग डेटा पाइपलाइन का इस्तेमाल करते हैं. इसलिए, आपको मॉनिटरिंग से जनरेट हुई कस्टम रिपोर्ट और Analytics से जनरेट हुई रिपोर्ट में मामूली अंतर दिख सकता है. उदाहरण के लिए, आपको टाइम आउट की गड़बड़ियों के लिए रिपोर्ट किए गए नतीजों में अंतर दिख सकता है. ये गड़बड़ियां, बैकएंड टाइम आउट (अनुरोध पर एचटीटीपी स्टेटस कोड 504) और क्लाइंट टाइम आउट (एचटीटीपी स्टेटस कोड 499) की वजह से होती हैं. ये Analytics की कस्टम रिपोर्ट में स्टेटस कोड 200 के साथ दिख सकती हैं. हालांकि, मॉनिटरिंग की कस्टम रिपोर्ट में ये स्टेटस कोड 504 या 499 के साथ दिखेंगी.एपीआई मॉनिटरिंग
एपीआई मॉनिटरिंग की मदद से, एपीआई की परफ़ॉर्मेंस के बारे में रीयल-टाइम में अहम जानकारी मिलती है. साथ ही, इससे समस्याओं का तुरंत पता लगाने और उन्हें ठीक करने में मदद मिलती है, ताकि आपके एपीआई सही तरीके से काम करते रहें.
एपीआई मॉनिटरिंग की मदद से, ये काम किए जा सकते हैं:
- एपीआई की उपलब्धता बढ़ाएं और गड़बड़ी का पता लगाने में लगने वाले औसत समय (एमटीटीडी) को कम करें.
- उपभोक्ताओं पर असर पड़ने से पहले, संदर्भ के हिसाब से मिली सूचनाओं के आधार पर ज़रूरी कार्रवाइयां करें.
- गड़बड़ी का पता लगाने की प्रोसेस को तेज़ करने के लिए, Apigee के फ़ॉल्ट कोड का इस्तेमाल करें.
- समस्याओं का पता लगाने के लिए, गड़बड़ी, परफ़ॉर्मेंस, और इंतज़ार के समय से जुड़ी समस्याओं और उनके सोर्स का विश्लेषण करें.
Edge API के आंकड़े
Edge API Analytics, एपीआई के ज़रिए फ़्लो होने वाली जानकारी को इकट्ठा और उसका विश्लेषण करता है. एपीआई Analytics, इस तरह की जानकारी इकट्ठा करता है:
- समय के साथ आपके एपीआई ट्रैफ़िक में किस तरह का बदलाव हुआ है
- आपके सबसे लोकप्रिय ऐप्लिकेशन कौनसे हैं
- आपके सबसे लोकप्रिय डेवलपर कौन हैं
- सबसे ज़्यादा इस्तेमाल किए जाने वाले एपीआई तरीके
- एपीआई से जवाब मिलने में सबसे कम/ज़्यादा समय कब लगता है
- आपको भौगोलिक तौर पर, एपीआई का सबसे ज़्यादा ट्रैफ़िक कहां दिखता है
एपीआई ऐनलिटिक्स से इकट्ठा किया गया डेटा
API Analytics, एपीआई के ज़रिए फ़्लो होने वाले डेटा के बड़े हिस्से को इकट्ठा और उसका विश्लेषण करता है. उदाहरण के लिए, जब आपका एपीआई डिप्लॉय किया जाता है, तब Analytics लगातार कई तरह का डेटा रिकॉर्ड करता है. जैसे, मिले हुए मैसेज की संख्या, डेवलपर की संख्या, जवाब मिलने में लगने वाला समय, गड़बड़ियां, इस्तेमाल किए जा रहे ऐप्लिकेशन की संख्या, अनुरोध का साइज़ वगैरह.
मेट्रिक और उनके इस्तेमाल के बारे में जानने के लिए, एपीआई प्रोग्राम की परफ़ॉर्मेंस का आकलन करने के लिए, मेट्रिक वाले एपीआई का इस्तेमाल करना लेख पढ़ें. मेट्रिक की पूरी सूची देखने के लिए, Analytics मेट्रिक, डाइमेंशन, और फ़िल्टर का रेफ़रंस देखें.
कस्टम मेट्रिक इकट्ठा करना
StatisticsCollector नीति का इस्तेमाल करके, कस्टम मेट्रिक भी इकट्ठा की जा सकती हैं. StatisticsCollector नीति, अनुरोध हेडर, XML/JSON पेलोड, क्वेरी पैरामीटर, यूआरआई, और अन्य जगहों से जानकारी को Analytics सर्वर पर लिख सकती है. ऐसा विश्लेषण करने और रिपोर्ट जनरेट करने के लिए किया जाता है.
Analytics डेटा ऐक्सेस करना
जनरेट होने के बाद, पहले से तय की गई मेट्रिक और कस्टम मेट्रिक को ऐक्सेस किया जा सकता है. इसके लिए, Analytics विज़ुअलाइज़ेशन टूल के एपीआई का इस्तेमाल करें. इनमें डैशबोर्ड, कस्टम रिपोर्ट, और GeoMap शामिल हैं. API Analytics की ओर से उपलब्ध कराए गए विज़ुअलाइज़ेशन टूल के बारे में ज़्यादा जानने के लिए, Analytics डैशबोर्ड देखें. कस्टम रिपोर्ट के बारे में ज़्यादा जानने के लिए, कस्टम रिपोर्ट बनाना लेख पढ़ें.
एपीआई मॉनिटरिंग और एपीआई ऐनलिटिक्स की तुलना करना
एपीआई डेवलपर, एपीआई मॉनिटरिंग और एपीआई Analytics, दोनों का इस्तेमाल करते हैं. इन दोनों के बीच मुख्य अंतर यह है कि एपीआई मॉनिटरिंग में सूचना पाने की सुविधा होती है. सूचनाओं की मदद से, आपकी ऑपरेशन टीम को एपीआई से जुड़ी समस्याओं के बारे में रीयल टाइम में पता चलता है. इससे यह पक्का किया जा सकता है कि आपके एपीआई उपलब्ध हों और उम्मीद के मुताबिक काम कर रहे हों.
सूचना की शर्तों में, स्टेटस कोड (2xx/4xx/5xx), लेटेन्सी, और गड़बड़ी के कोड के थ्रेशोल्ड तय किए जाते हैं. इन थ्रेशोल्ड के पार होने पर, यूज़र इंटरफ़ेस (यूआई) में विज़ुअल सूचनाएं ट्रिगर होती हैं. साथ ही, ईमेल, Slack, PagerDuty या वेबहुक जैसे अलग-अलग चैनलों के ज़रिए सूचनाएं भेजी जाती हैं. अलर्ट को एनवायरमेंट, एपीआई प्रॉक्सी या टारगेट सेवा या क्षेत्र के लेवल पर सेट अप किया जा सकता है.
सूचना ट्रिगर होने के बाद, आपकी ऑपरेशंस टीम, एपीआई मॉनिटरिंग यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके समस्या की जांच कर सकती है. साथ ही, इसकी असल वजह का पता लगा सकती है. इसके बाद, एक कस्टम रिपोर्ट जनरेट की जा सकती है. इसमें सूचना के बारे में पहले से तय की गई जानकारी शामिल होती है. जैसे:
- जवाब देने में लगा कुल समय
- जवाब देने में लगने वाला टारगेट समय
- प्रॉक्सी से जुड़ी गड़बड़ियां
- टारगेट से जुड़ी गड़बड़ियां
- अनुरोध का यूयूआईडी
- कई अन्य
एपीआई Analytics को कई तरह के डेटा को कैप्चर करने के लिए डिज़ाइन किया गया है, ताकि कई टीमें इसका इस्तेमाल कर सकें. उदाहरण के लिए:
- ऑपरेशंस टीम, Analytics डेटा का इस्तेमाल करके यह पता लगा सकती है कि किस समय ट्रैफ़िक ज़्यादा या कम होता है. इससे, टीम बदलती मांगों को पूरा करने के लिए, आपकी सेवाओं को अपग्रेड या डाउनग्रेड कर सकती है.
- मार्केटिंग टीम, Analytics के डेटा का इस्तेमाल करके, ग्राहक के इस्तेमाल के पैटर्न का पता लगा सकती है. यह पैटर्न, अलग-अलग एपीआई, ऐप्लिकेशन, ग्राहकों या अन्य डेटा से पहचाना जाता है.
- सभी टीमें, अनुरोध से इकट्ठा किए गए कस्टम डेटा को ऐक्सेस कर सकती हैं. इस डेटा का इस्तेमाल, खास जानकारी को ट्रैक करने के लिए किया जाता है. जैसे, हेडर वैल्यू, क्वेरी पैरामीटर या अनुरोध पेलोड.