คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
แล้วเวอร์ชัน 1.6.1
เขียนรายการไปยังบันทึก Cloud Logging
เนื้อหานี้ให้ข้อมูลอ้างอิงสำหรับการกำหนดค่าและใช้ส่วนขยายนี้
ข้อกำหนดเบื้องต้น
ก่อนใช้ส่วนขยายนี้จากพร็อกซี API คุณต้องดำเนินการดังนี้
ใน IAM ให้มอบหมายบทบาทการบันทึก > ผู้เขียนบันทึกให้กับสมาชิกโปรเจ็กต์ซึ่งจะแสดงส่วนขยายไปยังระบบ Cloud Logging โปรดดูวิธีการมอบบทบาทที่หัวข้อการให้บทบาทแก่บัญชีบริการสำหรับทรัพยากรเฉพาะ ดูข้อมูลเพิ่มเติมเกี่ยวกับบทบาทการบันทึกได้ที่คู่มือควบคุมการเข้าถึง
ใช้เนื้อหาของไฟล์ JSON คีย์ที่ได้มาเมื่อเพิ่มและกำหนดค่าส่วนขยายโดยใช้การอ้างอิงการกำหนดค่า
ส่วนขยายนี้สนับสนุนให้เรียกโดยนโยบาย Extensionส่วนขยายไฮไลต์ที่อยู่ใน PostClientFlow
หากต้องการใช้นโยบาย Extension callout เพื่อเรียกใช้ส่วนขยายนี้จาก PostClientFlow โปรดตรวจสอบว่าได้ตั้งค่าแฟล็ก features.allowExtensionsInPostClientFlow
เป็น true
ในองค์กร
หากคุณเป็นลูกค้า Apigee Edge สำหรับระบบคลาวด์สาธารณะ คุณต้องติดต่อทีมสนับสนุนของ Apigee Edge เพื่อให้แน่ใจว่าการตั้งค่าแฟล็ก
features.allowExtensionsInPostClientFlow
เป็นtrue
ในองค์กรของคุณหากคุณเป็น Apigee Edge สำหรับลูกค้าของ Private Cloud ให้ใช้ API อัปเดตพร็อพเพอร์ตี้ขององค์กรเพื่อตั้งค่าแฟล็ก
features.allowExtensionsInPostClientFlow
เป็นtrue
เกี่ยวกับ Cloud Logging
แล้วCloud Logging เป็นส่วนหนึ่งในชุดเครื่องมือการดำเนินการของ Google Cloud ซึ่งประกอบด้วยพื้นที่เก็บข้อมูลสำหรับบันทึก อินเทอร์เฟซผู้ใช้ที่เรียกว่า เครื่องมือสำรวจบันทึก และ API สำหรับจัดการบันทึกแบบเป็นโปรแกรม คุณจะอ่านและเขียนรายการบันทึก ค้นหา และกรองบันทึก ส่งออกบันทึก และสร้างเมตริกตามบันทึกได้ด้วย Cloud Logging
ปัจจุบันส่วนขยาย Cloud Logging จะเขียนรายการลงในบันทึก ดูข้อมูลเพิ่มเติมได้ที่เอกสาร Cloud Logging
ลองฟัง
ตัวอย่างต่อไปนี้จะแสดงวิธีกำหนดค่าการสนับสนุนสำหรับการทำงานของส่วนขยาย Cloud Logging โดยใช้นโยบาย Extension โปรดเลือก
บันทึกส่วนกลาง
นโยบายต่อไปนี้จะเขียนข้อความ This is a test
ลงในบันทึกที่ชื่อว่า example-log
ในทรัพยากรทั่วโลกของ Cloud ในการใช้งานจริง คุณอาจมีข้อความอยู่ในตัวแปรโฟลว์ซึ่งมีค่าที่คุณตั้งไว้ที่อื่นในพร็อกซี 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 โปรดดูการเพิ่มและการกำหนดค่าส่วนขยาย
การดำเนินการ
log
เขียนข้อความไปยังบันทึก
การดำเนินการนี้จะเขียนรายการบันทึก 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>
พารามิเตอร์คำขอ
พารามิเตอร์ | คำอธิบาย | Type | ค่าเริ่มต้น | จำเป็น |
---|---|---|---|---|
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 การจัดการ ค่าดังกล่าวคือค่าที่เข้ารหัสแบบ Base64 ซึ่งสร้างขึ้นจากไฟล์คีย์บัญชีบริการ | ไม่มี | มี |