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

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

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

ویدیوها

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

ویدیو	شرح
ایجاد گزارش‌های سفارشی بااستفاده از میانای کاربری	با نحوه ایجاد گزارش‌های سفارشی بااستفاده از «واسط کاربر Edge» آشنا شوید.
نمای کلی گزارش‌های سفارشی	نمای کلی استفاده از گزارش‌های سفارشی را ببینید.
ردیابی تأخیر API	ببینید چگونه بااستفاده از گزارش‌های سفارشی، تأخیر API را پیگیری کنید.
پیگیری پاسخ‌های خطای «میانای برنامه‌سازی کاربردی»	پاسخ‌های خطای API را بااستفاده از گزارش‌های سفارشی پیگیری کنید.

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

هنگام ساختن گزارش سفارشی، داده‌هایی را که می‌خواهید ببینید (سنجه‌ها) انتخاب می‌کنید، داده‌ها را به روش‌های معنادار گروه‌بندی می‌کنید (ابعاد)، و به‌صورت اختیاری داده‌های برگشتی را براساس ویژگی‌های خاص داده‌ها محدود می‌کنید (فیلترها).

همچنین می‌توانید نوع نمودار نمایش‌داده‌شده در گزارش سفارشی را به‌عنوان نمودار ستونی یا خطی تنظیم کنید. تصاویر زیر نمونه‌هایی از نمودار برای سنجه تراکنش‌ها در ثانیه را نشان می‌دهد که براساس بُعد پراکسی API گروه‌بندی شده است:

• ستون - هر پراکسی API با ستون متفاوتی نشان داده می‌شود:

  

• خط - هر API با یک خط متفاوت نشان داده می‌شود:

  

تنظیم سنجه‌ها و ابعاد

سنجه‌هایی که برای گزارش سفارشی خود انتخاب می‌کنید، داده‌هایی را که می‌خواهید اندازه‌گیری کنید مشخص می‌کنند. سنجه‌های رایج شامل موارد زیر می‌شود:

• تراکنش در ثانیه
• زمان پاسخ‌دهی
• خطاهای خط‌مشی

برخی‌از سنجه‌ها به شما اجازه می‌دهند تابع تجمیعی را برای اجرا دربرابر سنجه تنظیم کنید. برای مثال، می‌توانید از توابع تجمیع زیر با سنجه زمان پاسخ استفاده کنید:

• ‫avg: میانگین زمان پاسخ‌دهی را برمی‌گرداند.
• ‫min: حداقل زمان پاسخ را برمی‌گرداند.
• ‫max: حداکثر زمان پاسخ را برمی‌گرداند.
• ‫sum: مجموع زمان پاسخ را برمی‌گرداند.

همه سنجه‌ها از همه توابع تجمیع پشتیبانی نمی‌کنند. مستندات مربوط به سنجه‌ها حاوی جدولی است که نام سنجه و تابع (sum، avg، min، max) پشتیبانی‌شده توسط سنجه را مشخص می‌کند.

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

• زمان پاسخ برای هر محصول API
• زمان پاسخ‌دهی برای هر پراکسی میانای برنامه‌سازی کاربردی
• زمان پاسخ به‌ازای هر ایمیل توسعه‌دهنده

نحوه نمایش بُعد در نمودار گزارش سفارشی به نوع نمودار بستگی دارد:

• ستون: هر ستون با مقدار متفاوتی از بُعد مطابقت دارد.
• خط: هر خط در نمودار با مقدار متفاوتی از بُعد مطابقت دارد، و محور x نشان‌دهنده زمان است.

ساختن سنجه‌ها و ابعاد سفارشی

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

نحوه نمایش داده‌های تجزیه‌وتحلیل سفارشی در گزارش سفارشی به نوع داده آن بستگی دارد:

• برای داده‌های نوع رشته، داده‌های آماری را به‌عنوان بُعد در گزارش سفارشی ارجاع دهید.
• برای انواع داده‌های عددی (عدد صحیح/شناور/طولانی/دوبرابر)، داده‌های آماری را در گزارش سفارشی به‌عنوان بُعد یا سنجه ارجاع دهید.

برای نمونه‌هایی از جمع‌آوری داده‌های تجزیه‌وتحلیل سفارشی، خط‌مشی StatisticsCollector را ببینید.

درحال تنظیم فیلترها

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

فیلترها از نحو شرطی استفاده می‌کنند که به شما امکان می‌دهد بااستفاده از عملگرهایی مثل eq،‏ ne،‏ gt،‏ lt، و غیره فیلترهای پیچیده بسازید.

نمونه‌های گزارش سفارشی

در ساده‌ترین نوع گزارش سفارشی، یک سنجه و یک بُعد را مشخص می‌کنید. برای مثال، گزارش سفارشی را با تنظیمات زیر تعریف می‌کنید:

• نوع = ستون
• واحد = میانگین تراکنش در ثانیه
• ابعاد = کارگزار میانای برنامه‌سازی کاربردی

گزارش سفارشی حاوی نمودار ستونی با داده‌های سنجه «میانگین تراکنش‌ها در ثانیه» است که براساس بُعد پراکسی API گروه‌بندی شده است:

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

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

• نوع = ستون
• واحد = میانگین تراکنش در ثانیه
• سنجه = خطاهای خط‌مشی
• ابعاد = کارگزار میانای برنامه‌سازی کاربردی

گزارش سفارشی شامل نموداری جداگانه برای هر سنجه است:

می‌توانید چندین بُعد به گزارش سفارشی اضافه کنید. برای مثال، گزارش سفارشی را با تنظیمات زیر تعریف می‌کنید که شامل دو سنجه و دو بُعد است:

• نوع = ستون
• واحد = میانگین تراکنش در ثانیه
• سنجه = خطاهای خط‌مشی
• ابعاد = کارگزار میانای برنامه‌سازی کاربردی
• ابعاد = فعل درخواست

نمودار در ابتدا سنجه‌های گروه‌بندی‌شده براساس «پراکسی» را نشان می‌دهد، اولین بُعدی که هنگام ایجاد گزارش سفارشی مشخص کردید:

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

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

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

به صفحه گزارش‌های سفارشی، همان‌طور که در زیر توضیح داده شده است، دسترسی پیدا کنید.

صفحه گزارش‌های سفارشی همه گزارش‌های سفارشی را که برای سازمان شما ایجاد شده است نمایش می‌دهد، همان‌طور که در شکل زیر نشان داده شده است:

همان‌طور که در شکل نشان داده شده است، صفحه گزارش‌های سفارشی به شما امکان می‌دهد:

• فهرست همه گزارش‌های سفارشی را مشاهده کنید.
• گزارش سفارشی اضافه کنید.
• با کلیک کردن روی نام گزارش در فهرست، گزارش سفارشی اجرا کنید. گزارش بااستفاده از داده‌هایی که به‌طور پیش‌فرض در ساعت گذشته جمع‌آوری شده است اجرا می‌شود و داده‌ها در داشبورد گزارش سفارشی نمایش داده می‌شود. کاوش داشبورد گزارش‌های سفارشی را ببینید.
• با وارد کردن کل یا بخشی از رشته مربوطه در چارگوش جستجو، فهرست گزارش‌های سفارشی را جستجو کنید؛ همه فیلدهای نمایش‌داده‌شده برای رشته جستجو می‌شوند.
• حذف گزارش سفارشی.

کاوش داشبورد گزارش سفارشی

داشبورد گزارش سفارشی نتایج گزارش سفارشی شما را برای یک محدوده زمانی خاص نشان می‌دهد، ازجمله نمودار ستونی یا خطی سنجه مشخص‌شده:

داشبورد گزارش سفارشی به شما امکان می‌دهد:

• مشاهده داده‌های گزارش سفارشی برای محدوده زمانی انتخاب‌شده.
• محیط موردنظرتان را برای مشاهده داده‌های گزارش سفارشی انتخاب کنید.
• برای فیلتر کردن داده‌های گزارش سفارشی، بُعد خاصی را انتخاب کنید. این ناحیه فقط زمانی فعال می‌شود که چند بُعد را برای گزارش مشخص کنید.

• نمای نمودار یا جدول را انتخاب کنید.

• با انتخاب نماد در ردیف جدول سنجه مربوطه، سنجه‌ای را تجزیه‌وتحلیل کنید. ناهنجاری‌ها را مشاهده کنید و آن را با دوره قبلی یا با سنجه‌های دیگر مقایسه کنید.
• با کلیک کردن و تنظیم کردن محدوده زمانی، گزارش سفارشی را اجرا کنید.
• گزارش سفارشی را در قالب فایل CSV بارگیری کنید. نام فایل به‌صورت زیر است: metric.csv. برای مثال: Average_of_total_response_time.csv.
• گزارش سفارشی را ویرایش کنید.

کاوش داشبورد تجزیه‌وتحلیل سنجه

اگر نماد را در ردیف جدول خلاصه انتخاب کنید، نمودارهای زیر ظاهر می‌شود (نمودار بالا فقط درصورتی ظاهر می‌شود که گزارش را برای استفاده از چندین معیار پیکربندی کرده باشید):

این نمودارها اطلاعات زیر را نمایش می‌دهند:

• مقایسه با: اگر گزارش را برای استفاده از چندین سنجه پیکربندی کرده‌اید، سنجه‌ها را با یکدیگر مقایسه کنید.
• مقایسه با دوره قبلی: سنجه را برای دوره زمانی قبلی مشاهده کنید. برای مثال، اگر انتخاب کرده باشید که گزارش سفارشی را برای ۲۴ ساعت گذشته ببینید، این نمودار داده‌های مربوط به دوره ۲۴ ساعت قبلی را نشان می‌دهد.

• تجزیه‌وتحلیل ناهنجاری‌ها: هر نقطه داده‌ای را که در داده‌های گزارش وجود دارد نمایش می‌دهد. این نمودار دو مقدار را نمایش می‌دهد:

  • میانگین متحرک سنجه به‌صورت خط نمایش داده می‌شود. برای یک نقطه معین روی خط، مقدار میانگین متحرک به‌عنوان میانگین مقدار سنجه در آن نقطه زمانی و مقادیر سنجه برای دو نقطه داده قبلی محاسبه می‌شود.
  • ناحیه آبی نمودار مقادیر میانگین حداکثر و میانگین حداقل سنجه را تعریف می‌کند. حداکثر میانگین ۱٫۲ * (میانگین متحرک) و حداقل میانگین ۰٫۸ * (میانگین متحرک) است.

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

درحال افزودن گزارش سفارشی

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

پس‌از افزودن گزارش سفارشی، باید آن را به‌صورت هم‌زمان یا غیرهم‌زمان اجرا کنید.

برای افزودن گزارش سفارشی:

1. به صفحه «گزارش‌های سفارشی» دسترسی پیدا کنید.
2. روی + گزارش سفارشی کلیک کنید.
3. در بخش «پایه»، اطلاعات زیر را وارد کنید:

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

4. در بخش «سنجه‌ها»:
   1. روی نماد برای سنجه‌ها کلیک کنید.
   2. سنجه موردنظرتان را برای تجزیه‌وتحلیل انتخاب کنید.
   3. تابع تجمیعی را برای نمایش مقادیر «مجموع»، «میانگین»، «کمینه»، یا «بیشینه» انتخاب کنید.
   4. روی ذخیره کلیک کنید.
   5. برای افزودن سنجه‌های بیشتر، روی نماد کلیک کنید.
5. در بخش ابعاد، روی کلیک کنید و بعدی، مثل «پراکسی»، را انتخاب کنید تا مجموعه داده‌های مورد استفاده برای تولید گزارش‌ها را محدود کنید. می‌توانید ابعاد دیگری اضافه کنید تا داده‌ها را بیشتر محدود کنید.

6. در بخش فیلترها، با افزودن فیلترها به تعریف گزارش، داده‌های نمایش‌داده‌شده را بیشتر محدود کنید. برای مثال، می‌توانید فیلتری اضافه کنید که داده‌های مربوط به پراکسی API آب‌وهوا یا توسعه‌دهنده jane@example.com را مستثنا کند.

   1. روی کلیک کنید و «نام» نهادی را که می‌خواهید براساس آن فیلتر کنید، «عملگری» مثل = یا !=، و «مقدار» را انتخاب کنید.
   2. برای ذخیره کردن فیلتر، روی افزودن کلیک کنید.
   3. برای افزودن فیلترهای بیشتر، روی کلیک کنید و اتصال‌دهنده «و» یا «یا» را انتخاب کنید.

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

   1. برای ویرایش تنظیمات نقش سفارشی، روی کلیک کنید.
   2. نقش سفارشی موردنیاز برای دسترسی به گزارش و سطح دسترسی (مشاهده، ویرایش، حذف) را انتخاب کنید.
   3. روی افزودن کلیک کنید.
   4. برای ویرایش نقش‌های اضافی، روی کلیک کنید.
8. برای ذخیره کردن گزارش، روی ذخیره کلیک کنید.

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

«تحلیل لبه‌ای» به شما امکان می‌دهد گزارش را به‌صورت هم‌زمان یا ناهم‌زمان اجرا کنید.

• برای گزارش هم‌زمان، درخواست گزارش را اجرا می‌کنید و درخواست تا زمانی‌که سرور تجزیه‌وتحلیل پاسخ دهد مسدود می‌شود. بااین‌حال، ازآنجایی‌که گزارش ممکن است نیاز به پردازش مقدار زیادی داده داشته باشد (برای مثال، صدها گیگابایت)، گزارش هم‌زمان ممکن است به‌دلیل اتمام زمان با خطا مواجه شود.

  گزارش هم‌زمان می‌تواند حداکثر محدوده زمانی ۱۴ روزه داشته باشد. اگر محدوده زمانی ۱۵ روز یا بیشتر را انتخاب کنید، گزارش همیشه به‌صورت ناهمزمان اجرا می‌شود.

• برای گزارش ناهمزمان، درخواست گزارش را اجرا می‌کنید و نتایج را در زمان دیگری بازیابی می‌کنید. برخی‌از موقعیت‌هایی که پردازش پُرسمان ناهم‌زمان می‌تواند جایگزین خوبی باشد عبارت‌اند از:

  • تجزیه‌وتحلیل و ایجاد گزارش‌هایی که بازه‌های زمانی طولانی را دربرمی‌گیرند.
  • تجزیه‌وتحلیل داده‌ها با ابعاد گروه‌بندی متنوع و محدودیت‌های دیگری که به پیچیدگی پُرسمان می‌افزاید
  • مدیریت کردن پُرسمان‌ها وقتی متوجه می‌شوید حجم داده برای برخی‌از کاربران یا سازمان‌ها به‌طور قابل‌توجهی افزایش یافته است.

  این سند نحوه شروع گزارش ناهم‌زمان بااستفاده از «واسط کاربر» را شرح می‌دهد. همچنین می‌توانید از «میانای برنامه‌سازی کاربردی» استفاده کنید، همان‌طور که در استفاده از میانای برنامه‌سازی کاربردی گزارش‌های سفارشی ناهم‌زمان توضیح داده شده است.

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

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

3. برای اجرای گزارش برای محدوده زمانی دیگر:

   1. در محدوده زمانی در بالای گزارش کلیک کنید تا بالاپَر انتخاب زمان گزارش سفارشی باز شود.
   2. یکی از موارد زیر را انتخاب کنید:
      • محدوده زمانی ازپیش تعریف‌شده، مثل ساعت گذشته، دیروز، یا ۷ روز گذشته.

      • محدوده سفارشی با انتخاب تاریخ و زمان از/تا یا استفاده از تقویم برای انتخاب تاریخ‌های شروع و پایان. برای استفاده از «ساعت هماهنگ جهانی» (UTC)، روی UTC کلیک کنید.

   3. برای اجرای گزارش، یکی از موارد زیر را انتخاب کنید:

      • برای اجرای هم‌زمان گزارش، روی اعمال کردن کلیک کنید. نتایج پس‌از تکمیل گزارش در داشبورد گزارش سفارشی نمایش داده خواهد شد. اگر اجرای گزارش بیشتر از ۶۰ ثانیه طول بکشد، به‌طور خودکار به گزارش ناهم‌زمان تبدیل خواهد شد.

      • برای اجرای گزارش ناهمزمان به‌عنوان کار پس‌زمینه‌ای، ارسال کار را انتخاب کنید. کادر گفتگوی زیر ظاهر می‌شود:

        

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

مشاهده کردن کارهای گزارش سفارشی ناهمزمان

برای مشاهده کارهای گزارش سفارشی غیرهم‌زمان، یکی از موارد زیر را انتخاب کنید:

• در کادر گفتگوی «گزارش به‌عنوان کار پس‌زمینه‌ای ارسال شد»، روی مشاهده وضعیت کلیک کنید.
• از نوار پیمایش سمت راست، تجزیه‌وتحلیل > گزارش‌های سفارشی > گزارش مشاغل را انتخاب کنید.

صفحه «گزارش کارها» نمایش داده می‌شود، همان‌طور که در شکل زیر نشان داده شده است:

صفحه «گزارش کارها» به شما امکان می‌دهد:

• مشاهده همه نتایج کار گزارش سفارشی غیرهم‌زمان که در ۷ روز گذشته ارسال شده است.

• محیطی را که می‌خواهید کارهای گزارش سفارشی برای آن نمایش داده شود انتخاب کنید.

• برای مشاهده گزارش سفارشی، مطمئن شوید که وضعیت آن تکمیل شده باشد. سپس موشواره را روی ردیف مربوط به گزارش حرکت دهید. نماد و نشان داده می‌شود. برای مشاهده گزارش، را انتخاب کنید.

• با کلیک کردن روی ، گزارش سفارشی را بارگیری کنید.

  گزارش کامل به‌عنوان فایل ZIP با نام OfflineQueryResult-xxx.zip بارگیری می‌شود که حاوی فایل‌های CSV است.

• با وارد کردن کل یا بخشی از رشته مربوطه در چارگوش جستجو، فهرست گزارش‌های سفارشی را جستجو کنید؛ همه فیلدهای نمایش‌داده‌شده برای رشته جستجو می‌شوند.

درحال ویرایش گزارش سفارشی

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

1. به صفحه «گزارش‌های سفارشی» دسترسی پیدا کنید.
2. موشواره را روی نام گزارشی که می‌خواهید ویرایش کنید حرکت دهید. نمادهای ویرایش و حذف در سمت چپ صفحه ظاهر می‌شوند.
3. روی نماد ویرایش کلیک کنید.
4. جزئیات گزارش سفارشی را ویرایش کنید.
5. روی ذخیره کلیک کنید.

به نتایج گزارش سفارشی برگردانده می‌شوید.

حذف گزارش سفارشی

برای حذف گزارش سفارشی:

1. به صفحه «گزارش‌های سفارشی» دسترسی پیدا کنید.
2. موشواره را روی نام گزارشی که می‌خواهید ویرایش کنید حرکت دهید. نمادهای ویرایش و حذف در سمت چپ صفحه ظاهر می‌شوند.
3. برای حذف گزارش، روی نماد حذف کلیک کنید.