सूचनाएं और सूचनाएं सेट अप करना

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

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

उदाहरण के लिए, अगर आपको अपने प्रोडक्शन एनवायरमेंट में डिप्लॉय की गई orders-prod एपीआई प्रॉक्सी के लिए, पांच मिनट की अवधि में 5xx गड़बड़ी की दर 23% से ज़्यादा होने पर, सूचना ट्रिगर करनी है और ऑपरेशंस टीम को सूचना भेजनी है.

इस इमेज में दिखाया गया है कि यूज़र इंटरफ़ेस (यूआई) में सूचनाएं कैसे दिखती हैं:

यहां ईमेल सूचना का एक उदाहरण दिया गया है. जब कोई सूचना ट्रिगर होती है, तब आपको यह सूचना मिल सकती है.

सूचना के मुख्य हिस्से में, ज़्यादा जानकारी के लिए इन लिंक पर क्लिक करें:

  • ज़्यादा जानकारी देखने के लिए, जानकारी देखें पर क्लिक करें. इसमें पिछले एक घंटे में, हर शर्त के लिए सूचना की सेटिंग और गतिविधि शामिल है.
  • चेतावनी की परिभाषा देखने के लिए, चेतावनी की परिभाषा पर क्लिक करें.
  • चेतावनी का इतिहास पर क्लिक करें. इससे आपको उस चेतावनी के बारे में ज़्यादा जानकारी मिलेगी.
  • अगर सुझाई गई कार्रवाइयां उपलब्ध हैं, तो उन्हें देखने के लिए प्लेबुक देखें पर क्लिक करें.
  • सूचना की शर्त के लिए कस्टम रिपोर्ट देखने के लिए, एपीआई Analytics रिपोर्ट देखें पर क्लिक करें.

यहां दिए गए सेक्शन में, सूचनाएं और सूचनाएं सेट अप करने और उन्हें मैनेज करने का तरीका बताया गया है.

सूचनाओं के टाइप के बारे में जानकारी

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

उदाहरण के लिए, इन स्थितियों में तय की गई सूचना दी जा सकती है:

  • [target mytarget1] के लिए, [10 मिनट] तक [5xx गड़बड़ियों की दर], [10%] [से ज़्यादा है]
  • [region us-east-1] में [5 मिनट] के लिए, [2xx गड़बड़ियों की संख्या] [50] [से कम है]
  • [p90 latency] [is greater than] [750ms] for [10 minutes] on [proxy myproxy1]

13.11.19 को सुरक्षा से जुड़ी रिपोर्टिंग के बीटा वर्शन की रिलीज़ में, नई तरह की चेतावनियां जोड़ी गई हैं:

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

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

सूचना बनाने वाले डायलॉग बॉक्स में अब सूचनाओं के कई टाइप उपलब्ध हैं

अलर्ट सेटिंग देखना

फ़िलहाल, सूचनाओं के लिए तय की गई सेटिंग देखने के लिए, Edge UI में विश्लेषण करें > सूचना के नियम पर क्लिक करें.

सूचना पेज पर, यह जानकारी दिखती है. जैसा कि इस इमेज में दिखाया गया है:

सूचना वाला ईमेल

इमेज में हाइलाइट किए गए सूचना पेज पर, ये काम किए जा सकते हैं:

अपने संगठन के लिए ट्रिगर की गई सूचनाओं का इतिहास देखना

पिछले 24 घंटों में आपके संगठन के लिए ट्रिगर की गई सूचनाओं का इतिहास देखने के लिए, Edge UI में विश्लेषण करें > सूचना के नियम पर क्लिक करें. इसके बाद, इतिहास टैब पर क्लिक करें.

इसके बाद, सूचना का इतिहास पेज दिखेगा.

चेतावनी का इतिहास

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

सूचनाएं और अपडेट जोड़ना

सूचनाएं और सूचनाएं जोड़ने के लिए:

  1. Edge UI में, विश्लेषण करें > सूचना के नियम पर क्लिक करें.
  2. +सूचना पर क्लिक करें.
  3. सूचना के बारे में यह सामान्य जानकारी डालें:
    फ़ील्ड ब्यौरा
    सूचना का नाम सूचना का नाम. ऐसा नाम इस्तेमाल करें जो ट्रिगर के बारे में बताता हो और आपके लिए काम का हो. नाम में 128 से ज़्यादा वर्ण नहीं होने चाहिए.
    अलर्ट प्रकार ठीक किया गया को चुनें. सूचनाओं के टाइप के बारे में ज़्यादा जानने के लिए, सूचनाओं के टाइप के बारे में जानकारी लेख पढ़ें.
    ब्यौरा सूचना का ब्यौरा.
    परिवेश ड्रॉपडाउन सूची से एनवायरमेंट चुनें.
    स्थिति सूचना पाने की सुविधा को चालू या बंद करने के लिए, टॉगल करें.
  4. पहली शर्त के लिए मेट्रिक, थ्रेशोल्ड, और डाइमेंशन तय करें. इस शर्त के पूरा होने पर सूचना ट्रिगर होगी.
    शर्त वाला फ़ील्ड ब्यौरा
    मेट्रिक

    इनमें से कोई एक मेट्रिक चुनें:

    • स्टेटस कोड: सूची से कोई स्टेटस कोड चुनें. जैसे, 401, 404, 2xx, 4xx या 5xx एचटीटीपी.

      ध्यान दें:

      • एपीआई की मदद से, स्टेटस कोड की एक बड़ी रेंज सेट की जा सकती है. एपीआई का इस्तेमाल करके, 200 से 299, 400 से 599 के बीच का कोई भी स्टेटस कोड और 2xx, 4xx या 5xx की वाइल्डकार्ड वैल्यू तय करें. सूचना बनाना लेख पढ़ें.
      • दर सीमित करने से जुड़ी सूचनाओं (एचटीटीपी स्टेटस कोड 429) के लिए, मेट्रिक को स्पाइक अरेस्ट फ़ॉल्ट कोड पर सेट करें.
      • AssignMessage नीति का इस्तेमाल करके, एचटीटीपी रिस्पॉन्स कोड को फिर से लिखा जा सकता है. यह कोड, प्रॉक्सी या टारगेट की गड़बड़ी से मिला होता है. एपीआई मॉनिटरिंग, फिर से लिखे गए किसी भी कोड को अनदेखा करती है और असली एचटीटीपी रिस्पॉन्स कोड को लॉग करती है.
    • लेटेंसी: ड्रॉपडाउन सूची से लेटेंसी की कोई वैल्यू चुनें. खास तौर पर: p50 (50वां पर्सेंटाइल), p90 (90वां पर्सेंटाइल), p95 (95वां पर्सेंटाइल) या p99 (99वां पर्सेंटाइल). उदाहरण के लिए, p95 को चुनें. इससे ऐसी सूचना सेट अप की जा सकती है जो तब ट्रिगर होती है, जब 95वें पर्सेंटाइल के लिए रिस्पॉन्स में लगने वाला समय, नीचे सेट की गई थ्रेशोल्ड वैल्यू से ज़्यादा हो.
    • गड़बड़ी का कोड: सूची से कोई कैटगरी, सब-कैटगरी, और गड़बड़ी का कोड चुनें. इसके अलावा, किसी कैटगरी या सब-कैटगरी में इनमें से कोई एक विकल्प चुनें:

      • सभी - इस कैटगरी/सबकैटगरी के सभी गड़बड़ी कोड के लिए, मेट्रिक की शर्तों को पूरा करना ज़रूरी है.
      • कोई भी - इस कैटगरी/सबकैटगरी में मौजूद किसी भी एक फ़ॉल्ट कोड को मेट्रिक की शर्तों को पूरा करना होगा.

      ज़्यादा जानकारी के लिए, गड़बड़ी के कोड की जानकारी देखें.

    थ्रेशोल्ड

    चुनी गई मेट्रिक के लिए थ्रेशोल्ड कॉन्फ़िगर करें:

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

    अगर आपने किसी डाइमेंशन को इस तरह सेट किया है:

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

    डाइमेंशन को टारगेट पर सेट करने पर, आपके पास टारगेट सेवा या ServiceCallout नीति में बताई गई सेवा को चुनने का विकल्प होता है. ServiceCallout नीति का टारगेट, `sc://` से पहले की गई वैल्यू के तौर पर दिखता है. उदाहरण के लिए, `sc://my.endpoint.net`.

  5. पिछले एक घंटे में, स्थिति के लिए हाल ही का डेटा देखने के लिए, स्थिति का डेटा दिखाएं पर क्लिक करें.
    ग्राफ़ में गड़बड़ी की दर, सूचना की स्थिति के थ्रेशोल्ड से ज़्यादा होने पर लाल रंग में दिखती है.
    शर्तों का डेटा दिखाना

    डेटा छिपाने के लिए, मौसम की स्थिति का डेटा छिपाएं पर क्लिक करें.

  6. अन्य शर्तें जोड़ने के लिए, + शर्त जोड़ें पर क्लिक करें. इसके बाद, चरण 4 और 5 को दोहराएं.

    ध्यान दें: अगर आपने एक से ज़्यादा शर्तें तय की हैं, तो सभी शर्तें पूरी होने पर ही सूचना ट्रिगर होगी.

  7. अगर आपको कॉन्फ़िगर की गई सूचना की शर्तों के आधार पर कस्टम रिपोर्ट बनानी है, तो सूचना की शर्तों के आधार पर, एपीआई की परफ़ॉर्मेंस से जुड़ी रिपोर्ट बनाएं पर क्लिक करें. अगर आप संगठन के एडमिन नहीं हैं, तो यह विकल्प धूसर हो जाता है.

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

    ध्यान दें: सूचना सेव करने के बाद, कस्टम रिपोर्ट में बदलाव किया जा सकता है. इसके बारे में कस्टम रिपोर्ट मैनेज करना लेख में बताया गया है.

  8. सूचना जोड़ने के लिए, + सूचना पर क्लिक करें.
    सूचना की जानकारी ब्यौरा
    चैनल सूचना का चैनल चुनें जिसका आप इस्तेमाल करना चाहते हैं और डेस्टिनेशन बताएं: ईमेल, Slack, PagerDuty या Webhook.
    मंज़िल चुने गए चैनल टाइप के हिसाब से डेस्टिनेशन तय करें:
    • ईमेल - ईमेल पता, जैसे कि joe@company.com
    • Slack - Slack चैनल का यूआरएल, जैसे कि https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - PagerDuty कोड, जैसे कि abcd1234efgh56789
    • वेबहुक - वेबहुक यूआरएल, जैसे कि https://apigee.com/test-webhook. यूआरएल को भेजे गए ऑब्जेक्ट के बारे में जानने के लिए, वेबबुक ऑब्जेक्ट का फ़ॉर्मैट देखें.

      वेबबुक के यूआरएल में क्रेडेंशियल की कोई भी जानकारी पास करें. उदाहरण के लिए: https://apigee.com/test-webhook?auth_token=1234_abcd.

      उस एंडपॉइंट का यूआरएल दिया जा सकता है जो वेबहुक ऑब्जेक्ट को पार्स करके, उसमें बदलाव कर सकता है या उसे प्रोसेस कर सकता है. उदाहरण के लिए, किसी एपीआई (जैसे, Edge API) या किसी ऐसे एंडपॉइंट का यूआरएल तय किया जा सकता है जो ऑब्जेक्ट को प्रोसेस कर सकता है.

      ध्यान दें: हर सूचना के लिए सिर्फ़ एक डेस्टिनेशन तय किया जा सकता है. एक ही तरह के चैनल के लिए, एक से ज़्यादा डेस्टिनेशन तय करने के लिए, सूचनाएं पाने के अन्य तरीके जोड़ें.

  9. अन्य सूचनाएं जोड़ने के लिए, आठवां चरण दोहराएं.
  10. अगर आपने सूचना जोड़ी है, तो इन फ़ील्ड की वैल्यू सेट करें:
    फ़ील्ड ब्यौरा
    प्लेबुक (ज़रूरी नहीं) फ़्री-फ़ॉर्म टेक्स्ट फ़ील्ड. इसमें, सूचनाएं मिलने पर उन्हें ठीक करने के लिए सुझाए गए तरीकों के बारे में कम शब्दों में जानकारी दी जाती है. आपके पास अपनी इंटरनल विकी या कम्यूनिटी पेज का लिंक देने का विकल्प भी है. इस पेज पर, सबसे सही तरीकों के बारे में बताया गया हो. इस फ़ील्ड में मौजूद जानकारी को सूचना में शामिल किया जाएगा. इस फ़ील्ड में मौजूद कॉन्टेंट में 1,500 से ज़्यादा वर्ण नहीं होने चाहिए.
    थ्रॉटल करें सूचनाएं भेजने की फ़्रीक्वेंसी. ड्रॉपडाउन मेन्यू से कोई वैल्यू चुनें. मान्य वैल्यू में ये शामिल हैं: 15 मिनट, 30 मिनट, और 1 घंटा.
  11. सेव करें पर क्लिक करें.

वेबबुक ऑब्जेक्ट का फ़ॉर्मैट

अगर आपने सूचना पाने के लिए वेबहुक यूआरएल को डेस्टिनेशन के तौर पर चुना है, तो यूआरएल को भेजा गया ऑब्जेक्ट इस फ़ॉर्मैट में होगा:
{
  "alertInstanceId": "event-id",
  "alertName": "name",
  "org": "org-name",
  "description": "alert-description",
  "alertId": "alert-id",
  "alertTime": "alert-timestamp",
  "thresholdViolations":{"Count0": "Duration=threshold-duration Region=region Status Code=2xx Proxy=proxy Violation=violation-description"
  },
  "thresholdViolationsFormatted": [
    {
      "metric": "count",
      "duration": "threshold-duration",
      "proxy": "proxy",
      "region": "region",
      "statusCode": "2xx",
      "violation": "violation-description"
    }
  ],
  "playbook": "playbook-link"
}

thresholdViolations और thresholdViolationsFormatted प्रॉपर्टी में, सूचना के बारे में जानकारी होती है. thresholdViolations प्रॉपर्टी में, जानकारी वाली एक स्ट्रिंग होती है. वहीं, thresholdViolationsFormatted में चेतावनी के बारे में बताने वाला ऑब्जेक्ट होता है. आम तौर पर, thresholdViolationsFormatted प्रॉपर्टी का इस्तेमाल किया जाता है, क्योंकि इसे डिकोड करना आसान होता है.

ऊपर दिए गए उदाहरण में, statusCode प्रॉपर्टी के हिसाब से, एचटीटीपी 2xx स्टेटस कोड के आधार पर सूचना ट्रिगर करने के लिए, सूचना मेट्रिक को कॉन्फ़िगर करने पर, तय की गई सूचना के लिए इन प्रॉपर्टी का कॉन्टेंट दिखाया गया है.

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

यहां दी गई टेबल में, अलग-अलग तरह की सूचनाओं के लिए thresholdViolationsFormatted प्रॉपर्टी की सभी संभावित प्रॉपर्टी दिखाई गई हैं:

अलर्ट प्रकार थ्रेशोल्ड के उल्लंघन से जुड़ा फ़ॉर्मैट किया गया कॉन्टेंट
तय
metric, proxy, target, developerApp,
region, statusCode, faultCodeCategory, faultCodeSubCategory,
faultCode, percentile, comparisonType, thresholdValue,
triggerValue, duration, violation
कुल ट्रैफ़िक
metric, proxy, target, developerApp,
region, comparisonType, thresholdValue, triggerValue,
duration, violation
अनियमितता
metric, proxy, target, region,
statusCode, faultCode, percentile, sensitivity,
violation
TLS की समयसीमा खत्म होने की तारीख
envName, certificateName, thresholdValue, violation

सूचना से कस्टम रिपोर्ट बनाना

सूचना से कस्टम रिपोर्ट बनाने के लिए:

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

    अलर्ट सेव करने के बाद, यूज़र इंटरफ़ेस (यूआई) पर यह मैसेज दिखता है:

    Alert alertName saved successfully. To customize the report generated, click here.

    मैसेज पर क्लिक करें. इससे रिपोर्ट नए टैब में खुलेगी. इसमें काम के फ़ील्ड में पहले से ही जानकारी भरी होगी. डिफ़ॉल्ट रूप से, कस्टम रिपोर्ट का नाम यह होता है: API Monitoring Generated alertName

  2. अपनी ज़रूरत के हिसाब से कस्टम रिपोर्ट में बदलाव करें और सेव करें पर क्लिक करें.
  3. सूची में मौजूद रिपोर्ट के नाम पर क्लिक करें और कस्टम रिपोर्ट जनरेट करें.

सूचना की शर्तों के आधार पर बनाई गई कस्टम रिपोर्ट को मैनेज करने के लिए:

  1. Edge UI में, विश्लेषण करें > सूचना के नियम पर क्लिक करें.
  2. सेटिंग टैब पर क्लिक करें.
  3. 'रिपोर्ट' कॉलम में, उस कस्टम रिपोर्ट पर क्लिक करें जिससे जुड़ी सूचना को मैनेज करना है.

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

  4. अपनी ज़रूरत के हिसाब से कस्टम रिपोर्ट में बदलाव करें और सेव करें पर क्लिक करें.
  5. सूची में मौजूद रिपोर्ट के नाम पर क्लिक करें और कस्टम रिपोर्ट जनरेट करें.

किसी सूचना को चालू या बंद करना

किसी सूचना को चालू या बंद करने के लिए:

  1. Edge UI में, विश्लेषण करें > सूचना के नियम पर क्लिक करें.
  2. आपको जिस सूचना को चालू या बंद करना है उससे जुड़े स्टेटस कॉलम में मौजूद टॉगल पर क्लिक करें.

सूचना संपादित करना

किसी सूचना में बदलाव करने के लिए:

  1. Edge UI में, विश्लेषण करें > सूचना के नियम पर क्लिक करें.
  2. उस सूचना के नाम पर क्लिक करें जिसमें आपको बदलाव करना है.
  3. ज़रूरत के मुताबिक सूचना में बदलाव करें.
  4. सेव करें पर क्लिक करें.

चेतावनी हटाएं

किसी सूचना को मिटाने के लिए:

  1. Edge UI में, विश्लेषण करें > सूचना के नियम पर क्लिक करें.
  2. कर्सर को उस सूचना पर रखें जिसे मिटाना है. इसके बाद, कार्रवाइयों वाले मेन्यू में जाकर पर क्लिक करें.

Apigee का सुझाव है कि सामान्य समस्याओं के बारे में सूचना पाने के लिए, ये सूचनाएं सेट अप करें. इनमें से कुछ सूचनाएं, आपके एपीआई को लागू करने से जुड़ी होती हैं. ये सूचनाएं सिर्फ़ कुछ स्थितियों में काम की होती हैं. उदाहरण के लिए, यहां दिखाई गई कई चेतावनियां सिर्फ़ तब लागू होती हैं, जब ServiceCallout नीति या JavaCallout नीति का इस्तेमाल किया जा रहा हो.

चेतावनी यूज़र इंटरफ़ेस (यूआई) का उदाहरण एपीआई का उदाहरण
सभी/किसी भी एपीआई के लिए 5xx स्टेटस कोड किसी एपीआई प्रॉक्सी के लिए, 5xx स्टेटस कोड की सूचना सेट अप करना एपीआई का इस्तेमाल करके, एपीआई प्रॉक्सी के लिए 5xx स्टेटस कोड की सूचना सेट अप करना
एपीआई प्रॉक्सी के लिए P95 लेटेंसी किसी एपीआई प्रॉक्सी के लिए, P95 लेटेंसी की सूचना सेट अप करना एपीआई का इस्तेमाल करके, किसी एपीआई प्रॉक्सी के लिए P95 लेटेंसी अलर्ट सेट अप करना
सभी एपीआई प्रॉक्सी के लिए 404 (ऐप्लिकेशन नहीं मिला) स्टेटस कोड सभी एपीआई प्रॉक्सी के लिए, 404 (ऐप्लिकेशन नहीं मिला) स्टेटस कोड की सूचना सेट अप करना एपीआई का इस्तेमाल करके, सभी एपीआई प्रॉक्सी के लिए 404 (ऐप्लिकेशन नहीं मिला) स्टेटस कोड की सूचना सेट अप करना
एपीआई के लिए एपीआई प्रॉक्सी की संख्या एपीआई के लिए, एपीआई प्रॉक्सी काउंट की सूचना सेट अप करना एपीआई का इस्तेमाल करके, एपीआई के लिए एपीआई प्रॉक्सी काउंट की सूचना सेट अप करना
टारगेट की गई सेवाओं के लिए गड़बड़ी की दरें टारगेट की गई सेवाओं के लिए, गड़बड़ी की दर से जुड़ी सूचना सेट अप करना एपीआई का इस्तेमाल करके, टारगेट की गई सेवाओं के लिए गड़बड़ी की दर से जुड़ी सूचना सेट अप करना
ServiceCallout नीतियों के लिए गड़बड़ी की दरें (अगर लागू हो) ServiceCallout नीति के लिए, गड़बड़ी की दर से जुड़ी सूचना सेट अप करना एपीआई का इस्तेमाल करके, ServiceCallout नीति के लिए गड़बड़ी की दर से जुड़ी सूचना सेट अप करना
खास गड़बड़ी के कोड, जिनमें ये शामिल हैं:
  • एपीआई प्रोटोकॉल से जुड़ी गड़बड़ियां (आम तौर पर 4xx)
    • यूज़र इंटरफ़ेस (यूआई): एपीआई प्रोटोकॉल > सभी
    • एपीआई:
      "faultCodeCategory":"API Protocol",
      "faultCodeSubCategory":"ALL"
  • एचटीटीपी से जुड़ी सभी गड़बड़ियां
    • यूज़र इंटरफ़ेस (यूआई): Gateway > Other > Gateway HTTPErrorResponseCode
    • एपीआई:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Others",
      "faultCodeName": "Gateway HTTPErrorResponseCode"
  • Java सेवा के कॉलआउट को एक्ज़ीक्यूट करने में गड़बड़ियां (अगर लागू हो)
    • यूज़र इंटरफ़ेस (यूआई): Execution Policy > Java Callout > JavaCallout ExecutionFailed
    • एपीआई:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Java Callout",
      "faultCodeName": "JavaCallout ExecutionFailed"
  • नोड स्क्रिप्ट को एक्ज़ीक्यूट करने से जुड़ी गड़बड़ियां (अगर लागू हो)
    • यूज़र इंटरफ़ेस (यूआई): Execution Policy > Node Script > NodeScript ExecutionError
    • एपीआई:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Node Script",
      "faultCodeName": "NodeScript ExecutionError"
  • कोटे के उल्लंघन
    • यूज़र इंटरफ़ेस (यूआई): ट्रैफ़िक मैनेजमेंट से जुड़ी नीति > कोटा > कोटा का उल्लंघन
    • एपीआई:
      "faultCodeCategory": "Traffic Mgmt Policy",
      "faultCodeSubCategory": "Quota",
      "faultCodeName": "Quota Violation"
  • सुरक्षा नीति से जुड़ी गड़बड़ियां
    • यूज़र इंटरफ़ेस (यूआई): सुरक्षा नीति > कोई भी
    • एपीआई:
      "faultCodeCategory": "Security Policy",
      "faultCodeName": "Any"
  • सेंस से जुड़ी गड़बड़ियां (अगर लागू हो)
    • यूज़र इंटरफ़ेस (यूआई): Sense > Sense > Sense RaiseFault
    • एपीआई:
      "faultCodeCategory": "Sense",
      "faultCodeSubCategory": "Sense",
      "faultCodeName": "Sense RaiseFault"
  • सेवा कॉलआउट को लागू करने में हुई गड़बड़ियां (अगर लागू हो)
    • यूज़र इंटरफ़ेस (यूआई): Execution Policy > Service Callout > ServiceCallout ExecutionFailed
    • एपीआई:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Service Callout",
      "faultCodeName": "ServiceCallout ExecutionFailed"
  • टारगेट से जुड़ी गड़बड़ियां
    • यूज़र इंटरफ़ेस (यूआई): Gateway > Target > Gateway TimeoutWithTargetOrCallout
    • एपीआई:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Target",
      "faultCodeName": "Gateway TimeoutWithTargetOrCallout"
  • टारगेट करने से जुड़ी गड़बड़ियां, कोई भी टारगेट चालू नहीं है
    • यूज़र इंटरफ़ेस (यूआई): गेटवे > टारगेट > Gateway TargetServerConfiguredInLoadBalancersIsDown
    • एपीआई:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Target",
      "faultCodeName": "Gateway TargetServerConfiguredInLoadBalancerIsDown
  • टारगेट में गड़बड़ियां, अचानक ईओएफ़
    • यूज़र इंटरफ़ेस (यूआई): Gateway > Target > Gateway UnexpectedEOFAtTarget
    • एपीआई:
      "faultCodeCategory": "Gateway", "faultCodeSubCategory": "Target", "faultCodeName" : "Gateway UnexpectedEOFAtTarget"
  • वर्चुअल होस्ट से जुड़ी गड़बड़ियां
    • यूज़र इंटरफ़ेस (यूआई): Gateway > Virtual Host > VirtualHost InvalidKeystoreOrTrustStore
    • एपीआई:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Virtual Host",
      "faultCodeName": "VirtualHost InvalidKeystoreOrTrustStore"
नीति के उल्लंघन से जुड़े फ़ॉल्ट कोड की सूचना पाने की सुविधा सेट अप करना एपीआई का इस्तेमाल करके, नीति के उल्लंघन से जुड़े फ़ॉल्ट कोड की सूचना पाने की सुविधा सेट अप करना

किसी एपीआई प्रॉक्सी के लिए, 5xx स्टेटस कोड की सूचना सेट अप करना

यहां यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके सूचना सेट अप करने का एक उदाहरण दिया गया है. यह सूचना तब ट्रिगर होती है, जब किसी भी इलाके के लिए, होटल के एपीआई प्रॉक्सी के 5xx स्टेटस कोड के लिए, लेन-देन प्रति सेकंड (टीपीएस) की संख्या 10 मिनट तक 100 से ज़्यादा हो जाती है. ज़्यादा जानकारी के लिए, सूचनाएं और चेतावनियां जोड़ना लेख पढ़ें.

एपीआई का इस्तेमाल करने के बारे में जानकारी के लिए, एपीआई का इस्तेमाल करके प्रॉक्सी के लिए 5xx स्टेटस कोड वाली सूचना सेट अप करना लेख पढ़ें.

किसी एपीआई प्रॉक्सी के लिए, P95 लेटेंसी की सूचना सेट अप करना

यहां एक उदाहरण दिया गया है. इसमें बताया गया है कि यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, सूचना कैसे सेट अप की जाती है. यह सूचना तब ट्रिगर होती है, जब किसी भी इलाके के लिए होटलों के एपीआई प्रॉक्सी के लिए, 95वें पर्सेंटाइल की कुल रिस्पॉन्स लेटेन्सी पांच मिनट तक 100 मि॰से॰ से ज़्यादा हो. ज़्यादा जानकारी के लिए, सूचनाएं और चेतावनियां जोड़ना लेख पढ़ें.

एपीआई इस्तेमाल करने के बारे में जानकारी पाने के लिए, एपीआई का इस्तेमाल करके, एपीआई प्रॉक्सी के लिए P95 लेटेंसी अलर्ट सेट अप करना लेख पढ़ें

सभी एपीआई प्रॉक्सी के लिए, 404 (ऐप्लिकेशन नहीं मिला) सूचना सेट अप करना

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

एपीआई इस्तेमाल करने के बारे में जानकारी पाने के लिए, एपीआई का इस्तेमाल करके, सभी एपीआई प्रॉक्सी के लिए 404 (ऐप्लिकेशन नहीं मिला) सूचना सेट अप करें लेख पढ़ें.

एपीआई के लिए, एपीआई प्रॉक्सी की संख्या से जुड़ी सूचना सेट अप करना

यहां यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके सूचना सेट अप करने का एक उदाहरण दिया गया है. यह सूचना तब ट्रिगर होती है, जब किसी भी क्षेत्र के लिए एपीआई के 5xx कोड की संख्या पांच मिनट में 200 से ज़्यादा हो जाती है. इस उदाहरण में, एपीआई को Critical API Proxies कलेक्शन में कैप्चर किया गया है. ज़्यादा जानकारी के लिए, देखें:

एपीआई इस्तेमाल करने के बारे में जानकारी पाने के लिए, एपीआई का इस्तेमाल करने वाले एपीआई के लिए, एपीआई प्रॉक्सी की संख्या से जुड़ी सूचना सेट अप करना लेख पढ़ें.

टारगेट की गई सेवाओं के लिए, गड़बड़ी की दर से जुड़ी सूचना सेट अप करना

यहां एक उदाहरण दिया गया है. इसमें बताया गया है कि यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, सूचना कैसे सेट अप की जाती है. यह सूचना तब ट्रिगर होती है, जब किसी भी क्षेत्र के लिए, टारगेट की गई सेवाओं के लिए 500 कोड रेट, एक घंटे के लिए 10% से ज़्यादा हो जाता है. इस उदाहरण में, टारगेट की गई सेवाओं को क्रिटिकल टारगेट कलेक्शन में कैप्चर किया गया है. ज़्यादा जानकारी के लिए, देखें:

एपीआई का इस्तेमाल करने के बारे में जानकारी पाने के लिए, एपीआई का इस्तेमाल करके टारगेट की गई सेवाओं के लिए गड़बड़ी की दर से जुड़ी सूचना सेट अप करना लेख पढ़ें.

ServiceCallout नीति के लिए, गड़बड़ी की दर से जुड़ी सूचना सेट अप करना

यहां एक उदाहरण दिया गया है. इसमें बताया गया है कि यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, सूचना कैसे सेट अप की जाती है. यह सूचना तब ट्रिगर होती है, जब किसी भी क्षेत्र के लिए, ServiceCallout नीति में बताई गई सेवा के लिए, 500 कोड रेट एक घंटे के लिए 10% से ज़्यादा हो जाता है. ज़्यादा जानकारी के लिए, देखें:

एपीआई का इस्तेमाल करने के बारे में जानकारी के लिए, एपीआई का इस्तेमाल करके, सेवा कॉलआउट नीति के लिए गड़बड़ी की दर से जुड़ी सूचना सेट अप करना लेख पढ़ें.

नीति के उल्लंघन से जुड़े फ़ॉल्ट कोड की सूचना पाने की सुविधा सेट अप करना

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

एपीआई इस्तेमाल करने के बारे में जानकारी पाने के लिए, एपीआई का इस्तेमाल करके, नीति के उल्लंघन के लिए फ़ॉल्ट कोड की सूचना पाने की सुविधा सेट अप करना लेख पढ़ें.