هشدارهای ترافیکی را تنظیم کنید

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

هنگامی که ترافیک یک محیط، پراکسی یا منطقه با درصد مشخصی در یک بازه زمانی تغییر می کند، از یک هشدار ترافیک برای افزایش اعلان استفاده کنید.

شما محدوده زمانی را بر روی:

• 1 ساعت
• 1 روز
• 7 روز
• 15 روز (فقط API)
• 30 روز (فقط API)

این هشدار با مقایسه ترافیک محدوده زمانی فعلی با ترافیک محدوده زمانی قبلی کار می کند. به عنوان مثال، شما یک محدوده زمانی یک ساعته را مشخص می کنید. سپس هشدار، ترافیک یک ساعت اخیر را با ترافیک ساعت قبل مقایسه می کند تا درصد تغییر ترافیک را محاسبه کند:

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

مقدار مثبت به معنای افزایش ترافیک و مقدار منفی به معنای کاهش ترافیک است.

سپس آستانه‌ای را که هشدار ترافیک را راه‌اندازی می‌کند به‌عنوان درصد افزایش یا کاهش ترافیک API برای بازه زمانی مشخص تعیین می‌کنید.

قبل از اینکه آن درصد را تنظیم کنید، مطمئن شوید که با الگوهای ترافیکی عادی شما مطابقت دارد. به عنوان مثال، اگر ترافیک API شما معمولاً در طول روز با افزایش ترافیک ساعتی تا 100٪ در زمان‌های اوج خاص نوسان دارد، این افزایش‌ها طبیعی هستند و نباید هشداری را ایجاد کنند. با این حال، اگر پس از آن یک هشدار را به گونه‌ای پیکربندی کنید که باعث افزایش 50 درصدی ترافیک ساعتی شود، هشدارهای غیرضروری برای ترافیک عادی خود دریافت خواهید کرد.

برای اطلاعات بیشتر درباره هشدارها، به تنظیم هشدارها و اعلان‌ها مراجعه کنید.

هشدارها و اعلان های ترافیکی را اضافه کنید

برای افزودن هشدارها و اعلان‌های ترافیکی:

1. روی Analyze > Alert Rules در Edge UI کلیک کنید.
2. روی +Alert کلیک کنید.
3. اطلاعات کلی زیر را در مورد هشدار وارد کنید:

   میدان	توضیحات
   نام هشدار	نام هشدار از نامی استفاده کنید که محرک را توصیف کند و برای شما معنادار باشد. نام نمی تواند بیش از 128 کاراکتر باشد.
   توضیحات	شرح هشدار
   نوع هشدار	کل ترافیک را انتخاب کنید. برای اطلاعات بیشتر درباره انواع هشدارها را ببینید.
   محیط زیست	محیط را از لیست کشویی انتخاب کنید.
   وضعیت	برای فعال یا غیرفعال کردن هشدار، آن را تغییر دهید.

4. آستانه و بعد را برای شرایطی که هشدار را راه‌اندازی می‌کند، تعریف کنید.

   فیلد وضعیت	توضیحات
   آستانه	زمانی که ترافیک در مقایسه با بازه زمانی قبلی به میزان مشخصی افزایش یا کاهش یافته است، هشدار را مشخص کنید. درصد افزایش یافته را روی مقداری بزرگتر یا مساوی 0 درصد تنظیم کنید. مجموعه با درصد به مقداری بزرگتر یا مساوی 0% و کمتر یا مساوی 100% کاهش یافت . شما می توانید فاصله زمانی را انتخاب کنید: 1 ساعت 1 روز 1 هفته
   بعد	روی +Add Dimension کلیک کنید و جزئیات ابعادی را مشخص کنید که نتایج شامل پراکسی API و منطقه برای آنها بازگردانده شود. یک بعد خاص را به صورت زیر تنظیم کنید: پروکسی - روی یک پراکسی خاص یا روی همه پراکسی ها تنظیم کنید. پروکسی از مقدار "Any" پشتیبانی نمی کند. در عوض می توانید برای هر پروکسی که به آن علاقه دارید یک هشدار جداگانه اضافه کنید. منطقه - روی یک منطقه خاص یا روی همه مناطق تنظیم کنید. منطقه از مقدار "Any" پشتیبانی نمی کند. در عوض می توانید برای هر منطقه ای که به آن علاقه دارید یک هشدار جداگانه اضافه کنید.

5. برای افزودن یک اعلان هشدار، روی + Notification کلیک کنید.

   جزئیات اعلان	توضیحات
   کانال	کانال اطلاع رسانی را که می خواهید استفاده کنید انتخاب کنید و مقصد را مشخص کنید: Email، Slack، PagerDuty یا Webhook.
   مقصد	مقصد را بر اساس نوع کانال انتخابی مشخص کنید: ایمیل - آدرس ایمیل، مانند joe@company.com Slack - URL کانال شل، مانند https://hooks.slack.com/services/T00000000/B00000000/XXXXX PagerDuty - کد PagerDuty، مانند abcd1234efgh56789 Webhook - URL Webhook، مانند https://apigee.com/test-webhook توجه : در هر اعلان می توانید فقط یک مقصد را مشخص کنید. برای تعیین چندین مقصد برای یک نوع کانال، اعلان‌های اضافی اضافه کنید.

6. برای افزودن اعلان های اضافی، مرحله قبل را تکرار کنید.
7. اگر اعلانی اضافه کردید، فیلدهای زیر را تنظیم کنید:

   میدان	توضیحات
   کتاب بازی	(اختیاری) فیلد متنی فرم آزاد برای ارائه شرح کوتاهی از اقدامات توصیه شده برای حل هشدارها هنگام شلیک. همچنین می‌توانید پیوندی به ویکی داخلی یا صفحه انجمن خود که در آن به بهترین شیوه‌ها اشاره می‌کنید، مشخص کنید. اطلاعات این قسمت در اطلاعیه درج خواهد شد. محتوای این فیلد نمی تواند بیش از 1500 کاراکتر باشد.
   دریچه گاز	فرکانس ارسال اعلان ها یک مقدار را از لیست کشویی انتخاب کنید.

8. روی ذخیره کلیک کنید.

هشدارها را در داشبورد رویدادها مشاهده کنید

وقتی Edge یک وضعیت هشدار را تشخیص می‌دهد، به طور خودکار آن شرایط را در داشبورد رویدادها در رابط کاربری Edge ثبت می‌کند. لیست رویدادهای نمایش داده شده در داشبورد رویدادها شامل همه هشدارها، اعم از ثابت و گواهی است.

برای مشاهده یک هشدار:

1. روی Analyze > Events در Edge UI کلیک کنید. داشبورد رویدادهای جدید ظاهر می شود:

2. داشبورد رویدادها را بر اساس:

   • محیط زیست
   • منطقه
   • دوره زمانی
3. برای بررسی بیشتر هشدار، ردیفی را در داشبورد رویداد انتخاب کنید تا فروشگاه کلید حاوی گواهی منقضی شده را نشان دهد. از صفحه Keystore، می توانید یک گواهی جدید آپلود کنید و گواهی منقضی شده را حذف کنید.

از API های هشدار با هشدارهای ترافیکی استفاده کنید

بیشتر APIهایی که برای ایجاد و مدیریت هشدارهای ترافیک استفاده می‌کنید، همان APIهایی هستند که با سایر انواع هشدار استفاده می‌کنید:

• دریافت هشدار - یک تعریف هشدار ثابت یا غیرعادی دریافت کنید.
• دریافت سابقه هشدار - معیارهای سابقه هشدار را دریافت کنید.
• حذف یک هشدار - یک تعریف هشدار ثابت یا غیرعادی را حذف کنید.
• دریافت نمونه هشدار - اطلاعاتی درباره یک هشدار راه اندازی شده دریافت کنید.
• دریافت تعداد هشدار - تعداد کل هشدارها را دریافت کنید.

با این حال، برخی از API ها دارای ویژگی های اضافی هستند که برای پشتیبانی از هشدارهای ناهنجاری استفاده می شود، از جمله:

• دریافت هشدار - لیست همه هشدارها، از جمله هشدارهای ثابت و غیرعادی.
• ایجاد هشدار - یک هشدار ثابت یا غیرعادی ایجاد کنید.
• به روز رسانی یک هشدار - یک تعریف هشدار ثابت یا غیرعادی را به روز کنید.

ایجاد یا به روز رسانی هشدار ترافیک

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

• ویژگی های جدید زیر را اضافه کنید تا مشخص کنید که هشدار یک هشدار ترافیک است:

  "alertType": "runtime"
  "alertSubType": "trafficfixed"

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

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

• در عنصر dimensions آرایه conditions :
  • شما باید مقادیر org ، env ، proxy و region را تنظیم کنید. فقط آن ویژگی ها پشتیبانی می شوند. می توانید proxy و region را روی ALL تنظیم کنید.
  • شما باید مقدار ویژگی traffic را روی total تنظیم کنید.

• در آرایه conditions :

  • ویژگی metrics باید دارای مقدار trafficChange باشد.
  • ویژگی comparator باید روی increasedBy یا decreasedBy تنظیم شود.
  • ویژگی threshold حاوی یک مقدار مثبت است که درصد افزایش یا کاهش ترافیک را مشخص می کند که در آن مقدار 1.0 با 100% مطابقت دارد. مقدار increasedBy توسط مقدار باید بزرگتر یا مساوی 0.0 (0%) باشد. مقدار decreasedBy توسط مقدار باید بزرگتر یا مساوی 0.0 (0%) و کمتر یا مساوی 1.0 (100%) باشد.
  • ویژگی durationSeconds باید روی یکی از مقادیر زیر تنظیم شود: 3600 (1 ساعت)، 86400 (1 روز)، 604800 (7 روز)، 1296000 (15 روز)، 2592000 (30 روز).
• ویژگی reportEnabled برای هشدارهای ترافیکی پشتیبانی نمی شود.

مثال زیر نحوه تنظیم هشداری را نشان می دهد که وقتی ترافیک یک سازمان و محیط در یک بازه زمانی یک ساعته 50 درصد افزایش می یابد، فعال می شود. هنگامی که هشدار فعال می شود، یک اعلان به کد PagerDuty مشخص شده ارسال می شود.

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":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید. برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.

برای اطلاعات بیشتر در مورد استفاده از این API به مشاهده رویدادها مراجعه کنید.

دریافت هشدارهای ترافیکی

به طور پیش فرض، Get Alerts API اطلاعات مربوط به همه هشدارهای تعریف شده را برمی گرداند. این API اکنون پارامترهای پرس و جو را می گیرد تا به شما امکان می دهد نتایج را فیلتر کنید:

• enabled - اگر true مشخص می کند که فقط هشدارهای فعال را برگرداند. مقدار پیش فرض false است.
• alertType - نوع هشدار برای بازگشت را مشخص می کند. مقادیر مجاز عبارتند از runtime ، پیش‌فرض و cert .
• alertSubType - نوع فرعی هشدار را برای بازگشت مشخص می کند. مقدار پیش‌فرض تنظیم نشده است، به این معنی که همه زیرگروه‌های هشدار را برمی‌گرداند.

به عنوان مثال، از فراخوانی 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=trafficfixed'

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید. برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.