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

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

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

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

मेट्रिक

यहां दी गई एपीआई मेट्रिक, कस्टम रिपोर्ट और मैनेजमेंट एपीआई कॉल में वापस पाई जा सकती हैं.

कस्टम रिपोर्ट का नाम मैनेजमेंट एपीआई में इस्तेमाल किया जाने वाला नाम फ़ंक्शन ब्यौरा
प्रति सेकंड औसत लेन-देन tps कोई नहीं

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

एपीआई सिंटैक्स: tps

कैश मेमोरी हिट हुई cache_hit सम करें

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

एपीआई सिंटैक्स: sum(cache_hit)

L1 कैश एलिमेंट की संख्या ax_cache_l1_count औसत, कम से कम, ज़्यादा से ज़्यादा

यह मेट्रिक, किसी तय समयावधि में हर ट्रांज़ैक्शन के लिए, L1 (इन-मेमोरी) कैश मेमोरी में मौजूद एलिमेंट की संख्या दिखाती है. उदाहरण के लिए, अगर आपने एक दिन की अवधि के लिए max चुना है और उस दिन किसी खास लेन-देन के लिए, कैश मेमोरी में मौजूद एलिमेंट की संख्या सबसे ज़्यादा 12 है, तो गिनती 12 होगी. avg के लिए, अगर आपकी क्वेरी की समयावधि में तीन लेन-देन हुए हैं और उनकी कैश मेमोरी की संख्या 5, 6, और 7 है, तो औसत 6 है. L1 कैश मेमोरी, L2 डेटाबेस कैश मेमोरी के बजाय इन-मेमोरी कैश मेमोरी होती है. इसके बारे में कैश मेमोरी की इंटरनल जानकारी में बताया गया है.

एपीआई सिंटैक्स: avg(ax_cache_l1_count)

नीति से जुड़ी गड़बड़ियां policy_error सम करें

तय समयावधि में, नीति के उल्लंघन से जुड़ी गड़बड़ियों की कुल संख्या.

नीति से जुड़ी गड़बड़ियां आम तौर पर डिज़ाइन की वजह से होती हैं. उदाहरण के लिए, Verify API Key नीति तब गड़बड़ी का मैसेज दिखाती है, जब अनुरोध में अमान्य एपीआई पासकोड भेजा जाता है. वहीं, Spike Arrest नीति तब गड़बड़ी का मैसेज दिखाती है, जब एपीआई कॉल की संख्या, नीति में तय की गई सीमा से ज़्यादा हो जाती है. इसलिए, यह मेट्रिक आपके एपीआई में संभावित समस्याओं का पता लगाने के लिए काम की है. उदाहरण के लिए, developer_app डाइमेंशन के हिसाब से ग्रुप की गई policy_error मेट्रिक से, आपको यह पता चल सकता है कि किसी ऐप्लिकेशन के लिए एपीआई कुंजी या OAuth टोकन की समयसीमा खत्म हो गई है. इसके अलावा, आपको यह भी पता चल सकता है कि कोई खास एपीआई प्रॉक्सी, Spike Arrest से जुड़ी कई गड़बड़ियां दिखा रही है. इससे आपको यह पता चल सकता है कि प्रॉक्सी की स्पाइक अरेस्ट सीमा, छुट्टियों के दौरान ट्रैफ़िक में हुई बढ़ोतरी को ध्यान में नहीं रखती है.

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

नीति के उल्लंघन की वजह से हुई गड़बड़ी (ax_execution_fault_policy_name) डाइमेंशन, नीति के नाम के हिसाब से नीति के उल्लंघन की वजह से हुई गड़बड़ियों को ग्रुप करने के लिए काम आता है.

टारगेट फ़ेल होने (जैसे कि 404 या 503) को नीति का उल्लंघन नहीं माना जाता. इन्हें एपीआई प्रॉक्सी की गड़बड़ियों (is_error) के तौर पर गिना जाता है.

एपीआई सिंटैक्स: sum(policy_error)

प्रॉक्सी से जुड़ी गड़बड़ियां is_error सम करें

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

प्रॉक्सी (apiproxy) डाइमेंशन का इस्तेमाल, प्रॉक्सी के हिसाब से एपीआई प्रॉक्सी की गड़बड़ियों को ग्रुप करने के लिए किया जाता है.

एपीआई सिंटैक्स: sum(is_error)

अनुरोध प्रोसेस होने में लगने वाला समय request_processing_latency औसत, कम से कम, ज़्यादा से ज़्यादा

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

अलग-अलग डाइमेंशन का इस्तेमाल करके, एपीआई प्रॉक्सी, डेवलपर ऐप्लिकेशन, क्षेत्र वगैरह के हिसाब से अनुरोध प्रोसेस होने में लगने वाले समय की जांच की जा सकती है.

एपीआई सिंटैक्स: max(request_processing_latency)

अनुरोध का साइज़ request_size sum, avg, min, max

Edge को मिले अनुरोध के पेलोड का साइज़, बाइट में.

एपीआई सिंटैक्स: avg(request_size)

Response Cache Executed ax_cache_executed सम करें

किसी समयावधि में, रिस्पॉन्स कैश मेमोरी की नीति को कुल कितनी बार लागू किया गया.

Response Cache नीति को एपीआई प्रॉक्सी में दो जगहों पर अटैच किया जाता है. पहली बार अनुरोध में और दूसरी बार जवाब में. इसलिए, यह नीति आम तौर पर एपीआई कॉल में दो बार लागू होती है. कैश मेमोरी से डेटा 'get' करने और कैश मेमोरी में डेटा 'put' करने को एक-एक बार के एक्ज़ीक्यूशन के तौर पर गिना जाता है.

हालांकि, अगर नीति में मौजूद <SkipCacheLookup> एलिमेंट की वैल्यू अनुरोध में सही के तौर पर तय की जाती है, तो रिस्पॉन्स कैश मेमोरी का इस्तेमाल 0 होता है. साथ ही, अगर नीति में मौजूद <SkipCachePopulation> एलिमेंट की वैल्यू जवाब में सही के तौर पर तय की जाती है, तो रिस्पॉन्स कैश मेमोरी का इस्तेमाल 0 होता है.

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

एपीआई सिंटैक्स: sum(ax_cache_executed)

जवाब प्रोसेस होने में लगने वाला समय response_processing_latency औसत, कम से कम, ज़्यादा से ज़्यादा

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

अलग-अलग डाइमेंशन का इस्तेमाल करके, एपीआई प्रॉक्सी, क्षेत्र वगैरह के हिसाब से, रिस्पॉन्स प्रोसेस होने में लगने वाले समय की जांच की जा सकती है.

एपीआई सिंटैक्स: min(response_processing_latency)

जवाब का साइज़ response_size sum, avg, min, max

क्लाइंट को भेजे गए जवाब के पेलोड का साइज़, बाइट में.

एपीआई सिंटैक्स: max(response_size)

टारगेट से जुड़ी गड़बड़ियां target_error सम करें

टारगेट की गई सेवा से मिले 5xx रिस्पॉन्स की कुल संख्या. ये टारगेट सेवा से जुड़ी गड़बड़ियां हैं. ये Apigee की वजह से नहीं हुई हैं.

एपीआई सिंटैक्स: sum(target_error)

जवाब देने में लगने वाला टारगेट समय target_response_time sum, avg, min, max

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

ध्यान दें कि अगर कोई एपीआई कॉल, कैश मेमोरी से रिस्पॉन्स दिखाता है (उदाहरण के लिए, Response Cache नीति का इस्तेमाल करके), तो कॉल कभी भी टारगेट सेवा तक नहीं पहुंचेगा. साथ ही, टारगेट रिस्पॉन्स टाइम की कोई भी मेट्रिक लॉग नहीं की जाएगी.

एपीआई सिंटैक्स: avg(target_response_time)

जवाब देने में लगने वाला कुल समय total_response_time sum, avg, min, max

यह वह समय होता है जो Edge को क्लाइंट से अनुरोध मिलने और क्लाइंट को वापस जवाब भेजने में लगता है. यह समय, मिलीसेकंड में होता है. यह समय, कुल, औसत, कम से कम या ज़्यादा से ज़्यादा हो सकता है. इस समय में नेटवर्क ओवरहेड (जैसे कि लोड बैलेंसर और राऊटर को अपना काम करने में लगने वाला समय), अनुरोध को प्रोसेस करने में लगने वाला समय, जवाब को प्रोसेस करने में लगने वाला समय, और टारगेट रिस्पॉन्स टाइम शामिल होता है. टारगेट रिस्पॉन्स टाइम तब शामिल होता है, जब जवाब को कैश मेमोरी के बजाय टारगेट सेवा से दिखाया जाता है.

अलग-अलग डाइमेंशन का इस्तेमाल करके, एपीआई प्रॉक्सी, डेवलपर ऐप्लिकेशन, क्षेत्र वगैरह के हिसाब से प्रोसेसिंग में लगने वाले समय की जांच की जा सकती है.

एपीआई सिंटैक्स: avg(total_response_time)

ट्रैफ़िक message_count सम करें

यह चुनी गई समयावधि में, Edge की ओर से प्रोसेस किए गए एपीआई कॉल की कुल संख्या होती है.

डाइमेंशन का इस्तेमाल करके, ट्रैफ़िक की गिनती को अपने हिसाब से ग्रुप करें.

एपीआई सिंटैक्स: sum(message_count)

आयाम

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

Apigee, ये डाइमेंशन डिफ़ॉल्ट रूप से उपलब्ध कराता है. इसके अलावा, कस्टम Analytics का इस्तेमाल करके, एपीआई मैसेज के कॉन्टेंट का विश्लेषण करना लेख में बताए गए तरीके से, अपने डाइमेंशन बनाए जा सकते हैं.

कस्टम रिपोर्ट का नाम मैनेजमेंट एपीआई में इस्तेमाल किया जाने वाला नाम ब्यौरा
Apigee इकाइयां
ऐक्सेस टोकन access_token ऐप्लिकेशन के असली उपयोगकर्ता का OAuth ऐक्सेस टोकन.
एपीआई प्रॉडक्ट api_product

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

अगर ऊपर दी गई शर्तें पूरी नहीं की जाती हैं, तो आपको "(not set)" वैल्यू दिखेगी. यह भी देखें: Analytics इकाई की वैल्यू "(not set)" का क्या मतलब है?.

कैश मेमोरी का ऐक्सेस टोकन ax_cache_key

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

ट्रेस टूल में, जब रिस्पॉन्स कैश मेमोरी की ऐसी नीति चुनी जाती है जो कैश मेमोरी से डेटा पढ़ती है या उसमें डेटा लिखती है, तब आपको यह वैल्यू responsecache.cachekey फ़्लो वैरिएबल में दिख सकती है.

कैश मेमोरी का नाम ax_cache_name

यह उस कैश मेमोरी का नाम है जिसमें Response Cache नीति के लिए इस्तेमाल की गई कुंजियां/वैल्यू शामिल होती हैं. इसके नाम में orgName__envName__ प्रीफ़िक्स होता है. उदाहरण के लिए, अगर संगठन "foo" है, एनवायरमेंट "test" है, और कैश मेमोरी का नाम "myCache" है, तो ax_cache_name foo__test__myCache होगा.

ट्रेस टूल में, रिस्पॉन्स कैश मेमोरी की नीति चुनने पर, आपको यह वैल्यू responsecache.cachename फ़्लो वैरिएबल में दिखेगी.

कैश मेमोरी का सोर्स ax_cache_source

कैश लेवल ("L1" इन-मेमोरी या "L2" डेटाबेस), जहां से रिस्पॉन्स कैश को वापस पाया गया था. जब रिस्पॉन्स को कैश मेमोरी के बजाय टारगेट से डिलीवर किया गया हो और रिस्पॉन्स कैश मेमोरी को टारगेट रिस्पॉन्स के साथ रीफ़्रेश किया गया हो, तब यह डाइमेंशन "CACHE_MISS" दिखाता है. इसके अलावा, ऐसा तब भी होता है, जब अनुरोध में मौजूद कैश मेमोरी का कोई कुंजी अमान्य हो. कैश मेमोरी की कुंजियों का साइज़ 2 केबी से ज़्यादा नहीं होना चाहिए.

ट्रेस टूल में, Response Cache नीति चुनने पर, आपको यह वैल्यू responsecache.cachesource फ़्लो वैरिएबल में दिखेगी.

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

क्लाइंट आईडी client_id

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

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

अगर ऊपर दी गई शर्तें पूरी नहीं की जाती हैं, तो आपको "(not set)" वैल्यू दिखेगी. यह भी देखें: Analytics इकाई की वैल्यू "(not set)" का क्या मतलब है?.

Developer App developer_app

Edge में रजिस्टर किया गया डेवलपर ऐप्लिकेशन, एपीआई कॉल कर रहा है.

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

अगर ऊपर दी गई शर्तें पूरी नहीं की जाती हैं, तो आपको "(not set)" वैल्यू दिखेगी. यह भी देखें: Analytics इकाई की वैल्यू "(not set)" का क्या मतलब है?.

डेवलपर का ईमेल developer_email

Edge में रजिस्टर किए गए उन डेवलपर का ईमेल पता जिनके ऐप्लिकेशन ने एपीआई कॉल किए हैं.

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

अगर ऊपर दी गई शर्तें पूरी नहीं की जाती हैं, तो आपको "(not set)" वैल्यू दिखेगी. यह भी देखें: Analytics इकाई की वैल्यू "(not set)" का क्या मतलब है?.

डेवलपर आईडी developer

Edge से जनरेट किया गया डेवलपर का यूनीक आईडी, जो इस फ़ॉर्म में होता है: org_name@@@unique_id.

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

अगर ऊपर दी गई शर्तें पूरी नहीं की जाती हैं, तो आपको "(not set)" वैल्यू दिखेगी. यह भी देखें: Analytics इकाई की वैल्यू "(not set)" का क्या मतलब है?.

परिवेश वातावरण Edge एनवायरमेंट, जिसमें एपीआई प्रॉक्सी डिप्लॉय की जाती हैं. उदाहरण के लिए, "test" या "prod".
गड़बड़ी होने पर फ़ॉल्ट कोड ax_edge_execution_fault_code

गड़बड़ी का फ़ॉल्ट कोड. उदाहरण के लिए: messaging.adaptors.http.flow.GatewayTimeout

गड़बड़ी होने पर फ़्लो का नाम ax_execution_fault
  _flow_name

एपीआई प्रॉक्सी में मौजूद, नाम वाले फ़्लो में गड़बड़ी हुई है. उदाहरण के लिए, "PreFlow," "PostFlow," या आपके बनाए गए किसी शर्त वाले फ़्लो का नाम.

ध्यान दें कि मैनेजमेंट एपीआई में इस्तेमाल किया जाने वाला पूरा नाम ax_execution_fault_flow_name है. इसमें लाइन ब्रेक नहीं होता.

जहां कोई गड़बड़ी नहीं हुई है वहां आपको "(not set)" वैल्यू दिखेगी.

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

एपीआई प्रॉक्सी फ़्लो का नाम, जिससे गड़बड़ियां हुई हैं. जैसे, "PROXY_REQ_FLOW" या "TARGET_RESP_FLOW."

ध्यान दें कि मैनेजमेंट एपीआई में इस्तेमाल किया जाने वाला पूरा नाम ax_execution_fault_flow_state है. इसमें लाइन ब्रेक नहीं होता.

गेटवे फ़्लो आईडी gateway_flow_id एपीआई कॉल, Edge से होकर गुज़रते हैं. इसलिए, हर कॉल को अपना गेटवे फ़्लो आईडी मिलता है. उदाहरण: rrt329ea-12575-114653952-1. गेटवे फ़्लो आईडी, ज़्यादा टीपीएस वाली स्थितियों में मेट्रिक के बीच अंतर करने के लिए फ़ायदेमंद होता है. ऐसी स्थितियों में, संगठन, एनवायरमेंट, और टाइमस्टैंप जैसे अन्य डाइमेंशन, सभी कॉल के लिए एक जैसे होते हैं.
संगठन संगठन वह Edge संगठन जिसमें एपीआई प्रॉक्सी डिप्लॉय की जाती हैं.
गड़बड़ी होने पर नीति का नाम ax_execution_fault
  _policy_name

उस नीति का नाम जिसकी वजह से गड़बड़ी हुई और एपीआई कॉल पूरा नहीं हो सका.

ध्यान दें कि मैनेजमेंट एपीआई में इस्तेमाल किया जाने वाला पूरा नाम ax_execution_fault_policy_name है. इसमें लाइन ब्रेक नहीं होता.

अगर किसी नीति से जुड़ी गड़बड़ी होती है, लेकिन नीति के रूट एट्रिब्यूट continueOnError को true पर सेट किया जाता है, तो एपीआई प्रॉक्सी फ़्लो बिना किसी गड़बड़ी के जारी रहता है. साथ ही, इस डाइमेंशन में नीति के उल्लंघन को नहीं गिना जाता.

प्रॉक्सी apiproxy किसी एपीआई प्रॉक्सी का मशीन नेम (डिसप्ले नेम नहीं).
प्रॉक्सी बेस पाथ proxy_basepath

एपीआई प्रॉक्सी के ProxyEndpoint पर कॉन्फ़िगर किया गया BasePath. बेस पाथ में, एपीआई प्रॉक्सी यूआरएल का डोमेन और पोर्ट हिस्सा शामिल नहीं होता. उदाहरण के लिए, अगर किसी एपीआई प्रॉक्सी का बेस यूआरएल https://apigeedocs-test.apigee.net/releasenotes/ है, तो बेस पाथ /releasenotes होगा.

यह वैल्यू, proxy.basepath फ़्लो वैरिएबल में भी सेव होती है.

प्रॉक्सी पाथ सफ़िक्स proxy_pathsuffix

एपीआई प्रॉक्सी के बेस पाथ में जोड़ा गया संसाधन पाथ. उदाहरण के लिए, अगर किसी एपीआई प्रॉक्सी का बेस यूआरएल https://apigeedocs-test.apigee.net/hello/ है और https://apigeedocs-test.apigee.net/hello/json पर कॉल किया जाता है, तो पाथसफ़िक्स /json होगा.

अगर कोई पाथसफ़िक्स इस्तेमाल नहीं किया जाता है, तो वैल्यू खाली होती है.

यह वैल्यू, proxy.pathsuffix फ़्लो वैरिएबल में भी सेव होती है.

प्रॉक्सी में बदलाव apiproxy_revision एपीआई कॉल को मैनेज करने वाले एपीआई प्रॉक्सी का वर्शन नंबर. इसका मतलब यह नहीं है कि यह एपीआई प्रॉक्सी का नया वर्शन है. अगर किसी एपीआई प्रॉक्सी में 10 बदलाव किए गए हैं, तो हो सकता है कि फ़िलहाल आठवां बदलाव डिप्लॉय किया गया हो. इसके अलावा, किसी एपीआई के कई वर्शन डिप्लॉय किए जा सकते हैं. हालांकि, इसके लिए ज़रूरी है कि वर्शन के बेस पाथ अलग-अलग हों. इस बारे में यूज़र इंटरफ़ेस (यूआई) में प्रॉक्सी डिप्लॉय करना लेख में बताया गया है.
क्लाइंट का हल किया गया आईपी पता ax_resolved_client_ip

इसमें क्लाइंट का ओरिजनल आईपी पता होता है. ax_resolved_client_ip डाइमेंशन की वैल्यू का हिसाब, ax_true_client_ip और x_forwarded_for_ip डाइमेंशन की वैल्यू के आधार पर लगाया जाता है.

ध्यान दें कि क्लाइंट के असली आईपी पतों को कैप्चर करने के लिए, Akamai जैसे राउटिंग प्रॉडक्ट का इस्तेमाल करते समय, क्लाइंट के आईपी पते को HTTP हेडर True-Client-IP में Edge को पास किया जाता है. इसके बाद, इसका इस्तेमाल ax_true_client_ip डाइमेंशन को सेट करने के लिए किया जाता है.

ax_resolved_client_ip डाइमेंशन की वैल्यू इस तरह कैलकुलेट की जाती है:

  1. अगर ax_true_client_ip शून्य नहीं है और इसमें कोई लोकल आईपी पता नहीं है, तो ax_resolved_client_ip को ax_true_client_ip पर सेट करें.
  2. अगर ऐसा नहीं है, तो ax_resolved_client_ip को x_forwarded_for_ip में मौजूद पहले नॉन-लोकल आईपी पते पर सेट करें.
  3. अगर ax_true_client_ip और x_forwarded_for_ip, दोनों में सिर्फ़ लोकल आईपी पते शामिल हैं, तो ax_resolved_client_ip को x_forwarded_for_ip में मौजूद पहले लोकल आईपी पते पर सेट करें.
  4. अगर ax_true_client_ip और x_forwarded_for_ip, दोनों शून्य हैं, तो ax_resolved_client_ip को (not set) पर सेट करें.
  5. अगर ax_true_client_ip कोई लोकल आईपी पता है और x_forwarded_for_ip शून्य है, तो ax_resolved_client_ip को (not set) पर सेट करें.
जवाब का स्टेटस कोड response_status_code Apigee से क्लाइंट को फ़ॉरवर्ड किया गया एचटीटीपी रिस्पॉन्स स्टेटस कोड, जैसे कि 200, 404, 503 वगैरह. Edge में, टारगेट से मिले जवाब के स्टेटस कोड को Assign Message और Raise Fault जैसी नीतियों से बदला जा सकता है. इसलिए, यह डाइमेंशन टारगेट रिस्पॉन्स कोड (target_response_code) से अलग हो सकता है.
वर्चुअल होस्ट virtual_host उस वर्चुअल होस्ट का नाम जिस पर एपीआई कॉल किया गया था. उदाहरण के लिए, संगठनों के पास डिफ़ॉल्ट रूप से दो वर्चुअल होस्ट होते हैं: default (http) और secure (https).
इनबाउंड/क्लाइंट
क्लाइंट का आईपी पता client_ip राउटर को हिट करने वाले सिस्टम का आईपी पता. जैसे, ओरिजनल क्लाइंट (proxy_client_ip) या लोड बैलेंसर. X-Forwarded-For हेडर में एक से ज़्यादा आईपी होने पर, यह आखिरी आईपी होता है.
डिवाइस की कैटगरी ax_ua_device_category वह डिवाइस टाइप जिससे एपीआई कॉल किया गया था. जैसे, "टैबलेट" या "स्मार्टफ़ोन".
ओएस फ़ैमिली ax_ua_os_family कॉल करने वाले डिवाइस के ऑपरेटिंग सिस्टम का फ़ैमिली ग्रुप, जैसे कि "Android" या "iOS".
OS वर्शन ax_ua_os_version

कॉल करने वाले डिवाइस के ऑपरेटिंग सिस्टम का वर्शन.

ऑपरेटिंग सिस्टम के वर्शन देखने के लिए, इसे ओएस फ़ैमिली (ax_ua_os_family) के साथ दूसरे "ड्रिल-डाउन" डाइमेंशन के तौर पर इस्तेमाल करना फ़ायदेमंद होता है.

प्रॉक्सी क्लाइंट का आईपी पता proxy_client_ip

कॉल करने वाले क्लाइंट का आईपी पता, जो proxy.client.ip फ़्लो वैरिएबल में सेव होता है. यह अक्सर इनबाउंड कॉल का X-Forwarded-For पता होता है. यह वह आईपी पता होता है जो Edge को आखिरी बाहरी टीसीपी हैंडशेक से मिला था. यह कॉलिंग क्लाइंट या लोड बैलेंसर हो सकता है. अगर X-Forwarded-For हेडर में एक से ज़्यादा आईपी पते हैं, तो यह आखिरी आईपी पता होता है.

रेफ़र किया गया क्लाइंट आईपी ax_true_client_ip

क्लाइंट के ओरिजनल आईपी पतों को कैप्चर करने के लिए, Akamai जैसे राउटिंग प्रॉडक्ट का इस्तेमाल करते समय, क्लाइंट के आईपी पते, एचटीटीपी हेडर True-Client-IP में Edge को पास किए जाते हैं. यह डाइमेंशन, उस हेडर से क्लाइंट के ओरिजनल आईपी पतों को कैप्चर करता है.

क्लाइंट के ओरिजनल आईपी पते का पता लगाने के लिए, Edge ax_true_client_ip और x_forwarded_for_ip डाइमेंशन का इस्तेमाल करता है. इस पते को ax_resolved_client_ip डाइमेंशन के ज़रिए ऐक्सेस किया जाता है.

अनुरोध का पाथ request_path

टारगेट सेवा का संसाधन पाथ (इसमें डोमेन शामिल नहीं है). इसमें क्वेरी पैरामीटर शामिल नहीं हैं.

उदाहरण के लिए, Apigee के सैंपल टारगेट http://mocktarget.apigee.net में कई संसाधन शामिल हैं. इनमें /user भी शामिल है, जो अभिवादन दिखाता है. आपकी एपीआई प्रॉक्सी, http://mocktarget.apigee.net/user को कैसे भी कॉल करे, request_path /user होता है.

अनुरोध URI request_uri

टारगेट सेवा का संसाधन पाथ (इसमें डोमेन शामिल नहीं है). इसमें क्वेरी पैरामीटर भी शामिल हैं.

उदाहरण के लिए, Apigee के सैंपल टारगेट http://mocktarget.apigee.net में कई रिसॉर्स शामिल हैं. इनमें /user?user={name} रिसॉर्स और क्वेरी पैरामीटर शामिल हैं. इनकी मदद से, दिए गए नाम के हिसाब से कस्टम ग्रीटिंग दिखाई जाती है. आपके एपीआई प्रॉक्सी कॉल http://mocktarget.apigee.net/user?user=Dude से कोई फ़र्क़ नहीं पड़ता, request_uri /user?user=Dude होता है.

अनुरोध करने के लिए इस्तेमाल किया गया शब्द request_verb एपीआई अनुरोधों में एचटीटीपी अनुरोध वर्ब, जैसे कि GET, POST, PUT, DELETE.
उपयोगकर्ता एजेंट useragent

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

  • Chrome से कॉल करने वाला Pixel XL: Mozilla/5.0 (Linux; Android 7.1.2; Pixel XL Build/NHG47N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.92 Mobile Safari/537.36
  • Chrome से कॉल करने वाला iPad: Mozilla/5.0 (iPad; CPU OS 10_2 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/54.0.2840.91 Mobile/14C92 Safari/602.1
  • टर्मिनल से cURL: curl/7.51.0
उपयोगकर्ता एजेंट फ़ैमिली ax_ua_agent_family यूज़र एजेंट का फ़ैमिली ग्रुप, जैसे कि "Chrome Mobile" या "cURL".
उपयोगकर्ता एजेंट का टाइप ax_ua_agent_type उपयोगकर्ता एजेंट का टाइप, जैसे कि "Browser," "Mobile Browser," "Library," वगैरह.
उपयोगकर्ता एजेंट का वर्शन ax_ua_agent_version

useragent का वर्शन.

एजेंट फ़ैमिली (ax_ua_agent_family) के साथ इस डाइमेंशन का इस्तेमाल दूसरे "ड्रिल-डाउन" डाइमेंशन के तौर पर किया जा सकता है. इससे एजेंट फ़ैमिली का वर्शन मिलता है.

आउटबाउंड/टारगेट
टारगेट बेस पाथ target_basepath

टारगेट सेवा का संसाधन पाथ (इसमें डोमेन शामिल नहीं है). इसमें क्वेरी पैरामीटर शामिल नहीं हैं. यह पाथ, प्रॉक्सी के <TargetEndpoint> में तय किया जाता है.

उदाहरण के लिए, मान लें कि कोई एपीआई प्रॉक्सी इस टारगेट को कॉल करती है:

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

इस उदाहरण में, target_basepath /user है.

अगर टारगेट यह होता:

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net</URL>
</HTTPTargetConnection>

target_basepath की वैल्यू शून्य होगी.

ट्रेस टूल में, फ़्लो डायग्राम के आखिर में AX आइकॉन चुनने पर, target.basepath फ़्लो वैरिएबल, target_basepath डाइमेंशन पर मैप होता है.

टारगेट होस्ट target_host टारगेट सेवा का होस्ट. उदाहरण के लिए, अगर कोई एपीआई प्रॉक्सी http://mocktarget.apigee.net/help को कॉल करता है, तो target_host mocktarget.apigee.net होता है.
टारगेट आईपी पता target_ip यह उस टारगेट सेवा का आईपी पता होता है जो एपीआई प्रॉक्सी को जवाब भेजती है.
टारगेट रिस्पॉन्स कोड target_response_code

यह टारगेट सेवा से एपीआई प्रॉक्सी को मिला एचटीटीपी रिस्पॉन्स स्टेटस कोड होता है. जैसे, 200, 404, 503 वगैरह.

"null" वैल्यू का मतलब है कि अनुरोध कभी भी टारगेट सेवा तक नहीं पहुंचा. ऐसा तब होता है, जब Response Cache नीति के तहत जवाब दिया जाता है या अनुरोध को प्रोसेस करने में गड़बड़ी होती है.

यह जवाब का स्टेटस कोड (response_status_code) डाइमेंशन से अलग है.

टारगेट यूआरएल target_url

एपीआई प्रॉक्सी के TargetEndpoint में तय की गई टारगेट सेवा का पूरा यूआरएल.

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

इस उदाहरण में, target_url http://mocktarget.apigee.net/user?user=Dude है.

ध्यान दें कि एपीआई प्रॉक्सी प्रोसेसिंग के दौरान, target.url फ़्लो वैरिएबल का इस्तेमाल करके यूआरएल को बदला भी जा सकता है.

प्रॉक्सी चेनिंग और स्क्रिप्ट टारगेट (Node.js) का इस्तेमाल करते समय, कॉलिंग प्रॉक्सी में target_url शून्य होता है.

X-Forwarded-For x_forwarded_for_ip

X-Forwarded-For हेडर में मौजूद आईपी पतों की सूची.

क्लाइंट के ओरिजनल आईपी पते का पता लगाने के लिए, Edge ax_true_client_ip और x_forwarded_for_ip डाइमेंशन का इस्तेमाल करता है. इस पते को ax_resolved_client_ip डाइमेंशन के ज़रिए ऐक्सेस किया जाता है.

समय
हफ़्ते का दिन ax_day_of_week एपीआई कॉल किए जाने वाले दिन के नाम का तीन अक्षरों वाला छोटा नाम. उदाहरण के लिए, सोम, मंगल, बुध.
महीना ax_month_of_year वह महीना जिसमें एपीआई कॉल किए गए थे. उदाहरण के लिए, मार्च के लिए "03".
दिन का समय ax_hour_of_day

24 घंटे की घड़ी के हिसाब से, एपीआई कॉल किए जाने का दो अंकों वाला घंटा. उदाहरण के लिए, अगर रात 10 बजे से 11 बजे के बीच एपीआई कॉल किए जाते हैं, तो ax_hour_of_day की वैल्यू 22 होगी.

समय की वैल्यू यूटीसी में होती है.

समय क्षेत्र ax_geo_timezone एपीआई कॉल के लिए इस्तेमाल किए गए टाइम ज़ोन के सामान्य नाम, जैसे कि America/New_York और Europe/Dublin.
महीने का हफ़्ता ax_week_of_month महीने का हफ़्ता, जो अंकों में होता है. उदाहरण के लिए, अगर किसी महीने के तीसरे हफ़्ते में एपीआई कॉल किए जाते हैं, तो ax_week_of_month की वैल्यू 3 होती है.
जगह की जानकारी
शहर ax_geo_city वह शहर जहां से एपीआई कॉल किए गए थे.
महाद्वीप ax_geo_continent उस महाद्वीप का दो-अक्षर वाला कोड जहां से एपीआई कॉल किए गए थे. उदाहरण के लिए, उत्तरी अमेरिका के लिए NA.
देश ax_geo_country उस देश का दो अक्षरों वाला कोड जिससे एपीआई कॉल किए गए थे. उदाहरण के लिए, अमेरिका के लिए US.
भौगोलिक इलाका ax_geo_region भौगोलिक क्षेत्र के लिए हाइफ़न वाला कोड, जैसे कि STATE-COUNTRY. उदाहरण के लिए, WA-US, वॉशिंगटन-अमेरिका के लिए.
क्षेत्र ax_dn_region Apigee डेटा सेंटर का नाम, जहां एपीआई प्रॉक्सी डिप्लॉय की जाती हैं. जैसे, us-east-1.
कमाई करना
मिंट किए गए लेन-देन के मैसेज को अनदेखा करें x_apigee_mint_tx_ignoreMessage इस फ़्लैग से पता चलता है कि कमाई करने से जुड़े मैसेज को अनदेखा करना है या नहीं. कमाई करने वाले सभी संगठनों के लिए, false पर सेट किया गया है.
Mint में लेन-देन की स्थिति x_apigee_mint_tx_status कमाई करने के अनुरोध की स्थिति, जैसे कि अनुरोध पूरा हुआ, पूरा नहीं हुआ, अमान्य है या कोई नहीं.

फ़िल्टर

फ़िल्टर की मदद से, नतीजों को ऐसी मेट्रिक तक सीमित किया जा सकता है जिनमें कुछ खास विशेषताएं हों. यहां फ़िल्टर के कुछ सैंपल दिए गए हैं. फ़िल्टर तय करते समय, मेट्रिक और डाइमेंशन के एपीआई-स्टाइल वाले नामों का इस्तेमाल करें.

यह क्वेरी, books या music नाम वाली एपीआई प्रॉक्सी के लिए मेट्रिक दिखाती है:

filter=(apiproxy in 'books','music')

"m" से शुरू होने वाले नामों वाली एपीआई प्रॉक्सी के लिए मेट्रिक दिखाता है:

filter=(apiproxy like 'm%')

यह "m" से शुरू न होने वाले नामों वाली एपीआई प्रॉक्सी के लिए मेट्रिक दिखाता है:

filter=(apiproxy not like 'm%')

यह 400 से 599 के बीच के जवाब वाले स्टेटस कोड के साथ एपीआई कॉल के लिए मेट्रिक दिखाता है:

filter=(response_status_code ge 400 and response_status_code le 599)

यह क्वेरी, एपीआई कॉल के लिए मेट्रिक दिखाती है. इन कॉल के लिए, रिस्पॉन्स स्टेटस कोड 200 है और टारगेट रिस्पॉन्स कोड 404 है:

filter=(response_status_code eq 200 and target_response_code eq 404)

यह 500 के रिस्पॉन्स स्टेटस कोड वाले एपीआई कॉल के लिए मेट्रिक दिखाता है:

filter=(response_status_code eq 500)

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

filter=(is_error eq 0)

रिपोर्ट फ़िल्टर बनाने के लिए, इन ऑपरेटर का इस्तेमाल किया जा सकता है.

ऑपरेटर ब्यौरा
in सूची में शामिल करें
notin सूची से बाहर रखें
eq बराबर है, ==
ne इसके बराबर नहीं है, !=
gt इससे ज़्यादा, >
lt < से कम
ge इससे ज़्यादा या इसके बराबर, >=
le इससे कम या इसके बराबर, <=
like अगर स्ट्रिंग पैटर्न, दिए गए पैटर्न से मेल खाता है, तो यह फ़ंक्शन true दिखाता है.
not like अगर स्ट्रिंग पैटर्न, दिए गए पैटर्न से मेल खाता है, तो यह फ़ंक्शन 'गलत' दिखाता है.
similar to यह फ़ंक्शन, यह तय करता है कि इसका पैटर्न दी गई स्ट्रिंग से मेल खाता है या नहीं. इसके आधार पर, यह 'सही' या 'गलत' वैल्यू दिखाता है. यह like जैसा ही है. हालांकि, यह पैटर्न को SQL स्टैंडर्ड के रेगुलर एक्सप्रेशन की परिभाषा का इस्तेमाल करके इंटरप्रेट करता है.
not similar to यह फ़ंक्शन, यह तय करता है कि पैटर्न, दी गई स्ट्रिंग से मैच होता है या नहीं. इसके आधार पर, यह फ़ंक्शन 'गलत' या 'सही' वैल्यू दिखाता है. यह not like जैसा ही है. हालांकि, यह पैटर्न को SQL स्टैंडर्ड की रेगुलर एक्सप्रेशन की परिभाषा का इस्तेमाल करके इंटरप्रेट करता है.
and इस विकल्प की मदद से, एक से ज़्यादा फ़िल्टर एक्सप्रेशन शामिल करने के लिए 'और' लॉजिक का इस्तेमाल किया जा सकता है. इस फ़िल्टर में, ऐसी जानकारी शामिल होती है जो सभी शर्तों को पूरा करती है.
or इसकी मदद से, फ़िल्टर करने के अलग-अलग एक्सप्रेशन का आकलन करने के लिए, 'या' लॉजिक का इस्तेमाल किया जा सकता है. इस फ़िल्टर में, ऐसा डेटा शामिल होता है जो कम से कम एक शर्त को पूरा करता है.