درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
این موضوع Edge API Analytics را معرفی می‌کند.
ویدیو: برای نمای کلی خدمات «تجزیه‌وتحلیل Edge API»، ویدیو کوتاهی را تماشا کنید.
بهبود دادن میانای برنامه‌سازی کاربردی ازطریق تجزیه‌وتحلیل
Edge API Analytics اطلاعات فراوانی را که ازطریق پراکسی‌های API جریان می‌یابد جمع‌آوری و محاسبه می‌کند. می‌توانید این داده‌ها را با نمودارها و جدول‌ها در «واسط کاربر Edge» به‌تصویر بکشید، یا می‌توانید داده‌های خام را برای تجزیه‌وتحلیل آفلاین بااستفاده از Edge management APIs بارگیری کنید.
Analytics به شما کمک می‌کند به سؤالات متداول پاسخ دهید، مثلاً:
- روند ترافیک API من درطول زمان چگونه است؟
- کدام روش‌های API محبوب‌ترین هستند؟
- توسعه‌دهندگان برتر من چه کسانی هستند؟
- زمان پاسخ API چه زمانی سریع‌تر است؟ آهسته‌ترین؟
- ازنظر جغرافیایی، بیشترین ترافیک API را کجا می‌بینم؟
پاسخ به سؤالاتی ازاین‌دست به شما کمک می‌کند تا «میاناهای برنامه‌سازی کاربردی» خود را بهبود دهید، مشکلات را عیب‌یابی کنید، و تصمیمات تجاری بهتری درارتباط با برنامه API خود بگیرید.
API Analytics به همه کمک می‌کند پیشرفت کنند
Edge API Analytics ازطریق فرایندی مداوم برای جمع‌آوری، تجزیه‌وتحلیل، و دیداری‌سازی داده‌ها به تیم API شما کمک می‌کند میاناهای برنامه‌سازی کاربردی خود را بهبود دهند و به توسعه‌دهندگان برنامه کمک می‌کند برنامه‌هایشان را بهبود دهند:
- تیم API - تیم API از سیستم‌های داخلی برای ایجاد APIهای جالب استفاده می‌کند. تیم API می‌خواهد بداند برنامه API به‌طور کلی چگونه پیش می‌رود، هر API به‌طور جداگانه چگونه عمل می‌کند، و چگونه می‌توان APIهای آن‌ها را بهبود بخشید.
- توسعه‌دهندگان نرم‌افزار - با هم‌رسانی اطلاعات Analytics با توسعه‌دهندگان نرم‌افزار، برنامه‌های بهتری دریافت می‌کنید. این توسعه‌دهندگان بااستفاده از API شما نوآوری می‌کنند و برنامه‌های خلاقانه‌ای می‌سازند که به افزایش درآمد شرکت شما کمک می‌کند. Analytics به توسعه‌دهندگان برنامه کمک می‌کند بدانند برنامه‌هایشان چگونه عمل می‌کنند و چقدر به سود خالص شرکت شما کمک می‌کنند. توسعه‌دهندگان نرم‌افزار می‌خواهند بدانند چگونه می‌توانند برنامه‌هایشان را بهبود دهند.
- تیم عملیات - تیم عملیات می‌خواهد الگوهای ترافیک را درک کند و پیش‌بینی کند که چه زمانی منابع زیرساخت را اضافه کند یا تنظیمات حیاتی دیگر را انجام دهد.
- مالک کسب‌وکار - مالک کسب‌وکار می‌خواهد ببیند سرمایه‌گذاری او در «میانای برنامه‌سازی کاربردی» چه سودی داشته است و در آینده باید در کجا برای «میانای برنامه‌سازی کاربردی» سرمایه‌گذاری کند.
چه نوع داده‌هایی جمع‌آوری و تجزیه‌وتحلیل می‌شود؟
Edge API Analytics طیف گسترده‌ای از داده‌هایی را که در سراسر پراکسی‌های API جریان دارد جمع‌آوری و تجزیه‌وتحلیل می‌کند، ازجمله:
- زمان پاسخ‌دهی
- تأخیر درخواست
- اندازه درخواست
- خطاهای هدف
- نام محصول میانای برنامه‌سازی کاربردی
- نشانی ایمیل توسعه‌دهنده
- نام برنامه
- بسیاری دیگر
برای فهرست کامل داده‌های جمع‌آوری‌شده توسط API Analytics، به مرجع سنجه‌ها، ابعاد، و فیلترهای Analytics مراجعه کنید.
چگونه داده‌های سفارشی Analytics را جمع‌آوری کنم؟
Edge به‌صورت بومی داده‌های زیادی را جمع‌آوری می‌کند. همچنین ممکن است بخواهید داده‌های تجزیه‌وتحلیل سفارشی خاص پراکسی‌های API، برنامه‌ها، محصولات، یا توسعه‌دهندگان خود را جمع‌آوری کنید. برای مثال، ممکن است بخواهید داده‌های تجزیه‌وتحلیل را از پارامترهای پُرسمان، سرایندهای درخواست، متن‌های درخواست و پاسخ، یا متغیرهایی که در میاناهای برنامه‌سازی کاربردی خود تعریف می‌کنید جمع‌آوری کنید.
بااستفاده از خط‌مشی StatisticsCollector، داده‌های تجزیه‌وتحلیل سفارشی را جمع‌آوری می‌کنید. پس‌از استخراج داده‌های سفارشی، می‌توانید از رابط کاربری یا API Analytics برای بررسی داده‌ها استفاده کنید. برای دیدن مثال کامل نحوه جمع‌آوری داده‌های تجزیه‌وتحلیل سفارشی، به تجزیه‌وتحلیل محتوای پیام API بااستفاده از تجزیه‌وتحلیل سفارشی مراجعه کنید.
تفاوت‌های بین داده‌های Analytics و داده‌های «پایش API»
این بخش برخی‌از تفاوت‌های جزئی بین داده‌های جمع‌آوری‌شده توسط Edge Analytics در مقایسه با «پایش میانای برنامه‌سازی کاربردی» را شرح می‌دهد. ازآنجایی‌که «پایش و تجزیه‌وتحلیل API» از خطوط لوله داده مختلفی استفاده می‌کنند، ممکن است تفاوت‌های جزئی بین گزارش‌های سفارشی تولیدشده توسط «پایش» و گزارش‌های تولیدشده توسط «تجزیه‌وتحلیل» مشاهده کنید. برای مثال، ممکن است در نتایج گزارش‌شده برای خطاهای مهلت زمانی تفاوت‌هایی ببینید—هم مهلت‌های زمانی زیرینه (کد وضعیت HTTP 504 در درخواست) و هم مهلت‌های زمانی مشتری (کد وضعیت HTTP 499). این موارد ممکن است با کد وضعیت ۲۰۰ در گزارش‌های سفارشی Analytics نشان داده شوند، اما با کد وضعیت ۵۰۴ یا ۴۹۹ در گزارش‌های سفارشی «پایش» نشان داده خواهند شد.داده‌های Analytics من چه زمانی و برای چه مدت دردسترس است؟
دو بازه زمانی وجود دارد که کنترل می‌کند چه زمانی و برای چه مدت می‌توانید داده‌های Analytics خود را مشاهده کنید:
- فاصله تأخیر داده - پس‌از تماس با یک پراکسی API، ممکن است تا ۱۰ دقیقه طول بکشد تا داده‌ها برای نمایش یا ازطریق تماس‌های API مدیریت دردسترس قرار گیرند.
- نگهداری داده‌ها -
مدت زمانی که داده‌های Analytics نگهداری می‌شود به طرح اشتراک شما بستگی دارد:
- استاندارد: ۳۰ روز
- سازمانی: ۳ ماه
- Enterprise Plus: ۱۴ ماه
چگونه به داده‌های Analytics خود دسترسی پیدا کنم؟
Edge API Analytics ابزارهای دیداری‌سازی داده را که در «میانای کاربری Edge» ساخته شده است ارائه می‌دهد. این ابزارها شامل داشبوردهای تجزیه‌وتحلیل ازپیش‌تعریف‌شده و گزارش‌های سفارشی است که داده‌ها را در نمودارها و جدول‌ها نمایش می‌دهد و به شما امکان می‌دهد با جزئیات بیشتر داده‌های گروه‌بندی‌شده در ابعاد مختلف (مانند پراکسی API، نشانی IP، یا کد وضعیت HTTP) را ببینید.
علاوه‌براین، می‌توانید بااستفاده از Edge management API داده‌های Analytics را بارگیری کنید. پس‌از بارگیری، می‌توانید آن داده‌ها را به ابزارهای مصورسازی داده یا سیستم تجزیه‌وتحلیل خود وارد کنید.
داشبوردهای Analytics
«واسط کاربر Edge» مجموعه‌ای از داشبوردهای ازپیش تعریف‌شده را ارائه می‌دهد که می‌توانید از آن‌ها برای مشاهده داده‌های Analytics استفاده کنید. برای مثال، تصویر زیر داشبورد عملکرد پراکسی را نشان می‌دهد:
این داشبورد شامل نمودارهایی برای موارد زیر است:
- کل ترافیک - تعداد کل درخواست‌های API که Edge برای محیط API در یک سازمان دریافت کرده است.
- موفقیت ترافیک - تعداد کل درخواست‌هایی که منجر به پاسخ موفق شده‌اند. پاسخ‌های خطا محاسبه نمی‌شوند.
- خطاهای ترافیک - تعداد کل درخواست‌های ناموفق API؛ یعنی درخواست پاسخ ارائه نمی‌دهد. این تعداد شامل هر دو نوع خطای «پراکسی» (طرف Apigee) و خطای «هدف» (سرویس‌های زیرینه) می‌شود.
- میانگین TPS - میانگین تعداد درخواست‌های API و پاسخ‌های حاصل در ثانیه.
داشبوردهای ازپیش‌تعریف‌شده اضافی شامل موارد زیر است:
- عملکرد حافظه نهان
- مشارکت توسعه‌دهنده
- استفاده از دستگاه
- تجزیه‌وتحلیل کد خطا
- GeoMap
- تجزیه‌وتحلیل تأخیر
- عملکرد هدف
- ترکیب ترافیک
برای کسب اطلاعات بیشتر درباره این داشبوردهای ازپیش تعریف‌شده، استفاده از داشبوردهای Analytics را ببینید.
گزارش‌های سفارشی
گزارش‌های سفارشی به شما امکان می‌دهند تا به جزئیات سنجه‌های خاص API بپردازید و داده‌های دقیقی را که می‌خواهید ببینید مشاهده کنید. می‌توانید بااستفاده از هریک از داده‌های Analytics که در Edge ساخته شده است یا داده‌های Analytics سفارشی که توسط خط‌مشی StatisticsCollector جمع‌آوری شده است، گزارش سفارشی ایجاد کنید.
هنگام ساختن گزارش سفارشی، داده‌هایی را که می‌خواهید ببینید (سنجه‌ها) انتخاب می‌کنید، داده‌ها را به روش‌های معنادار (ابعاد) گروه‌بندی می‌کنید، و درصورت تمایل، داده‌های برگشتی را براساس ویژگی‌های خاص داده‌ها محدود می‌کنید (فیلتر کردن).
همچنین می‌توانید نوع نمودار نمایش‌داده‌شده در گزارش سفارشی را به‌عنوان نمودار ستونی یا خطی تنظیم کنید. تصاویر زیر نمونه‌هایی از نمودار تراکنش در ثانیه را نشان می‌دهد که براساس پراکسی API گروه‌بندی شده است:
ستون - هر پراکسی API با ستون متفاوتی نشان داده می‌شود:
خط - هر پراکسی API با یک خط متفاوت نشان داده می‌شود:
برای اطلاعات بیشتر، ایجاد و مدیریت گزارش‌های سفارشی را ببینید.
تجزیه و تحلیل API
برای بارگیری داده‌های Analytics، از Edge management API استفاده کنید. برای مثال، می‌توانید از API برای ساختن ابزارهای تصویرسازی خودتان استفاده کنید و آن‌ها را در درگاه‌ها یا برنامه‌های سفارشی جاسازی کنید.
در اینجا یک فراخوانی API نمونه برای بازیابی داده‌های تجزیه‌وتحلیل برای پراکسی‌های API آورده شده است:
curl https://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \ -u email:password
این تماس برمی‌گرداند:
- مجموع درخواست‌ها (تعداد پیام) برای هر پراکسی API
- برای یک دوره ۲۴ ساعته
- گروه‌بندی براساس ساعت
پارامتر پُرسمان timeRange دوره زمانی را به‌این شکل مشخص می‌کند:
?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM
%20 را قبل‌از HH:MM متوجه شوید. پارامتر timeRange به
نویسه فاصله کدبندی‌شده با نشانی وب قبل‌از HH:MM، یا نویسه + نیاز دارد، مانند:
MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.
برای اطلاعات بیشتر، استفاده از میاناهای برنامه‌سازی کاربردی سنجه‌ها را برای اندازه‌گیری عملکرد برنامه میانای برنامه‌سازی کاربردی ببینید.
صادر کردن داده‌های Analytics به Google Cloud
می‌توانید از Edge management API برای صادر کردن همه داده‌های Analytics برای یک روز کامل از Edge به مخزن داده خودتان، مثل Google Cloud Storage یا BigQuery، استفاده کنید. سپس می‌توانید از قابلیت‌های قدرتمند پُرسمان و یادگیری ماشین ارائه‌شده توسط Google Cloud BigQuery و TensorFlow برای انجام تجزیه‌وتحلیل داده‌های خودتان استفاده کنید.
برای اطلاعات بیشتر، به صادر کردن داده‌ها از Analytics مراجعه کنید.
چگونه داده‌ها را با توسعه‌دهندگان نرم‌افزار هم‌رسانی کنم؟
وقتی توسعه‌دهندگان برنامه را به‌عنوان مشتریان خود درنظر می‌گیرید، می‌خواهید مطمئن شوید که آن‌ها ابزارها و اطلاعات لازم را برای استفاده بهینه از API شما دراختیار دارند.
توسعه‌دهندگان برنامه نه تنها نگران کیفیت برنامه‌های خود هستند، بلکه به APIهای شما نیز بسیار علاقه‌مندند. درگاه‌های توسعه‌دهنده مبتنی بر Drupal شامل صفحه اختیاری عملکرد برنامه است که برای ارائه دسترسی توسعه‌دهندگان برنامه به سنجه‌های مهم برنامه‌هایشان طراحی شده است. این صفحه اطلاعاتی درباره موارد زیر به توسعه‌دهندگان ارائه می‌دهد:
- خطاها: برنامه من با کدام خطاهای API مواجه است؟
- عملکرد: آیا «میانای برنامه‌سازی کاربردی» درحال‌حاضر کند است؟ کدام روش‌های میانای برنامه‌سازی کاربردی معمولاً کند هستند یا درحال‌حاضر کند هستند؟
- دردسترس بودن: آیا API درحال‌حاضر فعال است یا غیرفعال؟
- سهمیه: آیا API شما سهمیه دارد؟ و به‌عنوان توسعه‌دهنده نرم‌افزار، چگونه درمقایسه با سهمیه عمل می‌کنم؟
برای اطلاعات بیشتر، به اینجا مراجعه کنید:
- Drupal 7: نمایش تجزیه‌وتحلیل استفاده از برنامه
- Drupal 8: برنامه‌های پایش
- درگاه یکپارچه: دردسترس نیست
علاوه‌براین، می‌توانید تجزیه‌وتحلیل‌ها را با توسعه‌دهندگان خود هم‌رسانی کنید:
- ایجاد گزارش‌های سفارشی و هم‌رسانی آن‌ها با توسعه‌دهندگان برنامه. برای اطلاعات بیشتر، ایجاد گزارش‌های سفارشی را ببینید.
- استفاده از Edge management API برای دریافت داده‌ها در بازه زمانی طولانی‌تر برای هم‌رسانی با توسعه‌دهندگان برنامه به‌صورت آفلاین. برای کسب اطلاعات بیشتر، استفاده از میاناهای برنامه‌سازی کاربردی سنجه‌ها برای اندازه‌گیری عملکرد برنامه میانای برنامه‌سازی کاربردی را ببینید.
چگونه داده‌های کامل تجزیه‌وتحلیل تولید کنم؟
منظور ما از واکاوی کامل چیست؟ برای مثال، می‌توانید یک پراکسی API ایجاد کنید و Edge داده‌های تجزیه‌وتحلیل درباره آن پراکسی را جمع‌آوری خواهد کرد. اما درباره سنجه‌های توسعه‌دهنده یا برنامه‌ای که کارگزار API را فراخوانی کرده است چه؟ اگر Edge نداند چه کسی تماس API را برقرار کرده است، نمی‌تواند آن داده‌ها را جمع‌آوری کند.
برای اینکه Edge متوجه شود کدام توسعه‌دهندگان و کدام برنامه‌های توسعه‌دهنده پراکسی‌های API شما را فرا می‌خوانند، باید چند مرحله را انجام دهید. در اینجا فهرستی از این مراحل با پیوندهایی به اطلاعات دقیق‌تر ارائه شده است:
- یک یا چند محصول API ایجاد کنید، که گروهی از پراکسی‌های API به‌همراه طرح خدمات است. مدیریت محصولات میانای برنامه‌سازی کاربردی را ببینید.
- توسعه‌دهندگان نرم‌افزار را در Edge ثبت کنید. ثبت توسعه‌دهندگان نرم‌افزار را ببینید.
- ثبت برنامه‌ها و تولید کلیدهای API برای توسعه‌دهندگان. ثبت برنامه‌ها و مدیریت کلیدهای میانای برنامه‌سازی کاربردی را ببینید.
- خط‌مشی‌های امنیتی را به پراکسی‌های API خود اضافه کنید که کلیدهای API و/یا کدهای امنیتی را تأیید می‌کنند. موضوعات زیر را ببینید:خط‌مشی «تأیید کلید میانای برنامه‌سازی کاربردی»، خط‌مشی OAuthV2، و خط‌مشی «تأیید JWT».
- اگر از Edge Microgateway استفاده می‌کنید، مطمئن شوید که افزایه تجزیه‌وتحلیل را فعال کرده‌اید (که به‌طور پیش‌فرض فعال است). اگر افزایه تجزیه‌وتحلیل غیرفعال باشد، Edge Microgateway داده‌های تجزیه‌وتحلیل را به تجزیه‌وتحلیل Edge ارسال نخواهد کرد.
آموزش‌های گام‌به‌گام زیر شما را در مراحل لازم برای مشاهده تجزیه‌وتحلیل‌های توسعه‌دهندگان و برنامه‌ها راهنمایی می‌کند: ایمن کردن میانای برنامه‌سازی کاربردی با الزام به استفاده از کلیدهای میانای برنامه‌سازی کاربردی و ایمن کردن میانای برنامه‌سازی کاربردی با OAuth.
مقایسه Analytics API با «پایش API»
می‌توانید از هر دو پایش API و «تحلیل API» استفاده کنید. «پایش API» داده‌های Analytics را بررسی می‌کند تا اطلاعات آماری زمینه‌ای هم‌زمان درباره عملکرد API ارائه دهد و به شما امکان دهد مشکلات را به‌سرعت تشخیص دهید و اقدامات اصلاحی را برای تداوم کسب‌وکار تسهیل کنید. «پایش میانای برنامه‌سازی کاربردی» برای یافتن سریع نقاط مشکل در میاناهای برنامه‌سازی کاربردی و زیرینه‌های شما طراحی شده است. «تحلیل‌های API» برای ضبط طیف گسترده‌ای از داده‌های تحلیلی برای استفاده توسط چندین تیم مختلف طراحی شده است اما معمولاً از این داده‌ها برای تحلیل در سناریوهای غیرهم‌زمان استفاده می‌شود.
یکی از تفاوت‌های اصلی بین «پایش میانای برنامه‌سازی کاربردی» و «تحلیل میانای برنامه‌سازی کاربردی» سازوکار هشدار است که در «پایش میانای برنامه‌سازی کاربردی» تعبیه شده است. با هشدارها، کد وضعیت HTTP (2xx/4xx/5xx)، تأخیر، یا آستانه کد خطایی را مشخص می‌کنید که درصورت تجاوز از آن، اعلان هشداری برای «تیم عملیات» شما راه‌اندازی می‌شود. اعلان‌های هشدار را می‌توان ازطریق کانال‌های مختلفی مثل ایمیل، Slack، پیجر، یا وب‌قلاب ارسال کرد تا بتوانید بلافاصله به مشکلات پاسخ دهید.
برای مقایسه دقیق‌تر بین این سرویس‌ها، مقایسه پایش میانای برنامه‌سازی کاربردی با تجزیه‌وتحلیل میانای برنامه‌سازی کاربردی لبه را ببینید.