درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
این موضوع مرجعی برای سنجهها، ابعاد، و فیلترهای تجزیهوتحلیل است. برای زمینه بیشتر درباره استفاده از این موارد، نمای کلی «واکاوش API» را ببینید.
این موضوع نامهای سنجهها و ابعاد را همانگونه که در رابط کاربری ظاهر میشوند و همانگونه که باید در فراخوانیهای API از آنها استفاده کنید نشان میدهد.
- هنگام ایجاد گزارشهای سفارشی، نامهای واسط کاربر را خواهید دید.
- هنگام دریافت سنجهها، ایجاد تعریف گزارش، یا بهروزرسانی تعریف گزارش، از نامهای مختص API استفاده کنید.
سنجهها
در زیر سنجههای API که میتوانید در گزارشهای سفارشی و فراخوانیهای API مدیریت بازیابی کنید آمده است.
| نام گزارشهای سفارشی | نامی که در «میانای برنامهسازی کاربردی مدیریت» استفاده میشود | توابع | شرح |
|---|---|---|---|
| میانگین تراکنش در ثانیه | tps | خالی |
تعداد میانگین تراکنشها، یعنی درخواستهای پراکسی میانای برنامهسازی کاربردی، در ثانیه. توجه داشته باشید که اگر تعداد تراکنشهای شما در طول دوره زمانی نسبتاً کم باشد، اگر تعداد تراکنشها کمتر از دو رقم اعشاری باشد، ممکن است تعداد متوسط تراکنشها در ثانیه در گزارشهای سفارشی واسط کاربر صفر نشان داده شود. نحو میانای برنامهسازی کاربردی: |
| ضربه حافظه نهان | cache_hit | مجموع |
تعداد درخواستهای موفق API که بهجای پاسخ سرویس هدف از «حافظه نهان پاسخ» استفاده میکنند. نحو میانای برنامهسازی کاربردی: |
| تعداد عناصر حافظه نهان L1 | ax_cache_l1_count | میانگین، حداقل، حداکثر |
تعداد عناصر در حافظه نهان L1 (در حافظه) را برای هر تراکنش در یک دوره زمانی معین برمیگرداند. برای مثال، اگر نحو میانای برنامهسازی کاربردی: |
| خطاهای خطمشی | policy_error | مجموع |
تعداد کل خطاهای خطمشی در دوره زمانی مشخصشده. خطاهای خطمشی معمولاً بهدلیل طراحی رخ میدهند. برای مثال، خطمشی «کلید میانای برنامهسازی کاربردی را درستیسنجی کنید» وقتی کلید میانای برنامهسازی کاربردی نامعتبری در درخواست ارسال میشود خطا میدهد، و خطمشی «مهار جهش» اگر تعداد تماسهای میانای برنامهسازی کاربردی از حد تعریفشده در خطمشی فراتر رود خطا میدهد. بنابراین این سنجه برای یافتن نقاط مشکل احتمالی در میاناهای برنامهسازی کاربردی شما مفید است. برای مثال، سنجههای policy_error، گروهبندیشده براساس بُعد developer_app، ممکن است به شما کمک کند متوجه شوید کلید API یا کد OAuth برای برنامه معینی منقضی شده است؛ یا ممکن است متوجه شوید کارگزار API خاصی خطاهای Spike Arrest زیادی ایجاد میکند، که باعث میشود متوجه شوید حد Spike Arrest کارگزار افزایش ترافیک تعطیلات را درنظر نگرفته است. خطای خطمشی فقط درصورتی در Analytics ثبت میشود که خطا منجر به خرابی پراکسی API شود.
برای مثال، اگر مشخصه ابعاد «نام خطمشی در خطا» (ax_execution_fault_policy_name) برای گروهبندی خطاهای خطمشی براساس نام خطمشی مفید است. خطای مقصد (مانند ۴۰۴ یا ۵۰۳) بهعنوان خطای خطمشی محسوب نمیشود. این موارد بهعنوان خطاهای کارگزار واسط برنامهنویسی کاربردی (is_error) محسوب میشوند. نحو میانای برنامهسازی کاربردی: |
| خطاهای پراکسی | is_error | مجموع |
تعداد کل دفعاتی که کارگزاران نیابتی API در دوره زمانی مشخصشده ناموفق بودهاند. خطای کارگزار زمانی رخ میدهد که خطمشی ناموفق باشد یا خطای زمان اجرا وجود داشته باشد، مثلاً خطای ۴۰۴ یا ۵۰۳ از سرویس هدف. ابعاد «پراکسی» (apiproxy) برای گروهبندی خطاهای پراکسی API براساس پراکسی مفید است. نحو میانای برنامهسازی کاربردی: |
| تأخیر در پردازش درخواست | request_processing_latency | میانگین، حداقل، حداکثر |
مقدار زمان (میانگین، حداقل، یا حداکثر)، در میلیثانیه، که Edge برای پردازش درخواستهای ورودی صرف میکند. زمان از وقتی شروع میشود که درخواست به Edge میرسد و وقتی پایان مییابد که Edge درخواست را به سرویس هدف بازارسال میکند. بااستفاده از ابعاد مختلف، میتوانید تأخیرهای پردازش درخواست را براساس پراکسی API، برنامه توسعهدهنده، منطقه، و غیره بررسی کنید. نحو میانای برنامهسازی کاربردی: |
| اندازه درخواست | request_size | مجموع، میانگین، حداقل، حداکثر |
اندازه پایهبار درخواست دریافتی توسط Edge، برحسب بایت. نحو میانای برنامهسازی کاربردی: |
| «پاسخ حافظه نهان» اجرا شد | ax_cache_executed | مجموع |
تعداد کل دفعاتی که خطمشی «پاسخ نهانگاه» در دوره زمانی معین اجرا شده است. ازآنجاییکه خطمشی «حافظه نهان پاسخ» در دو مکان در یک پراکسی API پیوست شده است (یکبار در درخواست و یکبار در پاسخ)، معمولاً دو بار در یک تماس API اجرا میشود. یک حافظه نهان «دریافت» و یک حافظه نهان «قرار دادن» هرکدام بهعنوان یک اجرا شمارش میشوند. بااینحال، اگر عنصر
در ابزار ردیابی،
میتوانید روی نماد «پاسخ نهان» در یک تماس API اجراشده کلیک کنید و
نحو میانای برنامهسازی کاربردی: |
| تأخیر پردازش پاسخ | response_processing_latency | میانگین، حداقل، حداکثر |
مقدار زمان (میانگین، حداقل، یا حداکثر)، در میلیثانیه، که Edge برای پردازش پاسخهای API صرف میکند. زمان از وقتی شروع میشود که کارگزار API پاسخ سرویس مقصد را دریافت میکند و وقتی پایان مییابد که Apigee پاسخ را به تماسگیرنده اصلی بازارسال میکند. بااستفاده از ابعاد مختلف، میتوانید تأخیرهای پردازش پاسخ را براساس کارگزار API، منطقه، و غیره بررسی کنید. نحو میانای برنامهسازی کاربردی: |
| اندازه پاسخ | response_size | مجموع، میانگین، حداقل، حداکثر |
اندازه پایهبار پاسخ برگشتی به کارخواه، برحسب بایت. نحو میانای برنامهسازی کاربردی: |
| خطاهای هدف | target_error | مجموع |
تعداد کل پاسخهای ۵xx از سرویس هدف. اینها خطاهای سرویس هدف هستند که Apigee باعث آنها نشده است. نحو میانای برنامهسازی کاربردی: |
| زمان پاسخدهی هدف | target_response_time | مجموع، میانگین، حداقل، حداکثر |
مقدار زمان (مجموع، میانگین، حداقل، یا حداکثر)، در میلیثانیه، برای پاسخ سرور هدف به تماس. این سنجه به شما میگوید سرورهای هدف چگونه عمل میکنند. زمان از وقتی شروع میشود که Edge درخواستی را به سرویس هدف ارسال میکند و وقتی پایان مییابد که Edge پاسخ را دریافت میکند. توجه داشته باشید که اگر یک فراخوانی API پاسخی از حافظه نهان برگرداند (برای مثال، بااستفاده از خطمشی «حافظه نهان پاسخ»)، فراخوانی هرگز به سرویس هدف نمیرسد و هیچ سنجه زمان پاسخ هدف ثبت نمیشود. نحو میانای برنامهسازی کاربردی: |
| کل زمان پاسخدهی | total_response_time | مجموع، میانگین، حداقل، حداکثر |
مقدار زمان (مجموع، میانگین، حداقل، یا حداکثر)، در میلیثانیه، از زمانی که Edge درخواستی از کارخواه دریافت میکند تا زمانی که Edge پاسخ را به کارخواه برمیگرداند. این زمان شامل سربار شبکه (مثل زمانی که متوازنکنندههای بار و مسیریابها برای انجام کارشان نیاز دارند)، تأخیر پردازش درخواست، تأخیر پردازش پاسخ، و زمان پاسخ هدف (اگر پاسخ از سرویس هدف بهجای حافظه نهان ارائه شود) میشود. بااستفاده از ابعاد مختلف، میتوانید تأخیرهای پردازش را براساس پراکسی API، برنامه توسعهدهنده، منطقه، و غیره بررسی کنید. نحو میانای برنامهسازی کاربردی: |
| ترافیک | message_count | مجموع |
تعداد کل فراخوانیهای API که Edge در دوره زمانی مشخصشده پردازش کرده است. از ابعاد استفاده کنید تا تعداد ترافیک را به روشهایی که برایتان معنادارتر است گروهبندی کنید. نحو میانای برنامهسازی کاربردی: |
ابعاد
ابعاد به شما امکان میدهند سنجهها را در گروههای معنادار مشاهده کنید. برای مثال، دیدن تعداد کل ترافیک وقتی که آنها را برای هر برنامه توسعهدهنده یا پراکسی API مشاهده میکنید بسیار قدرتمندتر میشود.
ابعاد زیر را Apigee بهصورت آماده ارائه میدهد. علاوهبراین، میتوانید ابعاد خودتان را ایجاد کنید، همانطور که در تجزیهوتحلیل محتوای پیام «میانای برنامهسازی کاربردی» بااستفاده از Analytics سفارشی توضیح داده شده است.
| نام «گزارشهای سفارشی» | نامی که در «میانای برنامهسازی کاربردی مدیریت» استفاده میشود | شرح |
|---|---|---|
| نهادهای Apigee | ||
| کد دسترسی | access_token | کد دسترسی OAuth کاربر نهایی برنامه. |
| محصول میانای برنامهسازی کاربردی | api_product |
نام محصول API که حاوی پراکسیهای API فراخوانیشده است. برای دریافت این بُعد، برنامههای توسعهدهندهای که تماس برقرار میکنند باید با یک یا چند محصول API که حاوی پراکسیهای API هستند مرتبط باشند، و پراکسیهای فراخواندهشده باید کلید API یا کد OAuth ارسالشده با تماس API را بررسی کنند. کلید یا کد با محصول API مرتبط است. برای اطلاعات بیشتر، اولین چیزها اول: چگونه دادههای تجزیهوتحلیل کامل تولید کنیم را ببینید. اگر معیارهای بالا برآورده نشوند، مقدار «(تنظیم نشده است)» را خواهید دید. همچنین مقدار نهاد تجزیهوتحلیل «(تنظیم نشده)» به چه معنا است؟ را ببینید. |
| کلید حافظه نهان | ax_cache_key |
کلید حاوی مقدار «حافظه نهان پاسخ» که به آن دسترسی شده است. برای کسب اطلاعات بیشتر درباره نحوه ساخت کلید برای حافظه نهان پاسخ، خطمشی حافظه نهان پاسخ را ببینید. در ابزار ردیابی،
وقتی خطمشی «پاسخ حافظه نهان» را انتخاب میکنید که از حافظه نهان میخواند یا در آن مینویسد، میتوانید
این مقدار را در |
| نام حافظه نهان | ax_cache_name |
نام حافظه نهان حاوی کلیدها/مقادیر استفادهشده توسط خطمشی «حافظه نهان پاسخ»، با پیشوند orgName__envName__. برای مثال، اگر سازمان «foo» باشد، محیط «test» باشد، و نام حافظه نهان «myCache» باشد، نام حافظه نهان ax_cache_name foo__test__myCache خواهد بود. در ابزار ردیابی،
وقتی خطمشی «ذخیره پاسخ» را انتخاب میکنید، میتوانید این مقدار را در
|
| منبع حافظه نهان | ax_cache_source |
سطح حافظه نهان («L1» در حافظه یا پایگاه داده «L2») که «حافظه نهان پاسخ» از آن بازیابی شده است. این بُعد همچنین وقتی پاسخ از هدف بهجای حافظه نهان ارائه شده باشد (و حافظه نهان پاسخ با پاسخ هدف بازآوری شده باشد) یا وقتی کلید حافظه نهان در درخواست نامعتبر باشد، «CACHE_MISS» را نشان میدهد. اندازه کلیدهای حافظه نهان به ۲ کیلوبایت محدود میشود. در ابزار ردیابی،
وقتی خطمشی «حافظه نهان پاسخ» را انتخاب میکنید، میتوانید این مقدار را در
برای اطلاعات بیشتر درباره سطوح حافظه نهان، درونمایههای حافظه نهان را ببینید. |
| شناسه کارخواه | client_id |
کلید مصرفکننده (کلید API) برنامه توسعهدهندهای که فراخوانیهای API را انجام میدهد، چه در درخواست بهعنوان کلیدهای API ارسال شده باشد یا در نشانهای OAuth گنجانده شده باشد. برای دریافت این بُعد، کارگزاران پراکسی دریافتکننده تماسها باید بهگونهای پیکربندی شوند که کلید API یا کد OAuth معتبری را بررسی کنند. برنامههای توسعهدهنده کلیدهای API دریافت میکنند که میتوانند برای تولید نمودارهای OAuth استفاده شوند، وقتی برنامهها در Edge ثبت میشوند. برای اطلاعات بیشتر، اولین چیزها اول: چگونه دادههای تجزیهوتحلیل کامل تولید کنیم را ببینید. اگر معیارهای بالا برآورده نشوند، مقدار «(تنظیم نشده است)» را خواهید دید. همچنین مقدار نهاد تجزیهوتحلیل «(تنظیم نشده)» به چه معنا است؟ را ببینید. |
| برنامه توسعهدهنده | developer_app |
برنامه توسعهدهنده ثبتشده در Edge که فراخوانیهای API را انجام میدهد. برای دریافت این بُعد، برنامهها باید با یک یا چند محصول API که حاوی پراکسیهای API فراخواندهشده هستند مرتبط باشند، و پراکسیها باید کلید API یا کد OAuth ارسالشده با فراخوانی API را بررسی کنند. کلید یا کد شناسایی برنامه توسعهدهنده را مشخص میکند. برای اطلاعات بیشتر، اولین چیزها: نحوه تولید دادههای تجزیهوتحلیل کامل را ببینید. اگر معیارهای بالا برآورده نشوند، مقدار «(تنظیم نشده است)» را خواهید دید. همچنین مقدار نهاد تجزیهوتحلیل «(تنظیم نشده)» به چه معنا است؟ را ببینید. |
| ایمیل توسعهدهنده | developer_email |
ایمیل توسعهدهندگان ثبتشده در Edge که نرمافزارشان فراخوانیهای API را انجام داده است. برای دریافت این بُعد، توسعهدهندگان باید برنامههایی داشته باشند که با یک یا چند محصول API مرتبط باشند که حاوی پراکسیهای API فراخواندهشده باشد، و پراکسیها باید کلید API یا کد OAuth ارسالشده با فراخوانی API را بررسی کنند. کلید یا کد شناسایی برنامه توسعهدهنده را مشخص میکند. برای اطلاعات بیشتر، اولین چیزها: نحوه تولید دادههای تجزیهوتحلیل کامل را ببینید. اگر معیارهای بالا برآورده نشوند، مقدار «(تنظیم نشده است)» را خواهید دید. همچنین مقدار نهاد تجزیهوتحلیل «(تنظیم نشده)» به چه معنا است؟ را ببینید. |
| شناسه توسعهدهنده | توسعهدهنده |
شناسه توسعهدهنده یکتای تولیدشده توسط Edge در قالب org_name@@@unique_id. برای دریافت این بُعد، توسعهدهندگان باید برنامههایی داشته باشند که با یک یا چند محصول API مرتبط باشند که حاوی پراکسیهای API فراخواندهشده باشند، و پراکسیها باید کلید API یا کد OAuth ارسالشده با فراخوانیهای API را بررسی کنند. کلید یا کد توسعهدهنده را شناسایی میکند. برای اطلاعات بیشتر، اولین چیزها: چگونه دادههای تجزیهوتحلیل کامل تولید کنیم را ببینید. اگر معیارهای بالا برآورده نشوند، مقدار «(تنظیم نشده است)» را خواهید دید. همچنین مقدار نهاد تجزیهوتحلیل «(تنظیم نشده)» به چه معنا است؟ را ببینید. |
| محیط زیست | محیط | محیط Edge که پراکسیهای API در آن مستقر شدهاند. برای مثال، «test» یا «prod». |
| کد خطا درصورت بروز خطا | ax_edge_execution_fault_code |
کد خطا مربوط به خطا. برای مثال:
|
| نام Flow در خطا | ax_execution_fault _flow_name |
جریان نامگذاریشده در پراکسی API که خطا ایجاد کرده است. برای مثال، «PreFlow»، «PostFlow»، یا نام جاریسازی شرطی که ایجاد کردهاید. توجه داشته باشید که نام کامل برای استفاده در مدیریت API عبارت است از ax_execution_fault_flow_name، بدون شکست خط. در جایی که خطایی رخ نداده است، مقدار «(تنظیم نشده است)» را خواهید دید. |
| منبع Flow | flow_resource | فقط برای استفاده Apigee. اگر کنجکاو هستید، این پست انجمن را ببینید. |
| وضعیت جریان درصورت بروز خطا | ax_execution_fault _flow_state |
نام وضعیت جاریسازی پراکسی API که خطاهایی را ایجاد کرده است، مثل «PROXY_REQ_FLOW» یا «TARGET_RESP_FLOW». توجه داشته باشید که نام کامل برای استفاده در مدیریت API عبارت است از ax_execution_fault_flow_state، بدون شکست خط. |
| شناسه جریان دروازه | gateway_flow_id | همزمان با حرکت کردن فراخوانیهای API در Edge، هر فراخوانی شناسه جریان درگاه خود را دریافت میکند. مثال: rrt329ea-12575-114653952-1. «شناسه جریان درگاه» برای تشخیص سنجهها در شرایطی که تعداد تراکنش در ثانیه بالا است و ابعاد دیگر مثل سازمان، محیط، و مُهر زمان در سراسر تماسها یکسان است مفید است. |
| سازمان | سازمان | سازمان Edge که پراکسیهای میانای برنامهسازی کاربردی در آن مستقر شدهاند. |
| نام خطمشی در خطا | ax_execution_fault _policy_name |
نام خطمشیای که خطا ایجاد کرده و باعث شده است فراخوانی API ناموفق باشد. توجه داشته باشید که نام کامل برای استفاده در «میانای برنامهسازی کاربردی مدیریت» ax_execution_fault_policy_name است، بدون شکست خط. اگر خطمشیای خطا ایجاد کند اما مشخصه ریشه خطمشی |
| پراکسی | apiproxy | نام ماشین (نه «نام نمایشی») یک پراکسی API. |
| مسیر پایه پراکسی | proxy_basepath |
BasePath پیکربندیشده در ProxyEndpoint میانای برنامهسازی کاربردی پراکسی. مسیر پایه شامل بخش دامنه و درگاه نشانی وب پراکسی API نمیشود. برای مثال، اگر نشانی وب پایه یک پراکسی API این باشد: https://apigeedocs-test.apigee.net/releasenotes/، مسیر پایه /releasenotes است. مقدار در |
| پسوند مسیر پراکسی | proxy_pathsuffix |
مسیر منبع به مسیر پایه پراکسی API اضافه شد. برای مثال، اگر نشانی وب پایه یک پراکسی API
اگر از هیچ پسوند مسیری استفاده نشود، مقدار خالی است. مقدار در |
| اصلاح پراکسی | apiproxy_revision | شماره بازبینی کارگزار نیابتی API که تماسهای API را مدیریت کرده است. این لزوماً به معنای جدیدترین نسخه اصلاحشده پراکسی API نیست. اگر یک پراکسی API دارای ۱۰ بازبینی باشد، بازبینی هشتم ممکن است درحالحاضر مستقر باشد. همچنین، یک API میتواند چندین نسخه بازبینی داشته باشد که تا زمانی که نسخههای بازبینی «مسیرهای پایه» متفاوتی داشته باشند، همانطور که در استقرار پراکسیها در رابط کاربری توضیح داده شده است، مستقر شده باشند. |
| پروتکل اینترنتی کارخواه حلوفصلشده | ax_resolved_client_ip |
حاوی نشانی IP کارخواه مبدأ است. مقدار بُعد توجه داشته باشید که هنگام استفاده از محصولات مسیریابی مانند Akamai برای گرفتن نشانیهای IP واقعی مشتریان،
نشانی IP مشتری در سرایند HTTP مقدار بُعد
|
| کد وضعیت پاسخ | response_status_code | کد وضعیت پاسخ HTTP که از Apigee به کارخواه ارسال شده است، مانند 200، 404، 503، و غیره. در Edge، کد وضعیت پاسخ از هدف میتواند با خطمشیهایی مثل Assign Message (اختصاص پیام) و Raise Fault (ایجاد خطا) رونویسی شود، به همین دلیل این بُعد میتواند با Target Response Code (کد پاسخ هدف) (target_response_code) متفاوت باشد. |
| میزبان مجازی | virtual_host | نام میزبان مجازی که
فراخوانی میانای برنامهسازی کاربردی به آن انجام شده است. برای مثال، سازمانها بهطور پیشفرض دو میزبان مجازی دارند: default (http) و secure (https). |
| ورودی/مشتری | ||
| نشانی IP کارخواه | client_ip | نشانی IP سیستمی که به مسیریاب میرسد، مانند کارخواه اصلی
(proxy_client_ip) یا ترازکننده بار. وقتی چندین نشانی IP در سرایند
X-Forwarded-For وجود دارد، این آخرین نشانی IP فهرستشده است. |
| دسته دستگاه | ax_ua_device_category | نوع دستگاهی که فراخوانی میانای برنامهسازی کاربردی از آن انجام شده است، مثل «رایانه لوحی» یا «تلفن هوشمند». |
| خانواده سیستمعامل | ax_ua_os_family | خانواده سیستمعامل دستگاهی که تماس میگیرد، مثل «Android» یا «iOS». |
| نسخه سیستمعامل | ax_ua_os_version |
نسخه سیستمعامل دستگاهی که تماس میگیرد. استفاده از این مورد بهعنوان دومین بُعد «جزئینگر» با «خانواده سیستمعامل» (ax_ua_os_family) برای دیدن نسخههای سیستمعامل مفید است. |
| پروتکل اینترنتی کارخواه پراکسی | proxy_client_ip |
نشانی IP کارخواه تماسگیرنده، ذخیرهشده در |
| پروتکل اینترنتی کارخواه ارجاعشده | ax_true_client_ip | هنگام استفاده از محصولات مسیریابی مانند Akamai برای گرفتن نشانیهای IP واقعی مشتریان،
نشانیهای IP مشتری در سرایند HTTP برای تعیین «نشانی IP کارخواه اصلی» که ازطریق |
| مسیر درخواست | request_path |
مسیر منبع (بدون دامنه) به سرویس هدف، بدون پارامترهای پُرسمان. برای مثال، هدف نمونه Apigee |
| URI درخواست | request_uri |
مسیر منبع (بدون درنظر گرفتن دامنه) به سرویس هدف، ازجمله پارامترهای پُرسمان. برای مثال، هدف نمونه Apigee |
| فعل درخواست | request_verb | فعل درخواست HTTP در درخواستهای API، مانند GET، POST، PUT، DELETE. |
| نماینده کاربر | useragent |
نام کارگزار کاربر یا کارگزار نرمافزاری که برای برقراری تماس با «میانای برنامهسازی کاربردی» استفاده شده است. مثالها:
|
| خانواده عامل کاربر | ax_ua_agent_family | خانواده عامل کاربر، مثل «Chrome Mobile» یا «cURL». |
| نوع نماینده کاربر | ax_ua_agent_type | نوع عامل کاربر، مثل «مرورگر»، «مرورگر تلفن همراه»، «کتابخانه»، و غیره. |
| نسخه نماینده کاربر | ax_ua_agent_version |
نسخه عامل کاربر. استفاده از این مورد بهعنوان دومین بُعد «جزئینگر» با «خانواده عامل کاربر» (ax_ua_agent_family) برای دریافت نسخه خانواده عامل مفید است. |
| برونسپاری/هدف | ||
| مسیر پایه هدف | target_basepath |
مسیر منبع (بدون درنظر گرفتن دامنه) به سرویس هدف، بدون درنظر گرفتن پارامترهای پُرسمان، که در برای مثال، فرض کنید یک پراکسی API هدف زیر را فراخوانی میکند: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net/user?user=Dude</URL> </HTTPTargetConnection> در این مثال، target_basepath اگر هدف این باشد: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net</URL> </HTTPTargetConnection> target_basepath خالی خواهد بود. در ابزار ردیابی، وقتی نماد AX را در انتهای نمودار جریان انتخاب میکنید،
|
| میزبان هدف | target_host | میزبان سرویس هدف. برای مثال، اگر کارگزار API
http://mocktarget.apigee.net/help را فراخوانی کند، میزبان هدف
mocktarget.apigee.net است. |
| نشانی IP هدف | target_ip | نشانی IP سرویس هدف که پاسخ را به پراکسی API برمیگرداند. |
| کد پاسخ هدف | target_response_code |
کد وضعیت پاسخ HTTP که سرویس هدف به پراکسی API برمیگرداند، مانند ۲۰۰، ۴۰۴، ۵۰۳، و غیره. مقدار «null» به این معنی است که درخواست هرگز به سرویس هدف نرسیده است. این اتفاق زمانی رخ میدهد که پاسخ توسط خطمشی «حافظه نهان پاسخ» ارائه شود یا زمانی که در پردازش درخواست شکست وجود داشته باشد. این با بُعد کد وضعیت پاسخ (response_status_code) متفاوت است. |
| نشانی وب هدف | target_url |
نشانی وب کامل سرویس هدف که در «نقطه پایان هدف» میانای برنامهسازی کاربردی تعریف شده است. <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net/user?user=Dude</URL> </HTTPTargetConnection> در این مثال، target_url این است:
توجه داشته باشید که نشانی وب را میتوان درطول پردازش کارگزار نیابتی API با
در زنجیره پراکسی و هنگام استفاده از هدفهای دستورگان (Node.js)، مقدار target_url در پراکسی فراخواننده تهی است. |
| X Forwarded For | x_forwarded_for_ip | فهرست نشانیهای IP در سرایند برای تعیین «نشانی IP کارخواه اصلی» که ازطریق |
| زمان | ||
| روز از هفته | ax_day_of_week | حروف اختصاری سه حرفی روز هفته که فراخوانیهای API در آن انجام شده است. برای مثال، دوشنبه، سهشنبه، چهارشنبه. |
| ماه | ax_month_of_year | ماه عددی که در آن فراخوانیهای API انجام شده است. برای مثال، «۰۳» برای مارس. |
| زمان روز | ax_hour_of_day |
براساس ساعت ۲۴ ساعته، ساعت ۲ رقمی که در آن فراخوانیهای API انجام شده است. برای مثال، فراخوانهای میانای برنامهسازی کاربردی که در ساعت بین ۱۰ تا ۱۱ شب انجام شده است، ax_hour_of_day برابر با ۲۲ خواهد بود. مقدار زمان به «ساعت هماهنگ جهانی» است. |
| منطقه زمانی | ax_geo_timezone | نامهای رایج مناطق زمانی که فراخوانیهای API از آنها انجام شده است، مانند America/New_York و Europe/Dublin. |
| هفته ماه | ax_week_of_month | هفته عددی ماه. برای مثال، برای تماسهای API که در هفته سوم یک ماه برقرار میشوند، ax_week_of_month برابر با ۳ است. |
| مکان | ||
| شهر | ax_geo_city | شهری که فراخوانیهای API از آنجا انجام شده است. |
| قاره | ax_geo_continent | کد دوحرفی قارهای که فراخوانیهای API از آنجا انجام شده است. برای مثال، NA برای آمریکای شمالی. |
| کشور | ax_geo_country | کد دوحرفی کشوری که فراخوانیهای API از آنجا انجام شده است. برای مثال، US برای ایالات متحده. |
| منطقه جغرافیایی | ax_geo_region | کد خطدار برای منطقه جغرافیایی، مثل STATE-COUNTRY. برای مثال، WA-US برای واشنگتن-ایالات متحده. |
| منطقه | ax_dn_region | نام مرکز داده Apigee که پراکسیهای API در آن مستقر شدهاند، مثل us-east-1. |
| درآمدزایی | ||
| نادیده گرفتن پیام تراکنش Mint | x_apigee_mint_tx_ignoreMessage | پرچمی که مشخص میکند آیا پیامهای مربوط به درآمدزایی نادیده گرفته شوند یا خیر. برای همه سازمانهای درآمدزایی روی false تنظیم کنید. |
| وضعیت تراکنش ضرب | x_apigee_mint_tx_status | وضعیت درخواست درآمدزایی، مانند موفقیت، شکست، نامعتبر، یا هیچ. |
فیلترها
فیلترها به شما امکان میدهند نتایج را به سنجههایی با ویژگیهای خاص محدود کنید. در زیر چند فیلتر نمونه آورده شده است. هنگام تعریف فیلترها، از نامهای سبک API سنجه و بُعد استفاده کنید.
سنجههای مربوط به پراکسیهای میانای برنامهسازی کاربردی با نام کتاب یا موسیقی را برمیگرداند:
filter=(apiproxy in 'books','music')
سنجههای مربوط به پراکسیهای API را که نامشان با «m» شروع میشود برمیگرداند:
filter=(apiproxy like 'm%')
سنجههای مربوط به پراکسیهای API را برمیگرداند که نام آنها با «m» شروع نمیشود:
filter=(apiproxy not like 'm%')
سنجههای مربوط به فراخوانیهای «میانای برنامهسازی کاربردی» را با کدهای وضعیت پاسخ بین ۴۰۰ و ۵۹۹ برمیگرداند:
filter=(response_status_code ge 400 and response_status_code le 599)
سنجههای مربوط به فراخوانیهای «میانای برنامهسازی کاربردی» را با کد وضعیت پاسخ ۲۰۰ و کد پاسخ هدف ۴۰۴ برمیگرداند:
filter=(response_status_code eq 200 and target_response_code eq 404)
سنجههای مربوط به فراخوانیهای «میانای برنامهسازی کاربردی» با کد وضعیت پاسخ ۵۰۰ را برمیگرداند:
filter=(response_status_code eq 500)
سنجههای مربوط به فراخوانیهای API را که منجر به خطا نشدهاند برمیگرداند:
filter=(is_error eq 0)
در زیر اپراتورهایی که میتوانید برای ساختن فیلترهای گزارش استفاده کنید آورده شده است.
| اپراتور | شرح |
|---|---|
in |
افزودن به فهرست |
notin |
کنارگذاری از فهرست |
eq |
برابر با، == |
ne |
برابر با، != نباشد |
gt |
بزرگتر از، > |
lt |
کمتر از، < |
ge |
بزرگتر از یا مساوی با، >= |
le |
کمتر یا مساوی با، <= |
like |
اگر الگوی رشته با الگوی ارائهشده مطابقت داشته باشد، مقدار درست را برمیگرداند. |
not like |
اگر الگوی رشته با الگوی ارائهشده مطابقت داشته باشد، نادرست برمیگرداند. |
similar to |
بسته به اینکه الگوی آن با رشته دادهشده مطابقت دارد یا نه، درست یا نادرست را برمیگرداند. این تابع
شبیه like است با این تفاوت که الگو را بااستفاده از تعریف عبارت باقاعده استاندارد SQL تفسیر میکند. |
not similar to |
بسته به اینکه الگوی آن با رشته دادهشده مطابقت دارد یا نه، نادرست یا درست را برمیگرداند. این تابع شبیه not like است، با این تفاوت که الگو را بااستفاده از تعریف عبارت باقاعده استاندارد SQL تفسیر میکند. |
and |
به شما امکان میدهد از منطق «و» برای گنجاندن بیشاز یک عبارت فیلتر استفاده کنید. فیلتر شامل دادههایی است که همه شرایط را برآورده میکند. |
or |
به شما امکان میدهد از منطق «یا» برای ارزیابی عبارات فیلتر ممکن مختلف استفاده کنید. فیلتر شامل دادههایی است که حداقل یکی از شرایط را برآورده میکند. |