مرجع معیارهای تجزیه و تحلیل، ابعاد و فیلترها

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

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

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

معیارها

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

نام گزارش‌های سفارشی نامی که در API مدیریت استفاده می‌شود توابع توضیحات
میانگین تراکنش‌ها در هر ثانیه تپش‌ها هیچکدام

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

سینتکس API: tps

آمار حافظه پنهان cache_hit جمع

تعداد درخواست‌های API موفقی که به جای پاسخ از سرویس هدف، از Response Cache استفاده می‌کنند.

نحو API: sum(cache_hit)

تعداد عناصر حافظه نهان سطح ۱ ax_cache_l1_count میانگین، حداقل، حداکثر

تعداد عناصر موجود در حافظه پنهان سطح ۱ (درون حافظه) به ازای هر تراکنش در یک بازه زمانی مشخص را برمی‌گرداند. برای مثال، اگر برای دوره یک روز max انتخاب کنید و در آن روز بیشترین تعداد عناصر موجود در حافظه پنهان برای یک تراکنش خاص ۱۲ باشد، تعداد عناصر ۱۲ خواهد بود. برای avg ، اگر در دوره زمانی که شما در حال پرس و جو هستید، سه تراکنش وجود داشته باشد و تعداد حافظه پنهان آنها ۵، ۶ و ۷ باشد، میانگین ۶ است. حافظه پنهان سطح ۱، حافظه پنهان در حافظه است، برخلاف حافظه پنهان پایگاه داده سطح ۲، همانطور که در Cache internals توضیح داده شده است.

سینتکس API: avg(ax_cache_l1_count)

خطاهای سیاست خطای_خطا جمع

تعداد کل خطاهای سیاستی در طول دوره زمانی مشخص شده.

خطاهای سیاست معمولاً به دلیل طراحی رخ می‌دهند. به عنوان مثال، سیاست تأیید کلید API هنگام ارسال یک کلید API نامعتبر در درخواست، خطایی ایجاد می‌کند و سیاست Spike Arrest اگر تعداد فراخوانی‌های API از حد تعریف شده در سیاست بیشتر شود، خطایی ایجاد می‌کند. بنابراین این معیار برای یافتن نقاط مشکل‌ساز بالقوه در APIهای شما مفید است. به عنوان مثال، معیارهای policy_error که بر اساس بعد developer_app گروه‌بندی می‌شوند، ممکن است به شما کمک کنند تا متوجه شوید که یک کلید API یا توکن OAuth برای یک برنامه خاص منقضی شده است. یا ممکن است متوجه شوید که یک پروکسی API خاص خطاهای Spike Arrest زیادی ایجاد می‌کند و منجر به این می‌شود که متوجه شوید محدودیت spike arrest پروکسی، افزایش ترافیک تعطیلات را در نظر نمی‌گیرد.

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

بُعد «نام سیاست در خطا» (ax_execution_fault_policy_name) برای گروه‌بندی خطاهای سیاست بر اساس نام سیاست مفید است.

یک خطای هدف (مانند خطای ۴۰۴ یا ۵۰۳) به عنوان خطای خط‌مشی (policy failure) محسوب نمی‌شود. این خطاها به عنوان خطای پروکسی API (is_error) محسوب می‌شوند.

نحو API: sum(policy_error)

خطاهای پروکسی is_error جمع

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

بُعد پروکسی (apiproxy) برای گروه‌بندی خرابی‌های پروکسی API بر اساس پروکسی مفید است.

نحو API: sum(is_error)

تأخیر پردازش درخواست تأخیر پردازش درخواست میانگین، حداقل، حداکثر

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

با استفاده از ابعاد مختلف، می‌توانید تأخیرهای پردازش درخواست را بر اساس پروکسی API، برنامه توسعه‌دهنده، منطقه و غیره بررسی کنید.

نحو API: max(request_processing_latency)

اندازه درخواست درخواست_اندازه مجموع، میانگین، حداقل، حداکثر

اندازه‌ی درخواست ارسالی (payload) دریافت شده توسط Edge، بر حسب بایت .

سینتکس API: avg(request_size)

حافظه پنهان پاسخ اجرا شد ax_cache_executed جمع

تعداد کل دفعاتی که یک سیاست کش پاسخ (Response Cache) در طول دوره زمانی مشخص اجرا شده است.

از آنجایی که سیاست Response Cache در دو مکان در یک پروکسی API (یک بار در درخواست و یک بار در پاسخ) پیوست شده است، معمولاً در یک فراخوانی API دو بار اجرا می‌شود. یک cache 'get' و یک cache 'put' هر کدام به عنوان یک اجرا حساب می‌شوند.

با این حال، اگر عنصر <SkipCacheLookup> در سیاست (در درخواست) درست ارزیابی شود، اجرای کش پاسخ 0 است و اگر عنصر <SkipCachePopulation> در سیاست (در پاسخ) درست ارزیابی شود، 0 است.

در ابزار Trace ، می‌توانید در یک فراخوانی API اجرا شده، روی آیکون Response Cache کلیک کنید و متغیر جریان responsecache.executed را مشاهده کنید تا ببینید آیا اجرای کش (مقدار ۱) وجود داشته است یا خیر.

نحو API: sum(ax_cache_executed)

تأخیر پردازش پاسخ تأخیر پردازش پاسخ میانگین، حداقل، حداکثر

مدت زمانی (میانگین، حداقل یا حداکثر)، بر حسب میلی‌ثانیه ، که طول می‌کشد تا Edge پاسخ‌های API را پردازش کند. این زمان از زمانی شروع می‌شود که پروکسی API پاسخ سرویس هدف را دریافت می‌کند و زمانی پایان می‌یابد که Apigee پاسخ را به فراخواننده اصلی ارسال می‌کند.

با استفاده از ابعاد مختلف، می‌توانید تأخیرهای پردازش پاسخ را بر اساس پروکسی API، منطقه و غیره بررسی کنید.

نحو API: min(response_processing_latency)

اندازه پاسخ اندازه_پاسخ مجموع، میانگین، حداقل، حداکثر

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

نحو API: max(response_size)

خطاهای هدف target_error جمع

تعداد کل پاسخ‌های 5xx از سرویس هدف. اینها خطاهای سرویس هدف هستند که توسط Apigee ایجاد نشده‌اند.

نحو API: sum(target_error)

زمان پاسخ هدف زمان_پاسخ_هدف مجموع، میانگین، حداقل، حداکثر

مدت زمان (مجموع، میانگین، حداقل یا حداکثر)، بر حسب میلی‌ثانیه ، برای پاسخ سرور هدف به یک تماس. این معیار به شما می‌گوید که سرورهای هدف چگونه عمل می‌کنند. این زمان از زمانی شروع می‌شود که Edge یک درخواست را به سرویس هدف ارسال می‌کند و زمانی پایان می‌یابد که Edge پاسخ را دریافت کند.

توجه داشته باشید که اگر یک فراخوانی API پاسخی را از حافظه پنهان (cache) برگرداند (برای مثال، با استفاده از خط‌مشی Response Cache)، این فراخوانی هرگز به سرویس هدف نخواهد رسید و هیچ معیار زمان پاسخ هدف ثبت نمی‌شود.

نحو API: avg(target_response_time)

زمان پاسخ کل زمان_پاسخ_کل مجموع، میانگین، حداقل، حداکثر

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

با استفاده از ابعاد مختلف، می‌توانید تأخیرهای پردازش را بر اساس پروکسی API، برنامه توسعه‌دهنده، منطقه و غیره بررسی کنید.

سینتکس API: avg(total_response_time)

ترافیک تعداد_پیام جمع

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

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

نحو API: sum(message_count)

ابعاد

ابعاد (Dimension) به شما امکان می‌دهند معیارها را در گروه‌بندی‌های معنادار مشاهده کنید. برای مثال، مشاهده تعداد کل ترافیک وقتی که آنها را برای هر برنامه توسعه‌دهنده یا پروکسی API مشاهده کنید، بسیار قدرتمندتر می‌شود.

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

نام گزارش‌های سفارشی نامی که در API مدیریت استفاده می‌شود توضیحات
موجودات آپیجی
توکن دسترسی access_token توکن دسترسی OAuth کاربر نهایی برنامه.
محصول API محصول_api

نام محصول API حاوی پروکسی‌های API که فراخوانی می‌شوند. برای دریافت این بُعد، برنامه‌های توسعه‌دهنده‌ای که فراخوانی‌ها را انجام می‌دهند باید با یک یا چند محصول API که حاوی پروکسی‌های API هستند مرتبط باشند و پروکسی‌های فراخوانی شده باید کلید API یا توکن OAuth ارسال شده با فراخوانی API را بررسی کنند. کلید یا توکن با یک محصول API مرتبط است. برای اطلاعات بیشتر، به بخش «اولویت‌ها: چگونه داده‌های تحلیلی کامل تولید کنیم» مراجعه کنید.

اگر معیارهای بالا برآورده نشوند، مقدار "(تنظیم نشده)" را مشاهده خواهید کرد. همچنین ببینید مقدار "(تنظیم نشده)" برای یک موجودیت تحلیلی به چه معناست؟

کلید حافظه پنهان کلید_کش_ایکس

کلیدی که حاوی مقدار Response Cache است که به آن دسترسی پیدا شده است. برای اطلاعات بیشتر در مورد نحوه ساخت کلید برای response cache، به سیاست Response Cache مراجعه کنید.

در ابزار Trace ، وقتی یک سیاست Response Cache را انتخاب می‌کنید که از حافظه پنهان می‌خواند یا در آن می‌نویسد، می‌توانید این مقدار را در متغیر جریان responsecache.cachekey مشاهده کنید.

نام حافظه پنهان نام_کش_ax

نام حافظه پنهانی که شامل کلیدها/مقادیر مورد استفاده توسط سیاست Response Cache است، که با پیشوند orgName__envName__ شروع می‌شود. برای مثال، اگر org برابر با "foo" باشد، محیط "test" و نام حافظه پنهان "myCache" باشد، نام ax_cache_name برابر با foo__test__myCache خواهد بود.

در ابزار Trace ، وقتی یک سیاست Response Cache را انتخاب می‌کنید، می‌توانید این مقدار را در متغیر جریان responsecache.cachename مشاهده کنید.

منبع حافظه پنهان منبع ax_cache

سطح حافظه پنهان ("L1" در حافظه یا "L2" در پایگاه داده) که Response Cache از آن بازیابی شده است. این بُعد همچنین "CACHE_MISS" را نشان می‌دهد زمانی که پاسخ به جای حافظه پنهان از هدف تحویل داده شده است (و حافظه پنهان پاسخ با پاسخ هدف به‌روزرسانی شده است)؛ یا زمانی که یک کلید حافظه پنهان در درخواست نامعتبر است. اندازه کلیدهای حافظه پنهان به 2 کیلوبایت محدود شده است.

در ابزار Trace ، وقتی سیاست Response Cache را انتخاب می‌کنید، می‌توانید این مقدار را در متغیر جریان responsecache.cachesource مشاهده کنید.

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

شناسه مشتری شناسه_مشتری

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

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

اگر معیارهای بالا برآورده نشوند، مقدار "(تنظیم نشده)" را مشاهده خواهید کرد. همچنین ببینید مقدار "(تنظیم نشده)" برای یک موجودیت تحلیلی به چه معناست؟

برنامه توسعه‌دهنده برنامه_توسعه‌دهنده

برنامه توسعه‌دهنده ثبت‌شده در Edge که فراخوانی‌های API را انجام می‌دهد.

برای دریافت این بُعد، برنامه‌ها باید با یک یا چند محصول API که حاوی پروکسی‌های API فراخوانی شده هستند، مرتبط باشند و پروکسی‌ها باید کلید API یا توکن OAuth ارسال شده با فراخوانی API را بررسی کنند. این کلید یا توکن، برنامه توسعه‌دهنده را شناسایی می‌کند. برای اطلاعات بیشتر، به بخش «اولویت‌ها: چگونه داده‌های تحلیلی کامل تولید کنیم» مراجعه کنید.

اگر معیارهای بالا برآورده نشوند، مقدار "(تنظیم نشده)" را مشاهده خواهید کرد. همچنین ببینید مقدار "(تنظیم نشده)" برای یک موجودیت تحلیلی به چه معناست؟

ایمیل توسعه‌دهنده ایمیل توسعه‌دهنده

ایمیل توسعه‌دهندگان ثبت‌شده در اج که برنامه‌ی آن‌ها فراخوانی‌های API را انجام داده است.

برای دریافت این بُعد، توسعه‌دهندگان باید برنامه‌هایی مرتبط با یک یا چند محصول API داشته باشند که حاوی پروکسی‌های API فراخوانی شده باشند و پروکسی‌ها باید کلید API یا توکن OAuth ارسال شده با فراخوانی API را بررسی کنند. این کلید یا توکن، برنامه توسعه‌دهنده را شناسایی می‌کند. برای اطلاعات بیشتر، به بخش «اولویت‌ها: چگونه داده‌های تحلیلی کامل تولید کنیم» مراجعه کنید.

اگر معیارهای بالا برآورده نشوند، مقدار "(تنظیم نشده)" را مشاهده خواهید کرد. همچنین ببینید مقدار "(تنظیم نشده)" برای یک موجودیت تحلیلی به چه معناست؟

شناسه توسعه‌دهنده توسعه‌دهنده

شناسه‌ی توسعه‌دهنده‌ی منحصر به فرد تولید شده توسط Edge به شکل org_name @@@ unique_id .

برای دریافت این بُعد، توسعه‌دهندگان باید برنامه‌هایی مرتبط با یک یا چند محصول API داشته باشند که حاوی پروکسی‌های API فراخوانی شده هستند و پروکسی‌ها باید کلید API یا توکن OAuth ارسال شده با فراخوانی‌های API را بررسی کنند. این کلید یا توکن، توسعه‌دهنده را شناسایی می‌کند. برای اطلاعات بیشتر، به بخش «اولویت‌ها: چگونه داده‌های تحلیلی کامل تولید کنیم» مراجعه کنید.

اگر معیارهای بالا برآورده نشوند، مقدار "(تنظیم نشده)" را مشاهده خواهید کرد. همچنین ببینید مقدار "(تنظیم نشده)" برای یک موجودیت تحلیلی به چه معناست؟

محیط زیست محیط زیست محیط Edge که پروکسی‌های API در آن مستقر می‌شوند. به عنوان مثال، "test" یا "prod".
کد خطا در خطا کد خطای ax_edge_execution

کد خطای خطا. به عنوان مثال: messaging.adaptors.http.flow.GatewayTimeout

نام جریان در خطا خطای ax_execution
نام_جریان

جریان نامگذاری شده در یک پروکسی API که باعث ایجاد خطا شده است. به عنوان مثال، "PreFlow"، "PostFlow" یا نام یک جریان شرطی که شما ایجاد کرده‌اید.

توجه داشته باشید که نام کامل مورد استفاده در API مدیریت، ax_execution_fault_flow_name است، بدون هیچ خط فاصله‌ای.

در جایی که خطایی رخ نداده باشد، مقدار "(تنظیم نشده)" را خواهید دید.

منبع جریان منبع_جریان فقط برای استفاده در آپیجی. اگر کنجکاو هستید، به این پست انجمن مراجعه کنید.
وضعیت جریان در هنگام خطا خطای ax_execution
جریان_وضعیت

نام جریان پروکسی API بیان می‌کند که چه خطاهایی رخ داده است، مانند "PROXY_REQ_FLOW" یا "TARGET_RESP_FLOW".

توجه داشته باشید که نام کامل مورد استفاده در API مدیریت، ax_execution_fault_flow_state است، بدون هیچ خط فاصله‌ای.

شناسه جریان دروازه شناسه‌ی gateway_flow همانطور که فراخوانی‌های API از طریق Edge عبور می‌کنند، هر فراخوانی شناسه جریان دروازه (gateway flow ID) مخصوص به خود را دریافت می‌کند. مثال: rrt329ea-12575-114653952-1. شناسه جریان دروازه برای تشخیص معیارها در موقعیت‌های با TPS بالا مفید است، جایی که ابعاد دیگری مانند سازمان، محیط و برچسب زمانی در بین فراخوانی‌ها یکسان هستند.
سازمان سازمان سازمان لبه‌ای که پروکسی‌های API در آن مستقر هستند.
نام خط‌مشی در مورد خطا خطای ax_execution
نام_سیاست

نام سیاستی که خطایی ایجاد کرده و باعث عدم موفقیت فراخوانی API شده است.

توجه داشته باشید که نام کامل مورد استفاده در API مدیریت، ax_execution_fault_policy_name است، بدون هیچ خط فاصله‌ای.

اگر یک سیاست خطایی ایجاد کند اما ویژگی ریشه سیاست یعنی continueOnError روی true تنظیم شده باشد، جریان پروکسی API بدون شکست ادامه می‌یابد و شکست سیاست در این بُعد محاسبه نمی‌شود.

پروکسی اپیپروکسی نام دستگاه (نه نام نمایشی) یک پروکسی API.
مسیر پایه پروکسی proxy_basepath

مسیر پایه (BasePath) پیکربندی شده در پروکسی API ProxyEndpoint. مسیر پایه شامل بخش دامنه و پورت URL پروکسی API نمی‌شود. برای مثال، اگر URL پایه یک پروکسی API به صورت https://apigeedocs-test.apigee.net/releasenotes/ باشد، مسیر پایه /releasenotes خواهد بود.

این مقدار همچنین در متغیر جریان proxy.basepath ذخیره می‌شود.

پسوند مسیر پروکسی proxy_pathsuffix

مسیر منبع اضافه شده به مسیر پایه پروکسی API. برای مثال، اگر URL پایه یک پروکسی API، https://apigeedocs-test.apigee.net/hello/ باشد و فراخوانی به https://apigeedocs-test.apigee.net/hello/json انجام شود، پسوند مسیر /json خواهد بود.

اگر از پسوند مسیر استفاده نشود، مقدار خالی است.

این مقدار همچنین در متغیر جریان proxy.pathsuffix ذخیره می‌شود.

نسخه پروکسی apiproxy_revision شماره ویرایش پروکسی API که فراخوانی‌های API را مدیریت می‌کرد. این لزوماً به معنای آخرین ویرایش پروکسی API نیست. اگر یک پروکسی API ده ویرایش داشته باشد، ویرایش هشتم ممکن است در حال حاضر مستقر باشد. همچنین، یک API می‌تواند چندین ویرایش مستقر داشته باشد، مادامی که ویرایش‌ها مسیرهای پایه متفاوتی داشته باشند، همانطور که در بخش «استقرار پروکسی‌ها در رابط کاربری» توضیح داده شده است.
آی‌پی کلاینت اصلاح‌شده ax_resolved_client_ip

شامل آدرس IP کلاینت مبدا است. مقدار بُعد ax_resolved_client_ip از مقادیر موجود در بُعدهای ax_true_client_ip و x_forwarded_for_ip محاسبه می‌شود.

توجه داشته باشید که هنگام استفاده از محصولات مسیریابی مانند Akamai برای ثبت آدرس‌های IP واقعی کلاینت‌ها، True-Client-IP کلاینت در هدر HTTP به Edge ارسال می‌شود که سپس برای تنظیم بُعد ax_true_client_ip استفاده می‌شود.

مقدار بُعد ax_resolved_client_ip به صورت زیر محاسبه می‌شود:

  1. اگر ax_true_client_ip برابر با null نباشد و حاوی آدرس IP محلی نباشد، آنگاه ax_resolved_client_ip را برابر با ax_true_client_ip قرار دهید.
  2. در غیر این صورت، ax_resolved_client_ip برابر با اولین آدرس IP غیر محلی در x_forwarded_for_ip قرار دهید.
  3. اگر هر دو ax_true_client_ip و x_forwarded_for_ip فقط شامل آدرس‌های IP محلی هستند، ax_resolved_client_ip برابر با اولین آدرس IP محلی در x_forwarded_for_ip قرار دهید.
  4. اگر هر دو ax_true_client_ip و x_forwarded_for_ip تهی (null) باشند، ax_resolved_client_ip روی (not set) تنظیم کنید.
  5. اگر ax_true_client_ip یک آدرس IP محلی است و x_forwarded_for_ip مقدار null دارد، ax_resolved_client_ip روی (not set) تنظیم کنید.
کد وضعیت پاسخ کد_وضعیت_پاسخ کد وضعیت پاسخ HTTP که از Apigee به کلاینت ارسال می‌شود، مانند ۲۰۰، ۴۰۴، ۵۰۳ و غیره. در Edge، کد وضعیت پاسخ از مقصد می‌تواند با سیاست‌هایی مانند Assign Message و Raise Fault بازنویسی شود، به همین دلیل است که این بُعد می‌تواند با Target Response Code (target_response_code) متفاوت باشد.
میزبان مجازی میزبان مجازی نام میزبان مجازی که فراخوانی API به آن انجام شده است. برای مثال، سازمان‌ها به طور پیش‌فرض دو میزبان مجازی دارند: default (http) و secure (https).
ورودی/مشتری
آدرس IP کلاینت کلاینت_آی‌پی آدرس IP سیستمی که به روتر متصل می‌شود، مانند کلاینت اصلی (proxy_client_ip) یا یک متعادل‌کننده بار. وقتی چندین IP در هدر X-Forwarded-For وجود دارد، این آخرین IP لیست شده است.
دسته بندی دستگاه دسته بندی دستگاه ax_ua نوع دستگاهی که فراخوانی API از طریق آن انجام شده است، مانند «تبلت» یا «گوشی هوشمند».
خانواده سیستم عامل ax_ua_os_family خانواده سیستم عامل دستگاهی که تماس را برقرار می‌کند، مانند «اندروید» یا «آی‌او‌اس».
نسخه سیستم عامل نسخه_سیستم_عامل_ax_ua

نسخه سیستم عامل دستگاهی که تماس را برقرار می‌کند.

استفاده از این به عنوان بُعد دوم «مرور» با خانواده سیستم عامل (ax_ua_os_family) برای دیدن نسخه‌های سیستم عامل‌ها مفید است.

آی‌پی کلاینت پروکسی پروکسی_کلاینت_آی‌پی

آدرس IP کلاینت تماس‌گیرنده، که در متغیر جریان proxy.client.ip ذخیره می‌شود. این اغلب آدرس X-Forwarded-For تماس ورودی است که آدرس IP Edge دریافت شده از آخرین TCP handshake خارجی است. این می‌تواند کلاینت تماس‌گیرنده یا یک متعادل‌کننده بار باشد. هنگامی که چندین IP در هدر X-Forwarded-For وجود دارد، این آخرین IP فهرست شده است.

آی‌پی مشتری معرفی‌شده ax_true_client_ip

هنگام استفاده از محصولات مسیریابی مانند Akamai برای ثبت آدرس‌های IP واقعی کلاینت‌ها، True-Client-IP های کلاینت در هدر HTTP به Edge منتقل می‌شوند. این بُعد، IPهای واقعی کلاینت را از آن هدر ثبت می‌کند.

برای تعیین آدرس IP اصلی کلاینت، که از طریق بُعد ax_resolved_client_ip قابل دسترسی است، Edge از بُعدهای ax_true_client_ip و x_forwarded_for_ip استفاده می‌کند.

مسیر درخواست درخواست_مسیر

مسیر منبع (بدون احتساب دامنه) به سرویس هدف، به استثنای پارامترهای پرس و جو.

برای مثال، نمونه‌ی Apigee target به آدرس http://mocktarget.apigee.net شامل چندین منبع از جمله /user است که یک پیام خوشامدگویی برمی‌گرداند. صرف نظر از اینکه پروکسی API شما چگونه http://mocktarget.apigee.net/user را فراخوانی می‌کند، مسیر درخواست /user است.

درخواست آدرس اینترنتی درخواست_یوری

مسیر منبع (به جز دامنه) به سرویس هدف، شامل پارامترهای پرس‌وجو.

برای مثال، هدف نمونه Apigee به نام http://mocktarget.apigee.net شامل چندین منبع از جمله منبع /user?user={name} و پارامتر query برای برگرداندن یک خوشامدگویی سفارشی به نام ارائه شده است. صرف نظر از اینکه پروکسی API شما چگونه http://mocktarget.apigee.net/user?user=Dude را فراخوانی می‌کند، request_uri برابر /user?user=Dude است.

فعل درخواست فعل_درخواست فعل درخواست HTTP در درخواست‌های API، مانند GET، POST، PUT، DELETE.
عامل کاربر کاربر عامل

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

  • یک پیکسل XL در حال برقراری تماس از طریق کروم: Mozilla/5.0 (Linux; Android 7.1.2; Pixel XL Build/NHG47N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.92 Mobile Safari/537.36
  • یک آیپد که از طریق کروم تماس برقرار می‌کند: Mozilla/5.0 (iPad; CPU OS 10_2 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/54.0.2840.91 Mobile/14C92 Safari/602.1
  • cURL از ترمینال: curl/7.51.0
خانواده عامل کاربر ax_ua_agent_family خانواده‌ی عامل استفاده، مانند «Chrome Mobile» یا «cURL».
نوع عامل کاربر ax_ua_agent_type نوع عامل استفاده، مانند «مرورگر»، «مرورگر موبایل»، «کتابخانه» و غیره.
نسخه عامل کاربر ax_ua_agent_version

نسخه عامل کاربری.

استفاده از این به عنوان بُعد دوم «مرور» با User Agent Family (ax_ua_agent_family) برای دریافت نسخه خانواده عامل مفید است.

خروجی/هدف
مسیر پایه هدف target_basepath

مسیر منبع (به جز دامنه) به سرویس هدف، به استثنای پارامترهای پرس و جو، که در <TargetEndpoint> پروکسی تعریف شده است.

برای مثال، فرض کنید یک پروکسی API هدف زیر را فراخوانی می‌کند:

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

در این مثال، target_basepath برابر /user است.

اگر هدف این بود:

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net</URL>
</HTTPTargetConnection>

target_basepath برابر با null خواهد بود.

در ابزار Trace ، وقتی آیکون AX را در انتهای نمودار جریان انتخاب می‌کنید، متغیر جریان target.basepath به بُعد target_basepath نگاشت می‌شود.

میزبان هدف میزبان هدف میزبان سرویس هدف. برای مثال، اگر یک پروکسی API آدرس http://mocktarget.apigee.net/help را فراخوانی کند، میزبان هدف، mocktarget.apigee.net خواهد بود.
آدرس IP هدف target_ip آدرس IP سرویس هدف که پاسخ را به پروکسی API برمی‌گرداند.
کد پاسخ هدف کد پاسخ هدف

کد وضعیت پاسخ HTTP که توسط سرویس هدف به پروکسی API برگردانده می‌شود، مانند ۲۰۰، ۴۰۴، ۵۰۳ و غیره.

مقدار "null" به این معنی است که درخواست هرگز به سرویس هدف نرسیده است. این زمانی اتفاق می‌افتد که پاسخ توسط سیاست Response Cache ارائه شود یا زمانی که در پردازش درخواست خطایی رخ دهد.

این با بُعد کد وضعیت پاسخ (response_status_code) متفاوت است.

آدرس اینترنتی هدف target_url

URL کامل سرویس هدف که در TargetEndpoint یک پروکسی API تعریف شده است.

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

در این مثال، target_url برابر است با http://mocktarget.apigee.net/user?user=Dude .

توجه داشته باشید که URL همچنین می‌تواند در طول پردازش پروکسی API با متغیر جریان target.url لغو شود.

در زنجیره‌سازی پروکسی و هنگام استفاده از اهداف اسکریپت (Node.js) ، target_url در پروکسی فراخوانی‌کننده، null است.

X ارسال شده برای x_forwarded_for_ip

فهرست آدرس‌های IP موجود در هدر X-Forwarded-For .

برای تعیین آدرس IP اصلی کلاینت، که از طریق بُعد ax_resolved_client_ip قابل دسترسی است، Edge از بُعدهای ax_true_client_ip و x_forwarded_for_ip استفاده می‌کند.

زمان
روز هفته روز_هفته_ax مخفف سه حرفی روزهای هفته که فراخوانی‌های API در آن انجام شده است. برای مثال، دوشنبه، سه‌شنبه، چهارشنبه.
ماه ماه_سال ماه عددی که فراخوانی‌های API در آن انجام شده است. برای مثال، "03" برای ماه مارس.
زمان روز ساعت_روز

بر اساس ساعت ۲۴ ساعته، ساعت دو رقمی که فراخوانی‌های API در آن انجام شده است. برای مثال، فراخوانی‌های API که در ساعت بین ۱۰ شب تا ۱۱ شب انجام شده‌اند، ax_hour_of_day برابر با ۲۲ خواهد بود.

مقدار زمان بر حسب UTC است.

منطقه زمانی منطقه زمانی ax_geo نام‌های رایج مناطق زمانی که فراخوانی‌های API از آنجا انجام شده‌اند، مانند America/New_York و Europe/Dublin.
هفته ماه هفته_ماه_مبارک هفته عددی ماه. برای مثال، برای فراخوانی‌های API که در هفته سوم ماه انجام می‌شوند، ax_week_of_month برابر با ۳ است.
مکان
شهر ax_geo_city شهری که فراخوانی‌های API از آنجا انجام شده است.
قاره ax_geo_continent کد دو حرفی قاره‌ای که فراخوانی‌های API از آنجا انجام شده است. برای مثال، NA برای آمریکای شمالی.
کشور ax_geo_country کد دو حرفی کشوری که فراخوانی‌های API از آنجا انجام شده است. برای مثال، US برای ایالات متحده.
منطقه جغرافیایی منطقه جغرافیایی ax کد خط فاصله‌دار برای منطقه جغرافیایی، مانند STATE-COUNTRY. برای مثال، WA-US برای واشنگتن-ایالات متحده.
منطقه ax_dn_region نام مرکز داده Apigee که پروکسی‌های API در آن مستقر هستند، مانند us-east-1.
کسب درآمد
پیام نادیده گرفتن تراکنش مینت x_apigee_mint_tx_ignoreMessage پرچمی که مشخص می‌کند آیا پیام‌های مربوط به کسب درآمد نادیده گرفته شوند یا خیر. برای همه سازمان‌های کسب درآمد، روی false تنظیم کنید.
وضعیت تراکنش‌های مینت وضعیت_نعناع_تکس_آپیجی وضعیت درخواست کسب درآمد، مانند موفقیت‌آمیز، ناموفق، نامعتبر یا هیچکدام.

فیلترها

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

معیارهای مربوط به پروکسی‌های API با نام کتاب‌ها یا موسیقی را برمی‌گرداند:

filter=(apiproxy in 'books','music')

معیارهای مربوط به پروکسی‌های API با نام‌هایی که با "m" شروع می‌شوند را برمی‌گرداند:

filter=(apiproxy like 'm%')

معیارهای مربوط به پروکسی‌های API با نام‌هایی که با "m" شروع نمی‌شوند را برمی‌گرداند:

filter=(apiproxy not like 'm%')

معیارهای مربوط به فراخوانی‌های API با کدهای وضعیت پاسخ بین ۴۰۰ تا ۵۹۹ را برمی‌گرداند:

filter=(response_status_code ge 400 and response_status_code le 599)

معیارهای مربوط به فراخوانی‌های API با کد وضعیت پاسخ ۲۰۰ و کد پاسخ هدف ۴۰۴ را برمی‌گرداند:

filter=(response_status_code eq 200 and target_response_code eq 404)

معیارهای مربوط به فراخوانی‌های API با کد وضعیت پاسخ ۵۰۰ را برمی‌گرداند:

filter=(response_status_code eq 500)

معیارهای مربوط به فراخوانی‌های API که منجر به خطا نشده‌اند را برمی‌گرداند:

filter=(is_error eq 0)

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

اپراتور توضیحات
in در فهرست قرار دهید
notin حذف از لیست
eq مساوی، ==
ne برابر نیست با، !=
gt بزرگتر از، >
lt کمتر از، <
ge بزرگتر یا مساوی، >=
le کمتر یا مساوی، <=
like اگر الگوی رشته با الگوی ارائه شده مطابقت داشته باشد، مقدار true را برمی‌گرداند.
not like اگر الگوی رشته با الگوی ارائه شده مطابقت داشته باشد، مقدار false را برمی‌گرداند.
similar to بسته به اینکه الگوی آن با رشته داده شده مطابقت داشته باشد یا خیر، مقدار درست یا نادرست را برمی‌گرداند. این تابع مشابه like است، با این تفاوت که الگو را با استفاده از تعریف استاندارد SQL از یک عبارت منظم تفسیر می‌کند.
not similar to بسته به اینکه الگوی آن با رشته داده شده مطابقت داشته باشد یا خیر، مقدار false یا true را برمی‌گرداند. این تابع مشابه تابع not like است، با این تفاوت که الگو را با استفاده از تعریف استاندارد SQL از یک عبارت منظم تفسیر می‌کند.
and به شما امکان می‌دهد از منطق «و» برای گنجاندن بیش از یک عبارت فیلتر استفاده کنید. فیلتر شامل داده‌هایی است که تمام شرایط را برآورده می‌کنند.
or به شما امکان می‌دهد از منطق «یا» برای ارزیابی عبارات فیلتر مختلف استفاده کنید. فیلتر شامل داده‌هایی است که حداقل یکی از شرایط را برآورده می‌کنند.