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

आपको 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
    }'

अनियमितताओं के साथ इवेंट एपीआई का इस्तेमाल करना

/metrics/events का इस्तेमाल करना एपीआई का इस्तेमाल, किसी तय समयावधि में किसी संगठन के सभी इवेंट की जानकारी पाने के लिए किया जाता है. इवेंट की सूची में ये शामिल हैं 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. एक से ज़्यादा वैल्यू को, कॉमा लगाकर अलग की गई सूची के तौर पर डालें. सभी प्रकार