ایجاد گزارش‌های سفارشی

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

گزارش‌های سفارشی به شما امکان می‌دهند تا به جزئیات سنجه‌های API خاصی دسترسی پیدا کنید و داده‌های دقیقی را که می‌خواهید ببینید. از داشبوردهای «پایش API»، می‌توانید گزارش سفارشی با فیلتر و سنجه‌های پیش‌تنظیم‌شده براساس شرایط پیکربندی‌شده در زمان ایجاد بسازید. علاوه‌براین، مجموعه‌ای از ابعاد و سنجه‌های پیش‌فرض در گزارش برای شما پیکربندی شده است.

ایجاد گزارش سفارشی براساس بافت شما

براساس زمینه‌تان که در جدول زیر خلاصه شده است، به‌سرعت گزارش‌های سفارشی ایجاد کنید. در صفحه گزارش‌های سفارشی، گزارش‌های سفارشی که بااستفاده از «پایش API» ایجاد شده‌اند (به‌طور پیش‌فرض) نام‌های منحصربه‌فردی دارند، همان‌طور که در جدول نشان داده شده است؛ هنگام ویرایش گزارش سفارشی می‌توانید نام آن را تغییر دهید.

ابعاد و سنجه‌های پیش‌فرض

گزارش سفارشی به‌طور پیش‌فرض شامل ابعاد و سنجه‌های فهرست‌شده در جدول زیر برای همه گزارش‌های تولیدشده «پایش API» خواهد بود.

ویرایش گزارش سفارشی

همان‌طور که در بخش قبلی ذکر شد، مجموعه ازپیش‌تعریف‌شده‌ای از ابعاد و سنجه‌های پیش‌فرض «پایش API» در گزارش‌های سفارشی ازپیش پیکربندی شده است. پس‌از ایجاد شدن، می‌توانید گزارش سفارشی را ویرایش کنید تا سنجه‌ها و ابعاد را درصورت نیاز اضافه یا حذف کنید. برای مثال، ممکن است بخواهید تحقیقات خود را به یک کد دسترسی خاص، برنامه توسعه‌دهنده، پراکسی API، یا شناسه درخواست محدود کنید.

در گزارش سفارشی زیر، بُعد ازپیش تعریف‌شده Gateway Flow ID را اضافه می‌کنید، که در آن Gateway Flow ID حاوی UUID یکتای هر درخواست API ارسالی به Edge است. توجه داشته باشید که گزارش ازقبل از بُعد Request URI استفاده می‌کند:

مثال زیر بُعد Client ID را به گزارش سفارشی اضافه می‌کند. ابعاد Client ID حاوی کلید مصرف‌کننده (کلید میانای برنامه‌سازی کاربردی) توسعه‌دهنده‌ای است که فراخوانی میانای برنامه‌سازی کاربردی را انجام می‌دهد، چه در درخواست به‌عنوان کلید میانای برنامه‌سازی کاربردی ارسال شده باشد یا در کد OAuth گنجانده شده باشد:

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

برای کسب اطلاعات بیشتر درباره همه ابعاد و سنجه‌های ازپیش تعریف‌شده‌ای که می‌توانید به گزارش اضافه کنید، به مرجع سنجه‌ها، ابعاد، و فیلترهای Analytics مراجعه کنید.

در مثال بعدی، «فیلتری» به گزارش سفارشی اضافه می‌کنید که سنجه‌ها و ابعاد پیش‌فرض را برای policies.ratelimit.QuotaViolation کد خطا و کدهای وضعیت 5xx ضبط می‌کند:

برای جزئیات کامل درباره نحوه ویرایش گزارش سفارشی، به مدیریت گزارش‌های سفارشی مراجعه کنید.

مثال: استفاده از گزارش‌های سفارشی برای تشخیص مشکلات استقرار

خط‌مشی StatisticsCollector را به پراکسی‌های API خود پیوست کنید تا داده‌های تجزیه‌وتحلیل سفارشی، مثل شناسه کاربر یا محصول، قیمت، کنش REST، نسخه هدف، نشانی وب هدف، و طول پیام را جمع‌آوری کنید. داده‌ها می‌توانند از متغیرهای جاری‌سازی پیش‌تعریف‌شده توسط Apigee، سرایندهای درخواست، پارامترهای پُرسمان، یا متغیرهای سفارشی که تعریف می‌کنید، گرفته شوند.

برای مثال، درخواست‌های پراکسی API شما شامل سرایندهایی برای شناسه محصول، شناسه کاربر، و نسخه سرور هدف است. این درخواست می‌تواند به این شکل‌ها باشد:

curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi

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

برای ایجاد گزارش سفارشی برای این سرصفحه‌ها:

1. خط‌مشی StatisticsCollector را به «میانای برنامه‌سازی کاربردی» خود اضافه کنید تا مقدار سرایندهای سفارشی را ضبط کنید:

   <StatisticsCollector name="publishPurchaseDetails">
     <Statistics>
       <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic>
       <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic>
       <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic>
     </Statistics>
   </StatisticsCollector>

2. کارگزار نیابتی‌تان را مستقر کنید و زمان لازم برای دسترسی به آن را درنظر بگیرید.

3. برای مشاهده هرگونه مشکل در API خود، در «واسط کاربر Edge» روی تجزیه‌وتحلیل > پایش API > اخیر کلیک کنید. توجه کنید که برای پراکسی myapi خطاهای 4xx و 5xx دریافت می‌کنید:

   

4. ردیف پراکسی myapi را انتخاب کنید تا جزئیات بیشتری را در قاب سمت چپ داشبورد «اخیر» مشاهده کنید.

5. در قاب سمت چپ داشبورد «اخیر»، > مشاهده در «تحقیق» را انتخاب کنید تا به داشبورد «تحقیق» دسترسی پیدا کنید:

   

6. داشبورد «تحقیق» را براساس پراکسی myapi فیلتر کنید و سپس کد وضعیت را در نمودار بالا مشاهده کنید. متوجه می‌شوید که خطاهای ۴۰۳ و ۵۰۱ دریافت می‌کنید:

   

7. در «میانای کاربری Edge»، Analytics > گزارش‌های سفارشی > گزارش‌ها را انتخاب کنید تا گزارش سفارشی‌ای بسازید که مقادیر این سنجه‌های سفارشی را به‌عنوان «ابعاد» دربرگیرد.

8. برای ایجاد گزارش سفارشی با نام myapi_errors، گزینه + گزارش سفارشی را انتخاب کنید.

9. خطاهای پراکسی را برای «سنجه» انتخاب کنید و تابع تجمیعی را روی مجموع تنظیم کنید. درصورت تمایل می‌توانید سنجه‌های بیشتری اضافه کنید.

10. «ابعاد» کد وضعیت پاسخ ازپیش تعریف‌شده را انتخاب کنید، سپس سه آمار سفارشی prodid، targetersion، و userid را به «ابعاد» اضافه کنید:

    

11. «فیلتر» را تنظیم کنید تا فقط داده‌های مربوط به پراکسی API myapi را دربر بگیرد (apiproxy eq 'myapi'):

    

12. گزارش را ذخیره کنید.

13. گزارش را برای ۲۴ ساعت گذشته اجرا کنید. وقتی گزارش برای اولین‌بار باز می‌شود، نموداری از خطاهای HTTP 403 و 501 را می‌بینید:

    

14. در بخش خلاصه، روی ۴۰۳ یا ۵۱۰ کلیک کنید تا ببینید کدام محصول خطاها را تولید می‌کند. برای مثال، ۴۰۳ را انتخاب می‌کنید:

    

15. برای دیدن خطاها براساس نسخه هدف (آلفا یا بتا)، روی شناسه محصول در بخش خلاصه کلیک کنید:

    

16. برای دیدن خطاها براساس کاربر، روی نسخه هدف در بخش خلاصه کلیک کنید: