คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่
เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล
เวอร์ชัน 1.6.0
เขียนรายการลงในบันทึก Cloud Logging
เนื้อหานี้มีข้อมูลอ้างอิงสำหรับการกำหนดค่าและการใช้ส่วนขยายนี้
ข้อกำหนดเบื้องต้น
ก่อนใช้ส่วนขยายนี้จากพร็อกซี API คุณต้องทำดังนี้
ใน IAM ให้กำหนดการบันทึก > บทบาทผู้เขียนบันทึกสำหรับสมาชิกโปรเจ็กต์ที่จะแสดงส่วนขยายไปยังระบบ Cloud Logging ดูวิธีการมอบบทบาทได้ที่การมอบบทบาทให้กับบัญชีบริการสำหรับทรัพยากรเฉพาะ ดูข้อมูลเพิ่มเติมเกี่ยวกับบทบาทการบันทึกได้ที่คู่มือการควบคุมการเข้าถึง
ใช้เนื้อหาของไฟล์ JSON คีย์ที่ได้เมื่อเพิ่มและกำหนดค่าส่วนขยายโดยใช้ข้อมูลอ้างอิงการกำหนดค่า
ส่วนขยายนี้สนับสนุนการเรียกใช้โดยนโยบายส่วนขยายไฮไลต์ของส่วนขยายที่อยู่ใน PostClientFlow
หากคุณต้องการใช้นโยบายส่วนขยายไฮไลต์ของส่วนขยายเพื่อเรียกใช้ส่วนขยายนี้จาก
PostClientFlow โปรดตรวจสอบว่าfeatures.allowExtensionsInPostClientFlow
แฟล็ก
ได้รับการตั้งค่าเป็น true
ในองค์กรของคุณ
หากคุณเป็นลูกค้า Apigee Edge สำหรับ Public Cloud คุณต้องติดต่อทีมสนับสนุนของ Apigee Edge เพื่อตรวจสอบให้แน่ใจว่า มีการตั้งค่าแฟล็ก
features.allowExtensionsInPostClientFlow
เป็นtrue
ในองค์กรของคุณหากคุณเป็นลูกค้า Apigee Edge สำหรับ Private Cloud ให้ใช้ อัปเดตพร็อพเพอร์ตี้ขององค์กร API เพื่อตั้งค่าแฟล็ก
features.allowExtensionsInPostClientFlow
เป็นtrue
เกี่ยวกับ Cloud Logging
Cloud Logging เป็นส่วนหนึ่งของ ชุดเครื่องมือการดำเนินการ ประกอบด้วยพื้นที่เก็บข้อมูลสำหรับบันทึก ซึ่งเป็นอินเทอร์เฟซผู้ใช้ชื่อ สำรวจ และ API เพื่อจัดการบันทึกแบบเป็นโปรแกรม Cloud Logging จะช่วยให้คุณสามารถทำสิ่งต่อไปนี้ อ่านและเขียนรายการบันทึก ค้นหาและกรองบันทึก ส่งออกบันทึก และ สร้างเมตริกตามบันทึก
ขณะนี้ส่วนขยาย Cloud Logging จะเขียนรายการลงในบันทึก สำหรับข้อมูลเพิ่มเติม ดูเอกสาร Cloud Logging
ตัวอย่าง
ตัวอย่างต่อไปนี้แสดงวิธีกำหนดค่าการสนับสนุนสำหรับ Cloud Logging การดำเนินการกับส่วนขยายโดยใช้นโยบาย ชิ้นงานข้อความไฮไลต์
บันทึกส่วนกลาง
นโยบายต่อไปนี้จะเขียนข้อความ This is a test
ไปยังบันทึกที่ชื่อว่า
example-log
ในทรัพยากร Cloud Global ในการใช้งานจริง คุณอาจ
ให้ข้อความนี้อยู่ในตัวแปรโฟลว์ซึ่งมีค่าที่คุณตั้งค่าไว้ที่อื่น
ในพร็อกซี API
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Logging-Extension">
<DisplayName>Logging Connector</DisplayName>
<Connector>cloud-extension-sample</Connector>
<Action>log</Action>
<Input><![CDATA[{
"logName": "example-log",
"metadata": {
"resource": {
"type": "global",
"labels": {
"project_id": "my-test"
}
}
},
"message": "This is a test."
}]]></Input>
</ConnectorCallout>
เนื้อหานี้มีข้อมูลอ้างอิงสำหรับการกำหนดค่าและการใช้ส่วนขยายนี้ โปรดดูขั้นตอนการกำหนดค่าส่วนขยายโดยใช้คอนโซล Apigee ที่หัวข้อ การเพิ่มและกำหนดค่าส่วนขยาย
การทำงาน
บันทึก
เขียนข้อความไปยังบันทึก
การดำเนินการนี้จะเขียนรายการบันทึก Cloud Logging รายการบันทึกประกอบด้วยข้อมูลเมตา
และข้อมูลเข้าสู่ระบบ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับรายการบันทึกที่หัวข้อ
ข้อมูลอ้างอิงรายการ
สำหรับข้อมูลเกี่ยวกับเนื้อหาในพร็อพเพอร์ตี้ metadata
โปรดดู
LogEntry
ในเอกสาร Cloud Logging
ไวยากรณ์
<Action>log</Action>
<Input><![CDATA[{
"logName" : "cloud-log-name-to-use",
"metadata" : JSON-structured-metadata,
"message" : "data-to-log-as-entry"
}]]></Input>
ตัวอย่าง: สตริง
<Action>log</Action>
<Input><![CDATA[{
"logName" : "example-log",
"metadata" : { "resource" : { "type" : "global" } },
"message": "This is a test."
}]]></Input>
ตัวอย่าง: JSON
<Action>log</Action>
<Input><![CDATA[{
"logName" : "example-log",
"metadata" : { "resource" : { "type" : "global" } },
"message" : { "info" : "This is a test." }
}]]></Input>
พารามิเตอร์คำขอ
พารามิเตอร์ | คำอธิบาย | ประเภท | ค่าเริ่มต้น | ต้องระบุ |
---|---|---|---|---|
logName |
ชื่อของบันทึกที่มีรายการนี้ | สตริง | ไม่มี | ใช่ |
metadata |
ข้อมูลเมตาเกี่ยวกับรายการบันทึก ดูข้อมูลเพิ่มเติมและตัวเลือกเกี่ยวกับการตั้งค่า type และ labels ใน metadata ได้ที่ MonitoredResource |
JSON | ไม่มี | ไม่ได้ |
message |
ข้อมูลที่จะใช้เป็นค่าสำหรับรายการบันทึกนี้ คุณจะระบุสตริงแบบง่ายหรือใช้ JSON เพื่อบันทึกข้อความที่มีโครงสร้างมากขึ้นก็ได้ | สตริงหรือ JSON | ไม่มี | ใช่ |
คำตอบ
None
หากมีการเขียนข้อความในบันทึก มิฉะนั้น คำขอจะแสดงข้อผิดพลาด โปรดดูเพิ่มเติมที่การแก้ไขข้อบกพร่องของส่วนขยาย
ข้อมูลอ้างอิงการกำหนดค่า
ใช้สิ่งต่อไปนี้เมื่อคุณกำหนดค่าและทำให้ส่วนขยายนี้ใช้งานได้เพื่อใช้ในพร็อกซี API
คุณสมบัติทั่วไปของส่วนขยาย
พร็อพเพอร์ตี้ต่อไปนี้มีอยู่ในส่วนขยายทุกรายการ
พร็อพเพอร์ตี้ | คำอธิบาย | ค่าเริ่มต้น | ต้องระบุ |
---|---|---|---|
name |
ชื่อที่คุณกําหนดให้การกําหนดค่านี้ของส่วนขยาย | ไม่มี | ได้ |
packageName |
ชื่อแพ็กเกจส่วนขยายที่ระบุโดย Apigee Edge | ไม่มี | ได้ |
version |
หมายเลขเวอร์ชันของแพ็กเกจส่วนขยายที่คุณกําหนดค่าส่วนขยาย | ไม่มี | ได้ |
configuration |
ค่าการกําหนดค่าเฉพาะสําหรับส่วนขยายที่คุณกําลังเพิ่ม ดูพร็อพเพอร์ตี้สําหรับแพ็กเกจส่วนขยายนี้ | ไม่มี | ได้ |
พร็อพเพอร์ตี้ของแพ็กเกจส่วนขยายนี้
ระบุค่าสำหรับพร็อพเพอร์ตี้การกำหนดค่าต่อไปนี้เฉพาะสำหรับส่วนขยายนี้
พร็อพเพอร์ตี้ | คำอธิบาย | ค่าเริ่มต้น | ต้องระบุ |
---|---|---|---|
projectId |
รหัสโปรเจ็กต์ Google Cloud ที่ควรสร้างบันทึก | ไม่มี | ใช่ |
credentials |
เมื่อป้อนในคอนโซล Apigee Edge นี่จะเป็นเนื้อหาในไฟล์คีย์บัญชีบริการของคุณ เมื่อส่งผ่าน API การจัดการ ค่านี้จะเป็นค่าที่เข้ารหัสฐาน 64 ซึ่งสร้างขึ้นจากไฟล์คีย์บัญชีบริการ | ไม่มี | ใช่ |