गड़बड़ी की पहचान करने वाले एपीआई का इस्तेमाल करना

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

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

हालांकि, कुछ एपीआई में ऐसी अतिरिक्त प्रॉपर्टी होती हैं जिनका इस्तेमाल गड़बड़ी की चेतावनियों के लिए किया जाता है, जैसे:

  • सूचनाएं पाएं - सभी चेतावनियों की सूची बनाएं, जिनमें ठीक की गई और अनियमितता से जुड़ी चेतावनियां शामिल हैं.
  • सूचना बनाएं - गड़बड़ी की समस्या वाली या गड़बड़ी की समस्या वाली चेतावनी बनाएं.
  • सूचना अपडेट करें - गड़बड़ी की ठीक की गई या गड़बड़ी की सूचना की परिभाषा को अपडेट करें.

$ACCESS_TOKEN सेट करना

नीचे दिखाए गए सभी एपीआई कॉल, आपके क्रेडेंशियल को $ACCESS_TOKEN नाम के एनवायरमेंट वैरिएबल में पास करते हैं. $ACCESS_TOKEN को अपने OAuth 2.0 ऐक्सेस टोकन पर सेट करें, जैसा कि OAuth 2.0 ऐक्सेस टोकन पाना में बताया गया है. इन उदाहरणों में इस्तेमाल किए गए cURL विकल्पों के बारे में जानकारी के लिए, cURL का इस्तेमाल करें देखें.

अलर्ट पाएं

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

  • enabled - अगर true सिर्फ़ चालू की गई चेतावनियां दिखाता है. डिफ़ॉल्ट वैल्यू false है.
  • alertType - बताता है कि किस तरह की चेतावनी दिखाई जानी है. इसकी वैल्यू runtime, डिफ़ॉल्ट, cert हो सकती हैं.
  • alertSubType - यह जवाब के लिए सूचना के सब-टाइप को तय करता है. डिफ़ॉल्ट वैल्यू सेट नहीं है. इसका मतलब है कि सूचना के सभी सब-टाइप दिखेंगे. गड़बड़ी की सूचनाएं दिखाने के लिए, anomaly तय करें.

उदाहरण के लिए, नीचे दिए गए एपीआई कॉल का इस्तेमाल करके, सिर्फ़ myorg नाम वाले संगठन के लिए चेतावनियां चालू करें:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

नीचे दिए गए कॉल से सिर्फ़ अनियमितता की सूचनाएं मिलती हैं. ये चालू और बंद, दोनों तरह की सूचनाएं होती हैं:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=anomaly'

अनियमितता के बारे में सूचना बनाना या अपडेट करना

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

  • यह बताने के लिए कि सूचना एक गड़बड़ी की चेतावनी है, आपको नीचे दी गई नई प्रॉपर्टी जोड़नी होंगी:

    "alertType": "runtime"
"alertSubType": "anomaly"

    इन प्रॉपर्टी की डिफ़ॉल्ट वैल्यू ये हैं:

    "alertType": "runtime"
"alertSubType": "fixed"

  • conditions कलेक्शन में:

    • metrics प्रॉपर्टी के लिए सिर्फ़ ये वैल्यू इस्तेमाल की जा सकती हैं:

      • count - एचटीटीपी गड़बड़ी की संख्या के बारे में सूचना पाएं.
      • totalLatency - इंतज़ार के समय के लिए सूचना दिखाएं.
    • threshold प्रॉपर्टी के लिए संख्या के बजाय, स्ट्रिंग का इस्तेमाल किया जाता है. इस्तेमाल की जा सकने वाली वैल्यू में ये शामिल हैं: slight, moderate, और severe.
    • durationSeconds और comparator प्रॉपर्टी का इस्तेमाल नहीं किया जा सकता.

  • conditions कलेक्शन के dimensions एलिमेंट में:

    • आपको proxy प्रॉपर्टी की वैल्यू ALL पर सेट करनी होगी.
    • statusCode प्रॉपर्टी में सिर्फ़ 4xx, 503, 504, and 5xx की वैल्यू इस्तेमाल की जा सकती है.
    • developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName प्रॉपर्टी का इस्तेमाल नहीं किया जा सकता.
  • गड़बड़ी की चेतावनियों के लिए, reportEnabled प्रॉपर्टी का इस्तेमाल नहीं किया जा सकता.

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

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
 -X POST \
 -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -d '{
     "organization":"myorg",
     "name":"5xx Anomaly Alert",
     "description":"My 5xx alert",
     "environment":"prod",
     "enabled":true,
     "alertType": "runtime",
     "alertSubType": "anomaly",
     "conditions":[
     {
        "description":"",
        "dimensions":{
            "org":"myorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ANY",
            "statusCode":"5xx"
        },
        "metric":"count",
        "threshold": "moderate"
     }
     ],
     "notifications":[{
         "channel":"email",
         "destination":"ops@acme.com"
     }],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600
    }'

अनियमितताओं के साथ event API का इस्तेमाल करना

किसी संगठन में तय समयावधि में सभी इवेंट देखने के लिए, /metrics/events API का इस्तेमाल करें. इवेंट की सूची में, EDGE में पहचानी गई अनियमितताएं और ट्रिगर की गई चेतावनियां शामिल हैं. इन सूचनाओं में ठीक की गई और अनियमितता से जुड़ी, दोनों तरह की सूचनाएं शामिल हो सकती हैं.

डिफ़ॉल्ट रूप से, एपीआई पिछले घंटे के सभी इवेंट दिखाता है. कोई अलग अवधि तय करने के लिए, from और to क्वेरी पैरामीटर का इस्तेमाल करें. कोई अलग अवधि बताने के लिए, from और to क्वेरी पैरामीटर की वैल्यू.

उदाहरण के लिए, नीचे दिया गया एपीआई कॉल, संगठन myorg में पिछले 12 घंटों के सभी इवेंट की जानकारी दिखाता है:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
"https://apimonitoring.enterprise.apigee.com/metrics/events?org=myorg&from=-12h&to=now"

$ACCESS_TOKEN को अपने OAuth 2.0 ऐक्सेस टोकन पर सेट करें, जैसा कि OAuth 2.0 ऐक्सेस टोकन पाना में बताया गया है. इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानकारी के लिए, cURL का इस्तेमाल करें देखें.

अगली कॉल में, पिछले 24 घंटों के दौरान गड़बड़ी के ऐसे सभी इवेंट दिखते हैं जिनका थ्रेशोल्ड सामान्य से ज़्यादा है: 

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
"https://apimonitoring.enterprise.apigee.com/metrics/events?org=myorg&type=anomaly&threshold=moderate&from=-24h&to=now"

इस एपीआई के लिए, सिर्फ़ org क्वेरी पैरामीटर की ज़रूरत है. /metrics/events पर एपीआई दस्तावेज़ में बताए गए क्वेरी पैरामीटर के साथ-साथ, यह एपीआई गड़बड़ी की पहचान करने के लिए इन विकल्पों के साथ काम करता है:

नाम ब्यौरा डिफ़ॉल्ट
threshold

तय थ्रेशोल्ड से इवेंट फ़िल्टर करें: slight, moderate या severe.

सिर्फ़ तब अनुमति दी जाती है, जब आपने type=anomaly सेट किया हो.

सभी प्लैटफ़ॉर्म पर होने वाले क्रैश इवेंट की जानकारी
type इवेंट को बताए गए टाइप के हिसाब से फ़िल्टर करें: alert या anomaly. एक से ज़्यादा वैल्यू को कॉमा लगाकर अलग की गई सूची के तौर पर बताएं. सभी प्रकार