การอ้างอิงเมตริก มิติข้อมูล และตัวกรองของ Analytics

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X.
ข้อมูล

หัวข้อนี้เป็นข้อมูลอ้างอิงสำหรับเมตริก มิติข้อมูล และตัวกรองของ Analytics สำหรับบริบทเพิ่มเติมเกี่ยวกับ โดยใช้รูปแบบเหล่านี้ โปรดดูภาพรวมการวิเคราะห์ API

หัวข้อนี้แสดงชื่อเมตริกและมิติข้อมูลตามที่ปรากฏใน UI และเป็นไปตามที่คุณต้องการ เพื่อใช้ในการเรียก API

เมตริก

ต่อไปนี้คือเมตริก API ที่คุณดึงข้อมูลในรายงานที่กำหนดเองและการเรียก API การจัดการได้

ชื่อรายงานที่กำหนดเอง ชื่อที่จะใช้ใน API การจัดการ ฟังก์ชัน คำอธิบาย
ธุรกรรมเฉลี่ยต่อวินาที TPU ไม่มี

จำนวนการทำธุรกรรมโดยเฉลี่ย ซึ่งหมายถึงคำขอพร็อกซี API ต่อวินาที โปรดทราบว่าหากคุณมีคำสั่งซื้อที่ค่อนข้างต่ำ จำนวนธุรกรรมในระยะเวลา จำนวนธุรกรรมโดยเฉลี่ยต่อ วินาทีอาจปรากฏเป็น 0 ในรายงานที่กำหนดเองของ UI หากตัวเลขน้อยกว่า 2 หลักทศนิยม

ไวยากรณ์ API: tps

พบแคช cache_hit ผลรวม

จำนวนคำขอ API ที่สำเร็จซึ่งใช้แคชการตอบกลับแทนเมธอด การตอบสนองจากบริการเป้าหมาย

ไวยากรณ์ API: sum(cache_hit)

จำนวนองค์ประกอบแคช L1 ax_cache_l1_count เฉลี่ย, ขั้นต่ำ, สูงสุด

แสดงจำนวนองค์ประกอบในแคช L1 (ในหน่วยความจำ) ต่อธุรกรรมสำหรับ ตัวอย่างเช่น หากคุณเลือก max สำหรับช่วงใดช่วงหนึ่งของวัน และ ภายในวันนั้น จำนวนองค์ประกอบสูงสุดในแคชคือ 12 รายการสำหรับธุรกรรมหนึ่งๆ จํานวนจะเท่ากับ 12 สำหรับ avg หากมีธุรกรรม 3 รายการใน ของระยะเวลาที่คุณค้นหา และจำนวนแคชของการค้นหาคือ 5, 6 และ 7 ซึ่งค่าเฉลี่ยคือ 6 L1 แคชในหน่วยความจำ ไม่ใช่แคชฐานข้อมูล L2 ตามที่อธิบายไว้ในแคชภายใน

ไวยากรณ์ API: avg(ax_cache_l1_count)

ข้อผิดพลาดเกี่ยวกับนโยบาย policy_error ผลรวม

จำนวนข้อผิดพลาดด้านนโยบายทั้งหมดในระยะเวลาที่ระบุ

ข้อผิดพลาดเกี่ยวกับนโยบายมักเกิดขึ้นจากการออกแบบ ตัวอย่างเช่น นโยบายคีย์ API ของ "ยืนยัน" แสดงข้อผิดพลาด ข้อผิดพลาดเมื่อมีการส่งคีย์ API ที่ไม่ถูกต้องในคำขอ และนโยบายการเพิ่มขึ้นของการจับกุม จะแสดงข้อผิดพลาดหากจำนวนการเรียก API เกินขีดจำกัดที่กำหนดไว้ในนโยบาย สไตรค์ เมตริกนี้มีประโยชน์ในการค้นหาจุดที่เป็นปัญหาที่อาจเกิดขึ้นใน API ของคุณ ตัวอย่างเช่น เมตริก policy_error ที่จัดกลุ่มตามมิติข้อมูล developer_app อาจช่วยให้คุณค้นพบ ว่าคีย์ API หรือโทเค็น OAuth สำหรับแอปที่ระบุหมดอายุแล้ว หรือคุณอาจพบว่า พร็อกซี API ที่ระบุแสดงข้อผิดพลาด Spike Arrest จำนวนมาก ทำให้คุณค้นพบว่า ขีดจำกัดการควบคุมที่เพิ่มขึ้นอย่างฉับพลันของพร็อกซีไม่ได้รองรับการเข้าชมที่เพิ่มขึ้นในช่วงเทศกาล

ระบบจะบันทึกข้อผิดพลาดของนโยบายใน Analytics ก็ต่อเมื่อข้อผิดพลาดส่งผลให้พร็อกซี API ล้มเหลว เช่น หากตั้งค่าแอตทริบิวต์ continueOnError ของนโยบายเป็น true พร็อกซี API จะยังคงประมวลผลคำขอต่อไปแม้ว่านโยบายจะล้มเหลว ในกรณีนี้ ข้อผิดพลาดของนโยบายจะไม่ได้รับการบันทึกไว้ในข้อมูลวิเคราะห์

มิติข้อมูลชื่อนโยบายเกี่ยวกับข้อผิดพลาด (ax_execution_fault_policy_name) มีประโยชน์สําหรับ จัดกลุ่มข้อผิดพลาดเกี่ยวกับนโยบายตามชื่อนโยบาย

เป้าหมายที่ไม่สำเร็จ (เช่น 404 หรือ 503) จะไม่นับเป็นความล้มเหลวตามนโยบาย เหล่านั้น นับเป็นความล้มเหลวของพร็อกซี API (is_error)

ไวยากรณ์ API: sum(policy_error)

ข้อผิดพลาดของพร็อกซี is_error ผลรวม

จำนวนครั้งทั้งหมดที่พร็อกซี API ล้มเหลวในระยะเวลาที่ระบุ พร็อกซี การทำงานล้มเหลวอาจเกิดขึ้นเมื่อนโยบายล้มเหลวหรือเมื่อรันไทม์ล้มเหลว เช่น ข้อผิดพลาด 404 หรือ 503 จากบริการเป้าหมาย

มิติข้อมูลพร็อกซี (apiproxy) มีประโยชน์ในการจัดกลุ่มพร็อกซี API ที่ไม่สำเร็จตามพร็อกซี

ไวยากรณ์ API: sum(is_error)

ขอเวลาในการตอบสนองการประมวลผล request_processing_latency เฉลี่ย, ขั้นต่ำ, สูงสุด

ระยะเวลา (เฉลี่ย ต่ำสุด หรือสูงสุด) ในหน่วยมิลลิวินาที ว่า Edge ต้องประมวลผลคำขอที่เข้ามาใหม่ เวลาจะเริ่มต้นเมื่อคำขอถึง Edge และสิ้นสุดเมื่อ Edge ส่งต่อคำขอไปยังบริการเป้าหมาย

คุณสามารถใช้มิติข้อมูลต่างๆ เพื่อตรวจสอบเวลาในการตอบสนองของการประมวลผลคำขอตามพร็อกซี API แอปของนักพัฒนาซอฟต์แวร์ ภูมิภาค และอื่นๆ

ไวยากรณ์ API: max(request_processing_latency)

ขนาดที่มีในคำขอ request_size ผลรวม, เฉลี่ย, ต่ำสุด, สูงสุด

ขนาดของเพย์โหลดคำขอที่ Edge ได้รับในหน่วยไบต์

ไวยากรณ์ API: avg(request_size)

ดำเนินการแคชการตอบกลับแล้ว ax_cache_executed ผลรวม

จำนวนครั้งที่มีการบังคับใช้นโยบายแคชการตอบกลับในช่วงเวลาที่กำหนด 6 เดือน

เนื่องจากมีการแนบนโยบายแคชการตอบกลับไว้ใน 2 ที่ในพร็อกซี API (หนึ่งครั้งใน และเพียงครั้งเดียวในการตอบกลับ) โดยปกติจะทำงาน 2 ครั้งในการเรียก API แคช "get" และ "put" แคช จะนับเป็นการดำเนินการ 1 ครั้ง

แต่การเรียกใช้แคชการตอบกลับจะเป็น 0 หาก <SkipCacheLookup> ในนโยบายประเมินเป็น "จริง" (ในคำขอ) และ 0 หาก วันที่ <SkipCachePopulation> ในนโยบายจะประเมินค่าเป็นจริง (ในการตอบสนอง)

ในเครื่องมือการติดตาม คุณสามารถคลิกไอคอน "แคชการตอบกลับ" ในการเรียก API ที่เรียกใช้ และดู responsecache.executed ตัวแปรโฟลว์เป็น ดูว่ามีการดำเนินการกับแคชหรือไม่ (ค่า 1)

ไวยากรณ์ API: sum(ax_cache_executed)

เวลาในการตอบสนองในการประมวลผลคำตอบ response_processing_latency เฉลี่ย, ขั้นต่ำ, สูงสุด

ระยะเวลา (เฉลี่ย ต่ำสุด หรือสูงสุด) ในหน่วยมิลลิวินาที ว่าต้องใช้ Edge ในการประมวลผลการตอบกลับจาก API เวลาเริ่มต้นเมื่อพร็อกซี API ได้รับ การตอบสนองบริการเป้าหมายและสิ้นสุดเมื่อ Apigee ส่งต่อการตอบกลับไปยังต้นฉบับ ของผู้โทร

คุณใช้มิติข้อมูลต่างๆ เพื่อตรวจสอบเวลาในการตอบสนองของการประมวลผลคำตอบได้โดย API พร็อกซี ภูมิภาค และอื่นๆ

ไวยากรณ์ API: min(response_processing_latency)

ขนาดการตอบกลับ response_size ผลรวม, เฉลี่ย, ต่ำสุด, สูงสุด

ขนาดของเพย์โหลดการตอบกลับที่ส่งกลับไปยังไคลเอ็นต์ใน ไบต์

ไวยากรณ์ API: max(response_size)

ข้อผิดพลาดเป้าหมาย target_error ผลรวม

จำนวนการตอบกลับทั้งหมด 5xx จากบริการเป้าหมาย นี่คือบริการเป้าหมาย ที่ไม่ได้เกิดจาก Apigee

ไวยากรณ์ API: sum(target_error)

เวลาตอบสนองเป้าหมาย target_response_time ผลรวม, เฉลี่ย, ต่ำสุด, สูงสุด

ระยะเวลา (ผลรวม ค่าเฉลี่ย ค่าต่ำสุด หรือสูงสุด) ในหน่วย มิลลิวินาที เพื่อให้เซิร์ฟเวอร์เป้าหมายตอบสนองการเรียก เมตริกนี้ จะบอกให้คุณทราบถึงประสิทธิภาพของเซิร์ฟเวอร์เป้าหมาย เวลาจะเริ่มต้นเมื่อ Edge ส่งต่อคำขอ ไปยังบริการเป้าหมายและสิ้นสุดเมื่อ Edge ได้รับการตอบสนอง

โปรดทราบว่าถ้าการเรียก API ส่งการตอบกลับจากแคช (โดยใช้แคชการตอบกลับ) ตัวอย่างเช่น นโยบาย การโทรจะไม่ถึงบริการเป้าหมาย และไม่มีเป้าหมาย ระบบจะบันทึกเมตริกเวลาในการตอบกลับ

ไวยากรณ์ API: avg(target_response_time)

เวลาในการตอบกลับรวม total_response_time ผลรวม, เฉลี่ย, ต่ำสุด, สูงสุด

ระยะเวลา (ผลรวม ค่าเฉลี่ย ค่าต่ำสุด หรือสูงสุด) ในหน่วย มิลลิวินาที นับตั้งแต่เมื่อ Edge ได้รับคำขอจากลูกค้าจนถึงเมื่อ Edge จะส่งการตอบกลับไปยังไคลเอ็นต์ เวลาจะรวมค่าใช้จ่ายสำหรับเครือข่าย (เช่น เวลาที่ตัวจัดสรรภาระงานและเราเตอร์ใช้ในการทำงาน) การประมวลผลคำขอ เวลาในการตอบสนอง เวลาในการตอบสนองในการประมวลผลการตอบกลับ และเวลาตอบสนองเป้าหมาย (หากระบบแสดงการตอบกลับ) จากบริการเป้าหมายแทนแคช)

คุณสามารถใช้มิติข้อมูลต่างๆ เพื่อตรวจสอบเวลาในการตอบสนองของการประมวลผลตามพร็อกซี API แอปของนักพัฒนาซอฟต์แวร์ ภูมิภาค และอื่นๆ

ไวยากรณ์ API: avg(total_response_time)

การจราจร message_count ผลรวม

จำนวนการเรียก API ทั้งหมดที่ดำเนินการโดย Edge ในระยะเวลาที่ระบุ

ใช้มิติข้อมูลเพื่อจัดกลุ่มจำนวนการเข้าชมในรูปแบบที่มีประโยชน์ต่อคุณมากที่สุด

ไวยากรณ์ API: sum(message_count)

ขนาด

มิติข้อมูลช่วยให้คุณเห็นเมตริกเป็นกลุ่มที่สื่อความหมาย เช่น การดูการเข้าชมทั้งหมด การนับจะมีประสิทธิภาพมากขึ้นเมื่อคุณดูข้อมูลในแอปของนักพัฒนาซอฟต์แวร์หรือพร็อกซี API แต่ละรายการ

ต่อไปนี้คือมิติข้อมูลที่ Apigee ให้ไว้ให้ใช้งานได้ทันที นอกจากนี้ คุณสามารถสร้าง มิติข้อมูลของตัวเอง ตามที่อธิบายไว้ในวิเคราะห์เนื้อหาข้อความ API โดยใช้การวิเคราะห์ที่กำหนดเอง

ชื่อรายงานที่กำหนดเอง ชื่อที่จะใช้ใน API การจัดการ คำอธิบาย
เอนทิตี Apigee
โทเค็นเพื่อการเข้าถึง access_token โทเค็นเพื่อการเข้าถึง OAuth ของผู้ใช้ปลายทาง
ผลิตภัณฑ์ API api_product

ชื่อของผลิตภัณฑ์ API ที่มีพร็อกซี API ที่มีการเรียก หากต้องการ มิติข้อมูลนี้ แอปนักพัฒนาซอฟต์แวร์ที่เรียกใช้จะต้องเชื่อมโยงกับ API อย่างน้อย 1 รายการ ผลิตภัณฑ์ที่มีพร็อกซี API และพร็อกซีที่เรียกใช้จะต้องตรวจสอบ API คีย์หรือโทเค็น OAuth ที่ส่งไปพร้อมกับการเรียก API คีย์หรือโทเค็นเชื่อมโยงกับ API ผลิตภัณฑ์ สำหรับข้อมูลเพิ่มเติม โปรดดู ก่อนอื่น วิธีสร้างข้อมูลวิเคราะห์ที่สมบูรณ์

หากไม่เป็นไปตามเกณฑ์ข้างต้น คุณจะเห็นค่า "(not set)" ดูเพิ่มเติมที่ ค่าเอนทิตี Analytics "(not set)" คืออะไร หมายถึงอะไร

คีย์แคช ax_cache_key

คีย์ที่มีค่าแคชการตอบกลับที่มีการเข้าถึง สำหรับข้อมูลเพิ่มเติมเกี่ยวกับ วิธีสร้างคีย์สำหรับแคชการตอบกลับที่หัวข้อนโยบายแคชการตอบกลับ

ในเครื่องมือการติดตาม เมื่อคุณเลือกนโยบายแคชการตอบกลับที่อ่านหรือเขียนจากแคช คุณจะ จะดูค่านี้ได้ในตัวแปรโฟลว์ responsecache.cachekey

ชื่อแคช ax_cache_name

ชื่อของแคชที่มีคีย์/ค่าที่นโยบายแคชการตอบกลับใช้ นำหน้าด้วย orgName__envName__ เช่น หากองค์กรเป็น "foo" เวลา สภาพแวดล้อมเป็นแบบ "ทดสอบ" และชื่อแคชคือ "myCache" ax_cache_name คือ foo__test__myCache.

ในเครื่องมือการติดตาม เมื่อคุณเลือกนโยบายแคชการตอบกลับ คุณจะเห็นค่านี้ใน responsecache.cachename ตัวแปรโฟลว์

แหล่งที่มาของแคช ax_cache_source

ระดับแคช (ในหน่วยความจำ "L1" หรือฐานข้อมูล "L2") ที่ใช้แคชการตอบกลับ ที่ดึงข้อมูล มิติข้อมูลนี้แสดง "CACHE_MISS" ด้วย เวลาที่ส่งคำตอบจาก กำหนดเป้าหมายแทนแคช (และแคชการตอบสนองมีการรีเฟรชด้วยการตอบสนองเป้าหมาย) หรือเมื่อคีย์แคชในคำขอไม่ถูกต้อง คีย์แคชจะถูกจำกัดไว้ที่ ขนาด 2 KB

ในเครื่องมือการติดตาม เมื่อคุณเลือกนโยบายแคชการตอบกลับ คุณจะเห็นค่านี้ใน responsecache.cachesource ตัวแปรโฟลว์

ดูข้อมูลเพิ่มเติมเกี่ยวกับระดับแคชได้ที่แคชภายใน

Client-ID client_id

คีย์ผู้ใช้ (คีย์ API) ของแอปนักพัฒนาซอฟต์แวร์ที่ทำการเรียก API ไม่ว่าจะผ่าน ในคำขอเป็นคีย์ API หรือรวมไว้ในโทเค็น OAuth

เพื่อให้ได้มิติข้อมูลนี้ คุณต้องกำหนดค่าพร็อกซีที่รับสายเพื่อตรวจสอบ เพื่อรับคีย์ API หรือโทเค็น OAuth ที่ถูกต้อง แอปนักพัฒนาซอฟต์แวร์จะได้รับคีย์ API ซึ่งนำไปใช้เพื่อ สร้างโทเค็น OAuth เมื่อลงทะเบียนแอปใน Edge สำหรับข้อมูลเพิ่มเติม โปรดดู ก่อนอื่น วิธีสร้างข้อมูลวิเคราะห์ที่สมบูรณ์

หากไม่เป็นไปตามเกณฑ์ข้างต้น คุณจะเห็นค่า "(not set)" ดูข้อมูลเพิ่มเติมที่ค่าเอนทิตี Analytics "(not set)" คืออะไร หมายถึงอะไร

แอปนักพัฒนาซอฟต์แวร์ developer_app

แอปของนักพัฒนาซอฟต์แวร์ที่ลงทะเบียน Edge ซึ่งใช้การเรียก API

หากต้องการดูมิติข้อมูลนี้ แอปต้องเชื่อมโยงกับผลิตภัณฑ์ API อย่างน้อย 1 รายการ ที่มีพร็อกซี API ที่กำลังเรียกใช้ และพร็อกซีต้องตรวจหาคีย์ API หรือ โทเค็น OAuth ที่ส่งพร้อมกับการเรียก API คีย์หรือโทเค็นช่วยระบุแอปของนักพัฒนาซอฟต์แวร์ สำหรับ ข้อมูลเพิ่มเติม โปรดดูสิ่งสำคัญก่อน: วิธีสร้างข้อมูลการวิเคราะห์ที่สมบูรณ์

หากไม่เป็นไปตามเกณฑ์ข้างต้น คุณจะเห็นค่า "(not set)" ดูข้อมูลเพิ่มเติมที่ค่าเอนทิตี Analytics "(not set)" คืออะไร หมายถึงอะไร

อีเมลของนักพัฒนาซอฟต์แวร์ developer_email

อีเมลของนักพัฒนาแอปที่ลงทะเบียน Edge ซึ่งแอปทำการเรียก API

หากต้องการดูมิติข้อมูลนี้ นักพัฒนาแอปจะต้องมีแอปที่เชื่อมโยงกับอย่างน้อย 1 รายการ ผลิตภัณฑ์ API ที่มีพร็อกซี API ที่กำลังเรียกใช้ และพร็อกซีต้องตรวจสอบหา คีย์ API หรือโทเค็น OAuth ที่ส่งพร้อมกับการเรียก API คีย์หรือโทเค็นระบุตัวตนนักพัฒนาซอฟต์แวร์ แอป ดูข้อมูลเพิ่มเติมได้ที่ขั้นตอนแรก: วิธีสร้างข้อมูลวิเคราะห์ที่สมบูรณ์

หากไม่เป็นไปตามเกณฑ์ข้างต้น คุณจะเห็นค่า "(not set)" ดูข้อมูลเพิ่มเติมที่ค่าเอนทิตี Analytics "(not set)" คืออะไร หมายถึงอะไร

รหัสนักพัฒนาซอฟต์แวร์ นักพัฒนา

รหัสนักพัฒนาซอฟต์แวร์ Edge ที่ไม่ซ้ำกันซึ่งสร้างขึ้นในรูปแบบ org_name@@@org_name

หากต้องการดูมิติข้อมูลนี้ นักพัฒนาแอปจะต้องมีแอปที่เชื่อมโยงกับอย่างน้อย 1 รายการ ผลิตภัณฑ์ API ที่มีพร็อกซี API ที่กำลังเรียกใช้ และพร็อกซีต้องตรวจหา คีย์ API หรือโทเค็น OAuth ที่ส่งพร้อมกับการเรียก API คีย์หรือโทเค็นจะระบุ ดูข้อมูลเพิ่มเติมได้ที่ขั้นตอนแรก: วิธีสร้างข้อมูลวิเคราะห์ที่สมบูรณ์

หากไม่เป็นไปตามเกณฑ์ข้างต้น คุณจะเห็นค่า "(not set)" ดูข้อมูลเพิ่มเติมที่ค่าเอนทิตี Analytics "(not set)" คืออะไร หมายถึงอะไร

สภาพแวดล้อม สภาพแวดล้อม สภาพแวดล้อม Edge ที่มีการทำให้พร็อกซี API ใช้งานได้ เช่น "ทดสอบ" หรือ "prod"
รหัสข้อผิดพลาดเมื่อเกิดข้อผิดพลาด ax_edge_execution_fault_code

รหัสข้อผิดพลาดของข้อผิดพลาด ดังตัวอย่างต่อไปนี้ messaging.adaptors.http.flow.GatewayTimeout

ชื่อโฟลว์เมื่อมีข้อผิดพลาด ax_execution_fault
  _flow_name

flow ที่มีชื่อในพร็อกซี API ที่ทำให้เกิดข้อผิดพลาด เช่น "PreFlow" "PostFlow" หรือชื่อของขั้นตอนแบบมีเงื่อนไขที่คุณสร้างขึ้น

โปรดทราบว่าชื่อเต็มที่จะใช้ใน API การจัดการคือ ax_execution_fault_flow_name, โดยไม่ต้องขึ้นบรรทัดใหม่

เมื่อไม่มีข้อผิดพลาดเกิดขึ้น คุณจะเห็นค่า "(not set)"

แหล่งข้อมูลโฟลว์ 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. รหัสโฟลว์เกตเวย์มีประโยชน์ในการแยกความแตกต่างของเมตริกใน สถานการณ์ที่มี TPS สูงซึ่งมีมิติข้อมูลอื่นๆ เช่น องค์กร สภาพแวดล้อม และการประทับเวลา จะเหมือนกันในทุกการโทร
องค์กร องค์กร องค์กร Edge ที่มีการทำให้พร็อกซี API ใช้งานได้
ชื่อนโยบายที่มีข้อผิดพลาด ax_execution_fault
  _policy_name

ชื่อของนโยบายที่แสดงข้อผิดพลาดและทำให้การเรียก API ล้มเหลว

โปรดทราบว่าชื่อเต็มที่จะใช้ใน API การจัดการคือ ax_execution_fault_policy_name, โดยไม่ต้องขึ้นบรรทัดใหม่

หากนโยบายแสดงข้อผิดพลาดแต่แอตทริบิวต์รูทของนโยบาย continueOnError ได้รับการตั้งค่าเป็น true โฟลว์พร็อกซี API จะดำเนินต่อไปโดยไม่ล้มเหลว และใช้นโยบาย จะไม่นับความล้มเหลวในมิติข้อมูลนี้

พร็อกซี APIProxy ชื่อเครื่อง (ไม่ใช่ชื่อที่แสดง) ของพร็อกซี API
เส้นทางฐานพร็อกซี proxy_basepath

BasePath ที่กำหนดค่าไว้ในพร็อกซี API ProxyEndpoint เส้นทางฐานไม่มีพารามิเตอร์ โดเมนและพอร์ตของ URL พร็อกซี API ตัวอย่างเช่น ถ้า URL ฐานของพร็อกซี API คือ https://apigeedocs-test.apigee.net/releasenotes/ เส้นทางพื้นฐานคือ /releasenotes

ค่านี้จะเก็บไว้ในตัวแปรโฟลว์ proxy.basepath ด้วย

คำต่อท้ายเส้นทางพร็อกซี proxy_pathsuffix

เส้นทางทรัพยากรที่เพิ่มลงในเส้นทางฐานของพร็อกซี API ตัวอย่างเช่น หากพร็อกซี API URL ฐานคือ https://apigeedocs-test.apigee.net/hello/ และจะทำการเรียกไปยัง https://apigeedocs-test.apigee.net/hello/json เส้นทางเป็น /json

หากไม่มีการใช้พาธัฟฟิกดังกล่าว ค่าจะว่างเปล่า

ค่านี้จะเก็บไว้ในตัวแปรโฟลว์ proxy.pathsuffix ด้วย

การแก้ไขพร็อกซี apiproxy_revision หมายเลขการแก้ไขของพร็อกซี API ที่จัดการการเรียก API ไม่จำเป็นว่า หมายถึงการแก้ไขล่าสุดของพร็อกซี API ถ้าพร็อกซี API มีการแก้ไข 10 ครั้ง ค่าที่ 8 อาจใช้งานได้ในขณะนี้ นอกจากนี้ API อาจมีการปรับแก้หลายเวอร์ชันดังนี้ หากการแก้ไขดังกล่าวมีเส้นทางฐานต่างกัน ตามที่อธิบายไว้ในการทำให้พร็อกซีใช้งานได้ใน UI
IP ของไคลเอ็นต์ที่แก้ไขแล้ว ax_resolved_client_ip

มีที่อยู่ IP ของไคลเอ็นต์ต้นทาง ค่าของ ax_resolved_client_ip จะคำนวณจากค่าใน ax_true_client_ip และ มิติข้อมูล x_forwarded_for_ip รายการ

โปรดทราบว่าเมื่อใช้ผลิตภัณฑ์การกำหนดเส้นทาง เช่น Akamai เพื่อบันทึกที่อยู่ IP ที่แท้จริงของไคลเอ็นต์ ระบบจะส่ง IP ไคลเอ็นต์ไปยัง Edge ในส่วนหัว HTTP True-Client-IP ซึ่งก็คือ แล้วใช้ตั้งค่ามิติข้อมูล 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 เป็นค่าว่าง ตั้งค่า ax_resolved_client_ip เป็น (not set)
  5. หาก ax_true_client_ip เป็นที่อยู่ IP ในเครื่องและ x_forwarded_for_ip เป็นค่าว่าง ตั้งค่า ax_resolved_client_ip เป็น (not set)
รหัสสถานะการตอบกลับ response_status_code รหัสสถานะการตอบกลับ HTTP ที่ส่งต่อจาก Apigee ไปยังไคลเอ็นต์ เช่น 200, 404, 503 และอื่นๆ ใน Edge รหัสสถานะการตอบกลับจากเป้าหมายสามารถเขียนทับได้ด้วย นโยบาย เช่น มอบหมายข้อความ และ Raise Fault ซึ่งทำให้มิติข้อมูลนี้แตกต่างจากโค้ดตอบกลับเป้าหมาย (target_response_code)
โฮสต์เสมือน virtual_host ชื่อของโฮสต์เสมือน มีการเรียก API ไปยัง เช่น องค์กรมีองค์กร โฮสต์เสมือนโดยค่าเริ่มต้น: default (http) และ secure (https)
ขาเข้า/ลูกค้า
ที่อยู่ IP ของไคลเอ็นต์ client_ip ที่อยู่ IP ของระบบที่เข้าถึงเราเตอร์ เช่น ไคลเอ็นต์เดิม (proxy_client_ip) หรือตัวจัดสรรภาระงาน เมื่อมี IP หลายรายการใน ส่วนหัว X-Forwarded-For นี่คือ IP สุดท้ายที่แสดงอยู่
หมวดหมู่อุปกรณ์ ax_ua_device_category ประเภทของอุปกรณ์ที่มีการเรียก API เช่น "แท็บเล็ต" หรือ "สมาร์ทโฟน"
ตระกูลระบบปฏิบัติการ ax_ua_os_family กลุ่มระบบปฏิบัติการของอุปกรณ์ที่โทรออก เช่น "Android" หรือ "iOS"
เวอร์ชันระบบปฏิบัติการ ax_ua_os_version

เวอร์ชันระบบปฏิบัติการของอุปกรณ์ที่โทรออก

การใช้กลยุทธ์นี้เป็น "การเจาะลึก" ครั้งที่ 2 มีประโยชน์ มิติข้อมูลสำหรับกลุ่มระบบปฏิบัติการ (ax_ua_os_family) เพื่อดูเวอร์ชันของระบบปฏิบัติการ

IP ไคลเอ็นต์ของพร็อกซี proxy_client_ip

ที่อยู่ IP ของไคลเอ็นต์การโทรซึ่งจัดเก็บไว้ใน proxy.client.ip ตัวแปรโฟลว์ ซึ่งมักจะเป็นที่อยู่ X-Forwarded-For ของสายโทรเข้า ซึ่งเป็นที่อยู่ IP ที่ Edge ได้รับจากแฮนด์เชค TCP ภายนอกครั้งล่าสุด การดำเนินการนี้อาจ เป็นไคลเอ็นต์การโทรหรือตัวจัดสรรภาระงาน เมื่อมี IP หลายรายการใน ส่วนหัว X-Forwarded-For นี่คือ IP สุดท้ายที่แสดงอยู่

IP ไคลเอ็นต์ที่อ้างอิง ax_true_client_ip

เมื่อใช้ผลิตภัณฑ์การกำหนดเส้นทาง เช่น Akamai เพื่อบันทึกที่อยู่ IP ที่แท้จริงของไคลเอ็นต์ ระบบจะส่ง IP ของไคลเอ็นต์ไปยัง Edge ในส่วนหัว HTTP True-Client-IP ช่วงเวลานี้ จะบันทึก IP ไคลเอ็นต์จริงเหล่านั้นจากส่วนหัวนั้น

หากต้องการระบุที่อยู่ IP ของไคลเอ็นต์เดิม โดยเข้าถึงได้ผ่าน ax_resolved_client_ip Edge จะใช้ ax_true_client_ip และ มิติข้อมูล x_forwarded_for_ip รายการ

เส้นทางคำขอ request_path

เส้นทางทรัพยากร (ไม่รวมโดเมน) ไปยังบริการเป้าหมาย โดยไม่รวมการค้นหา พารามิเตอร์

ตัวอย่างเช่น เป้าหมายตัวอย่างของ Apigee คือ http://mocktarget.apigee.net มีทรัพยากรหลายอย่าง เช่น /user ซึ่งแสดงคำทักทาย ไม่ว่าพร็อกซี API จะเรียก http://mocktarget.apigee.net/user ด้วยวิธีใดก็ตาม request_path คือ /user

URI คำขอ request_uri

เส้นทางทรัพยากร (ไม่รวมโดเมน) ไปยังบริการเป้าหมาย รวมถึงการค้นหาด้วย พารามิเตอร์

ตัวอย่างเช่น เป้าหมายตัวอย่างของ Apigee คือ http://mocktarget.apigee.net มีทรัพยากรหลายอย่าง ซึ่งรวมถึงแหล่งข้อมูลและคำค้นหา /user?user={name} รายการ เพื่อคืนค่าคำทักทายที่กำหนดเองลงในชื่อที่ระบุ ไม่ว่า API ของคุณจะเป็นอย่างไรก็ตาม พร็อกซีเรียก http://mocktarget.apigee.net/user?user=Dude ซึ่ง request_uri คือ /user?user=Dude

คำกริยาคำขอ request_verb กริยาคำขอ HTTP ในคำขอ API เช่น GET, POST, PUT, DELETE
User Agent useragent

ชื่อของ User Agent หรือ Software Agent ที่ใช้เรียก API ตัวอย่าง

  • Pixel XL กำลังโทรออกผ่าน Chrome: 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
  • iPad โทรออกผ่าน Chrome: 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
กลุ่ม User Agent ax_ua_agent_family กลุ่มของ User Agent เช่น "Chrome Mobile" หรือ "cURL"
ประเภท User Agent ax_ua_agent_type ประเภท useragent เช่น "Browser" "เบราว์เซอร์ในอุปกรณ์เคลื่อนที่" "ห้องสมุด" เป็นต้น
เวอร์ชันของ User Agent ax_ua_agent_version

เวอร์ชันของ useragent

การใช้กลยุทธ์นี้เป็น "การเจาะลึก" ครั้งที่ 2 มีประโยชน์ มิติข้อมูลที่มีกลุ่ม User Agent (ax_ua_agent_family) เพื่อรับเวอร์ชันของกลุ่ม Agent

ขาออก/เป้าหมาย
เส้นทางฐานเป้าหมาย 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 จะเป็นค่าว่าง

ในเครื่องมือการติดตาม เมื่อคุณ เลือกไอคอน AX ในตอนท้ายของแผนผังโฟลว์ target.basepath ตัวแปรโฟลว์จะแมปกับ target_basepath ของคุณ

โฮสต์เป้าหมาย target_host โฮสต์ของบริการเป้าหมาย ตัวอย่างเช่น ถ้าพร็อกซี API มีการเรียก http://mocktarget.apigee.net/help, target_host คือ mocktarget.apigee.net
ที่อยู่ IP เป้าหมาย target_ip ที่อยู่ IP ของบริการเป้าหมายที่ส่งคืนการตอบกลับไปยังพร็อกซี API
โค้ดตอบกลับเป้าหมาย target_response_code

รหัสสถานะการตอบกลับ HTTP ที่บริการเป้าหมายแสดงผลไปยังพร็อกซี API เช่น 200, 404, 503 และอื่นๆ

ค่าของ "null" หมายความว่าคำขอไปไม่ถึงบริการเป้าหมาย ซึ่งจะเกิดขึ้นเมื่อ การตอบสนองจะแสดงโดยนโยบายแคชการตอบกลับหรือเมื่อมีความล้มเหลวในคำขอ การประมวลผล

รหัสนี้แตกต่างจากรหัสสถานะการตอบกลับ (response_status_code)

URL เป้าหมาย 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 ตัวแปรโฟลว์

ในพร็อกซี การเชนและเมื่อใช้ script ปลายทาง (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_day_of_week ตัวย่อวัน 3 ตัวอักษรของสัปดาห์ที่มีการเรียก API สำหรับ เช่น จ. อ. พ.
เดือน ax_month_of_year เดือนที่เป็นตัวเลขที่มีการเรียก API เช่น "03" ของเดือนมีนาคม
เวลา ax_hour_of_day

อ้างอิงจากรูปแบบเวลา 24 ชั่วโมง ซึ่งเป็นชั่วโมง 2 หลักที่มีการเรียก API ตัวอย่างเช่น การเรียก API ที่ดำเนินการในชั่วโมงระหว่าง 22:00 น. ถึง 23:00 น. เวลา ax_hours_of_day จะเป็น 22

ค่าเวลาเป็นเวลา UTC

เขตเวลา ax_geo_timezone ชื่อทั่วไปของเขตเวลาที่มีการเรียก API เช่น อเมริกา/New_York และ Europe/Dublin
สัปดาห์ของเดือน ax_week_of_month สัปดาห์ที่เป็นตัวเลขของเดือน เช่น สำหรับการเรียก API ในช่วงสัปดาห์ที่ 3 ของ เดือน โดยที่ ax_week_of_month จะเท่ากับ 3
ตำแหน่ง
เมือง ax_geo_city เมืองที่มีการเรียก API
ทวีป ax_geo_continent รหัสตัวอักษร 2 ตัวของทวีปที่มีการเรียก API ตัวอย่างเช่น NA สำหรับอเมริกาเหนือ
ประเทศ ax_geo_country รหัสแบบ 2 ตัวอักษรของประเทศที่มีการเรียก API เช่น สหรัฐอเมริกา สำหรับสหรัฐอเมริกา
ภูมิภาคทางภูมิศาสตร์ ax_geo_region รหัสขีดกลางสำหรับภูมิภาคทางภูมิศาสตร์ เช่น STATE-COUNTRY ตัวอย่างเช่น WA-US สำหรับวอชิงตัน-สหรัฐอเมริกา
ภูมิภาค ax_dn_region ชื่อของศูนย์ข้อมูล Apigee ที่มีการทำให้พร็อกซี API ใช้งานได้ เช่น us-east-1
การสร้างรายได้
สร้างข้อความละเว้นธุรกรรม x_apigee_mint_tx_ignoreMessage ธงที่ระบุว่าจะไม่สนใจข้อความที่เกี่ยวข้องกับการสร้างรายได้หรือไม่ ตั้งค่าเป็น false สำหรับองค์กรที่สร้างรายได้ทั้งหมด
สถานะธุรกรรม Mint x_apigee_mint_tx_status สถานะของคำขอการสร้างรายได้ เช่น สำเร็จ ล้มเหลว ไม่ถูกต้อง หรือไม่มี

ตัวกรอง

ตัวกรองช่วยให้คุณจำกัดผลลัพธ์ให้เหลือเฉพาะเมตริกที่มีลักษณะเฉพาะบางอย่าง ต่อไปนี้คือบางส่วน ตัวกรองตัวอย่าง ใช้ชื่อรูปแบบ API และเมตริกเมื่อกำหนดตัวกรอง

แสดงผลเมตริกสำหรับพร็อกซี API ที่มีหนังสือชื่อหรือเพลง:

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

แสดงผลเมตริกสำหรับพร็อกซี API ที่มีชื่อที่ขึ้นต้นด้วย "m":

filter=(apiproxy like 'm%')

แสดงผลเมตริกสำหรับพร็อกซี API ที่มีชื่อที่ไม่ได้ขึ้นต้นด้วย "m":

filter=(apiproxy not like 'm%')

แสดงผลเมตริกสำหรับการเรียก API ที่มีรหัสสถานะการตอบสนองระหว่าง 400 ถึง 599 ดังนี้

filter=(response_status_code ge 400 and response_status_code le 599)

แสดงผลเมตริกสำหรับการเรียก API ที่มีรหัสสถานะการตอบสนองเป็น 200 และรหัสตอบกลับเป้าหมายเป็น 404:

filter=(response_status_code eq 200 and target_response_code eq 404)

แสดงผลเมตริกสำหรับการเรียก API ที่มีรหัสสถานะการตอบสนองเป็น 500:

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 ให้คุณใช้ "และ" เพื่อรวมนิพจน์ตัวกรองมากกว่า 1 รายการ ตัวกรอง รวมข้อมูลที่ตรงกับเงื่อนไขทั้งหมด
or ให้คุณใช้ "or" เพื่อประเมินนิพจน์ตัวกรองที่เป็นไปได้แบบต่างๆ ตัวกรอง รวมข้อมูลที่ตรงตามเงื่อนไขอย่างน้อย 1 ข้อ