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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• डेटा अपडेट होने में लगने वाला समय - एपीआई प्रॉक्सी को कॉल करने के बाद, डेटा को डिसप्ले करने या मैनेजमेंट एपीआई कॉल के ज़रिए ऐक्सेस करने में 10 मिनट तक लग सकते हैं.
• डेटा का रखरखाव - Analytics डेटा को कितने समय तक सेव रखा जाता है, यह आपके सदस्यता प्लान पर निर्भर करता है:
  • स्टैंडर्ड: 30 दिन
  • Enterprise: तीन महीने
  • Enterprise Plus: 14 महीने
  ज़्यादा जानकारी के लिए, Apigee API Management की कीमत देखें.

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

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

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

Analytics डैशबोर्ड

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

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

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

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

• कैश मेमोरी की परफ़ॉर्मेंस
• डेवलपर का जुड़ाव
• डिवाइस का इस्तेमाल
• गड़बड़ी कोड का विश्लेषण
• GeoMap
• लेटेंसी का विश्लेषण
• टारगेट परफ़ॉर्मेंस
• ट्रैफ़िक कंपोज़िशन

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

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

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

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

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

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

  

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

  

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

Analytics API

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

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

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

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

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

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

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

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

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

• Drupal 7: ऐप्लिकेशन के इस्तेमाल से जुड़े आंकड़े दिखाना
• Drupal 8: Monitor apps
• इंटिग्रेटेड पोर्टल: उपलब्ध नहीं है

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

• कस्टम रिपोर्ट बनाना और उन्हें अपने ऐप्लिकेशन डेवलपर के साथ शेयर करना. ज़्यादा जानकारी के लिए, कस्टम रिपोर्ट बनाना लेख पढ़ें.
• Edge Management API का इस्तेमाल करके, ज़्यादा समय तक डेटा कैप्चर करना. इससे ऐप्लिकेशन डेवलपर के साथ ऑफ़लाइन डेटा शेयर किया जा सकता है. ज़्यादा जानकारी के लिए, एपीआई प्रोग्राम की परफ़ॉर्मेंस का आकलन करने के लिए, मेट्रिक एपीआई का इस्तेमाल करना लेख पढ़ें.

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

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

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

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

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

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

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

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

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

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

• Analytics डैशबोर्ड का इस्तेमाल करना
• कस्टम रिपोर्ट बनाना और उन्हें मैनेज करना
• मेट्रिक के एपीआई का इस्तेमाल करना
• कस्टम Analytics का इस्तेमाल करके, एपीआई मैसेज के कॉन्टेंट का विश्लेषण करना