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

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

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

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

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

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

Analytics से जुड़े सामान्य सवालों के जवाब पाने में मदद मिलती है, जैसे:

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

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

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

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

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

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

Edge API Analytics, एपीआई प्रॉक्सी के ज़रिए मिलने वाले डेटा का विश्लेषण करता है. जैसे:

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

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

मैं कस्टम आंकड़ों का डेटा कैसे इकट्ठा करूं?

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

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

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

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

मेरा आंकड़ों का डेटा कब और कब तक उपलब्ध होता है?

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

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

मैं आंकड़ों का डेटा कैसे ऐक्सेस करूं?

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

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

Analytics डैशबोर्ड

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

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

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

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

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

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

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

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

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

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

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

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

    कस्टम लाइन चार्ट

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

Analytics API

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

यहां API प्रॉक्सी का विश्लेषण डेटा पुनर्प्राप्त करने के लिए एक उदाहरण API कॉल दिया गया है:

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 से पूरे दिन का सारा डेटा एक्सपोर्ट करने के लिए, Edge management API का इस्तेमाल किया जा सकता है डेटा स्टोर करने की जगह में सेव किया जा सकता है, जैसे कि Google Cloud Storage या BigQuery. इसके बाद, दमदार क्वेरी और मशीन लर्निंग की सुविधाओं का फ़ायदा लिया जा सकता है. Google Cloud BigQuery और TensorFlow का इस्तेमाल, अपने डेटा का विश्लेषण खुद करने के लिए करें.

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

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

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

alt_टेक्स्ट

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

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

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

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

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

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

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

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

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

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

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

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

Edge API Analytics के साथ एपीआई मॉनिटरिंग की तुलना करना लेख पढ़ें का इस्तेमाल करें.

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