استفاده از «میانای برنامه‌سازی کاربردی تشخیص ناهنجاری»

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید.
اطلاعات

بیشتر میاناهای برنامه‌سازی کاربردی که برای ایجاد و مدیریت هشدارهای ناهنجاری و جمع‌آوری سنجه‌های ناهنجاری استفاده می‌کنید، همان‌هایی هستند که برای هشدارهای ثابت استفاده می‌کنید. ‫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 را مشخص کنید.

برای مثال، از فراخوانی API زیر استفاده کنید تا فقط هشدارهای فعال‌شده برای سازمان با نام 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'

ایجاد یا به‌روزرسانی هشدار ناهنجاری

از همان APIها برای ایجاد یا به‌روزرسانی هشدار ناهنجاری استفاده کنید، همان‌طور که درحال‌حاضر برای هشدار ثابت انجام می‌دهید. بدنه فراخوانی API برای ایجاد یا به‌روزرسانی هشدار ناهنجاری همانند هشدار ثابت است، با این تفاوت‌ها:

  • برای مشخص کردن اینکه هشدار، هشدار ناهنجاری است، باید دارایی‌های جدید زیر را اضافه کنید:

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

    مقادیر پیش‌فرض این دارایی‌ها عبارت‌اند از:

    "alertType": "runtime"
    "alertSubType": "fixed"
  • در آرایه conditions:

    • خصوصیت metrics فقط مقادیر زیر را می‌پذیرد:

      • count - هشدار برای تعداد خطاهای HTTP ایجاد کنید.
      • ‫totalLatency - برای تأخیر، هشدار ایجاد کنید.
    • دارایی threshold به‌جای عدد، رشته می‌گیرد. مقادیر پشتیبانی‌شده شامل: slight، moderate، و severe می‌شود.
    • از دارایی‌های durationSeconds و comparator پشتیبانی نمی‌شود.
  • در عنصر dimensions آرایه conditions:

    • باید مقدار خصوصیت proxy را روی ALL تنظیم کنید.
    • دارایی statusCode فقط از مقدار 4xx, 503, 504, and 5xx پشتیبانی می‌کند.
    • ویژگی‌های developerApp،‏ collection،‏ faultCodeCategory، faultCodeSubCategory،‏ faultCodeName پشتیبانی نمی‌شود.
  • دارایی reportEnabled برای هشدارهای ناهنجاری پشتیبانی نمی‌شود.

فراخوانی میانای برنامه‌سازی کاربردی مثال زیر هشدار ناهنجاری‌ای ایجاد می‌کند که وقتی کدهای وضعیت ۵xx با نرخ متوسط برای همه پراکسی‌های میانای برنامه‌سازی کاربردی در محیط تولید برای هر منطقه‌ای رخ می‌دهد راه‌اندازی می‌شود. وقتی هشدار راه‌اندازی می‌شود، اعلانی به نشانی ایمیل مشخص‌شده ارسال می‌شود:

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"

فقط پارامتر پُرسمان org برای این «میانای برنامه‌سازی کاربردی» الزامی است. همراه با پارامترهای پُرسمان توضیح‌داده‌شده در سند API در /metrics/events، این API از گزینه‌های زیر برای پشتیبانی از تشخیص ناهنجاری پشتیبانی می‌کند:

نام شرح پیش‌فرض
threshold

رویدادها را براساس آستانه مشخص‌شده فیلتر کنید: slight،‏ moderate، یا severe.

فقط وقتی type=anomaly را تنظیم کنید مجاز است.

همه شدت‌ها
type رویدادها را براساس نوع مشخص‌شده فیلتر کنید: alert یا anomaly. چند مقدار را به‌صورت فهرست جداشده با کاما مشخص کنید. همه انواع