অসঙ্গতি শনাক্তকরণ API ব্যবহার করা

আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন দেখুন। তথ্য

অস্বাভাবিকতা সংক্রান্ত সতর্কতা তৈরি ও ম্যানেজ করতে এবং অস্বাভাবিকতা সংক্রান্ত মেট্রিক সংগ্রহ করতে আপনি যেসব API ব্যবহার করেন, সেগুলি ফিক্সড অ্যালার্টের ক্ষেত্রে ব্যবহার করা API-এর মতোই। স্থির ও অস্বাভাবিকতা সংক্রান্ত অ্যালার্ট, দু'টির ক্ষেত্রেই নিম্নলিখিত অ্যালার্ট API একই পদ্ধতিতে কাজ করে:

তবে, কিছু API-তে অতিরিক্ত প্রপার্টি আছে যা অস্বাভাবিকতা সংক্রান্ত অ্যালার্টের ক্ষেত্রে ব্যবহার করা হয়, এর মধ্যে রয়েছে:

$ACCESS_TOKEN সেট করা হচ্ছে

নিচে দেখানো সব API কল, $ACCESS_TOKEN নামের এনভায়রনমেন্ট ভেরিয়েবলে আপনার ক্রেডেনশিয়াল পাস করে। $ACCESS_TOKEN-কে আপনার OAuth 2.0 অ্যাক্সেস টোকেন হিসেবে সেট করুন, যেমনটি OAuth 2.0 অ্যাক্সেস টোকেন পান নিবন্ধে বর্ণনা করা হয়েছে। এইসব উদাহরণে ব্যবহৃত cURL বিকল্প সম্পর্কে তথ্য পেতে, cURL ব্যবহার করুন দেখুন।

সতর্কতা পান

ডিফল্ট হিসেবে, অ্যালার্ট পান API-এর মাধ্যমে আগে থেকে সেট করা সব অ্যালার্ট সম্পর্কে তথ্য পাওয়া যায়। এই API এখন কোয়েরি প্যারামিটার নেয় যাতে আপনি ফলাফল ফিল্টার করতে পারেন:

  • enabled - true-এ শুধুমাত্র চালু থাকা অ্যালার্ট ফেরত দেওয়ার কথা বলা থাকলে। ডিফল্ট ভ্যালু হল false।
  • alertType - ফেরত পাঠানোর জন্য সতর্কতার ধরন নির্দিষ্ট করে। অনুমোদিত মান হল runtime, ডিফল্ট, cert.
  • alertSubType - ফেরত পাঠানোর জন্য সতর্কতার সাবটাইপ নির্দিষ্ট করে। ডিফল্ট ভ্যালু হল আনসেট, অর্থাৎ অ্যালার্টের সব সাবটাইপ রিটার্ন করে। অস্বাভাবিকতা সংক্রান্ত অ্যালার্ট পেতে anomaly উল্লেখ করুন।

যেমন, myorgনামের সংস্থার জন্য শুধু চালু করা অ্যালার্টের তথ্য পেতে, নিম্নলিখিত API কল ব্যবহার করুন:

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'

অসঙ্গতি সংক্রান্ত অ্যালার্ট তৈরি বা আপডেট করা

আপনি বর্তমানে ফিক্সড অ্যালার্টের জন্য যেভাবে করেন, ঠিক সেইভাবে একই API ব্যবহার করে কোনও অসঙ্গতি সংক্রান্ত অ্যালার্ট তৈরি বা আপডেট করুন। অস্বাভাবিকতা সংক্রান্ত সতর্কতা তৈরি বা আপডেট করার জন্য API কলের বডি, নিম্নলিখিত পরিবর্তন সহ, ফিক্সড সতর্কতার জন্য ব্যবহৃত বডির মতোই:

  • এই বিজ্ঞপ্তি যে একটি অস্বাভাবিকতা সংক্রান্ত বিজ্ঞপ্তি তা নির্দিষ্ট করতে আপনাকে নিম্নলিখিত নতুন প্রপার্টি যোগ করতে হবে:

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

    এইসব প্রপার্টির ডিফল্ট ভ্যালু হল:

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

  • conditions অ্যারেতে:

    • metrics প্রপার্টি শুধুমাত্র এই ভ্যালুগুলি নেয়:

      • count - HTTP সংক্রান্ত সমস্যার সংখ্যা সম্পর্কে সতর্কতা জারি করুন।
      • totalLatency - লেটেন্সি সম্পর্কে অ্যালার্ট পাঠান।
    • threshold প্রপার্টিতে নম্বরের পরিবর্তে স্ট্রিং ব্যবহার করা হয়। যেসব ভ্যালু কাজ করে তার মধ্যে রয়েছে: slight, moderate ও severe।
    • durationSeconds ও comparator প্রপার্টি কাজ করে না।

  • conditions অ্যারের dimensions এলিমেন্টে:

    • proxy প্রপার্টির ভ্যালু ALL হিসেবে সেট করতে হবে।
    • statusCode প্রপার্টি শুধুমাত্র 4xx, 503, 504, and 5xx ভ্যালু সাপোর্ট করে।
    • developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName প্রপার্টি কাজ করে না।
  • অস্বাভাবিকতা সংক্রান্ত সতর্কতার ক্ষেত্রে reportEnabled প্রপার্টি কাজ করে না।

নিম্নলিখিত উদাহরণ API কল একটি অসঙ্গতি সংক্রান্ত সতর্কতা তৈরি করে যা কোনও অঞ্চলের প্রোডাকশন এনভায়রনমেন্টে সমস্ত API প্রক্সির জন্য মাঝারি হারে 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
    }'

অ্যানোমালি সহ ইভেন্ট API ব্যবহার করা

নির্দিষ্ট সময়সীমার মধ্যে কোনও সংস্থার সমস্ত ইভেন্ট পেতে /metrics/events API ব্যবহার করুন। ইভেন্টের তালিকায় এগুলি অন্তর্ভুক্ত থাকে: Edge-এর শনাক্ত করা অসঙ্গতি এবং কোনও ট্রিগার করা অ্যালার্ট। সতর্কতার মধ্যে ফিক্সড ও অ্যানোমালি সতর্কতা, দু'টিই অন্তর্ভুক্ত থাকতে পারে।

ডিফল্ট হিসেবে, API আগের ঘণ্টার সব ইভেন্ট রিটার্ন করে। আলাদা সময়সীমা নির্দিষ্ট করতে from এবং to কোয়েরি প্যারামিটার ব্যবহার করুন। আলাদা সময়সীমা নির্দিষ্ট করতে from এবং to কোয়েরি প্যারামিটারের ভ্যালু।

যেমন, নিম্নলিখিত API কলটি myorg পূর্ববর্তী ১২ ঘণ্টার জন্য সংস্থার সমস্ত ইভেন্ট রিটার্ন করে:

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 ব্যবহার করুন দেখুন।

পরের কলে গত ২৪ ঘণ্টার জন্য মাঝারি থ্রেশহোল্ড সহ সবকটি অস্বাভাবিক ইভেন্ট রিটার্ন করা হয়: 

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

এই API-এর জন্য শুধুমাত্র org কোয়েরি প্যারামিটার প্রয়োজন। /metrics/events-এ API ডকুমেন্টে বর্ণিত কোয়েরি প্যারামিটারের সাথে সাথে, এই API নিম্নলিখিত বিকল্পগুলিকেও সমর্থন করে যাতে অস্বাভাবিকতা শনাক্তকরণ কাজ করে:

নাম বিবরণ ডিফল্ট
threshold

নির্দিষ্ট থ্রেশহোল্ড অনুযায়ী ইভেন্ট ফিল্টার করুন: slight, moderate অথবা severe।

আপনি type=anomaly সেট করলেই শুধু অনুমতি দেওয়া হয়।

সব সিভিয়ারিটি
type নির্দিষ্ট ধরন অনুযায়ী ইভেন্ট ফিল্টার করুন: alert বা anomaly. কমা দিয়ে আলাদা করা তালিকা হিসেবে একাধিক ভ্যালু নির্দিষ্ট করুন। সব ধরন