คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ
Apigee X info
เวอร์ชัน 1.2.1
เขียนรายการไปยังบันทึกของ Stackdriver Logging
เนื้อหานี้เป็นข้อมูลอ้างอิงสำหรับการกำหนดค่าและการใช้ส่วนขยายนี้
ข้อกำหนดเบื้องต้น
ก่อนใช้ส่วนขยายนี้จากพร็อกซี API คุณต้องดำเนินการต่อไปนี้
ใน IAM ให้กำหนดสิทธิ์ Logging > Logs Writer ให้กับสมาชิกโปรเจ็กต์ที่จะเป็นตัวแทนของส่วนขยายในระบบ Stackdriver Logging ดูวิธีการให้บทบาทได้ที่การให้บทบาทแก่บัญชีบริการสำหรับทรัพยากรที่เฉพาะเจาะจง ดูข้อมูลเพิ่มเติมเกี่ยวกับบทบาทการบันทึกได้ที่คำแนะนำการควบคุมการเข้าถึง
ใช้เนื้อหาของไฟล์ JSON คีย์ที่ได้เมื่อเพิ่มและกำหนดค่าส่วนขยายโดยใช้ข้อมูลอ้างอิงการกำหนดค่า
เกี่ยวกับ Stackdriver Logging
Stackdriver Logging เป็นส่วนหนึ่งของชุดผลิตภัณฑ์ Stackdriver ใน Google Cloud Platform (GCP) ซึ่งประกอบด้วยพื้นที่เก็บข้อมูลสำหรับบันทึก อินเทอร์เฟซผู้ใช้ที่เรียกว่าตัวแสดงบันทึก และ API สำหรับจัดการบันทึกแบบเป็นโปรแกรม Stackdriver Logging ช่วยให้คุณอ่านและเขียนรายการบันทึก ค้นหาและกรองบันทึก ส่งออกบันทึก และสร้างเมตริกตามบันทึกได้
ขณะนี้ส่วนขยายนี้จะเขียนรายการลงในบันทึก
ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบของ Stackdriver Logging
ตัวอย่าง
ตัวอย่างต่อไปนี้แสดงวิธีกำหนดค่าการรองรับการดำเนินการของส่วนขยาย Stackdriver Logging โดยใช้นโยบาย ExtensionCallout
บันทึกส่วนกลาง
นโยบายต่อไปนี้จะเขียนข้อความ "นี่คือการทดสอบ" ลงในบันทึกที่ชื่อ example-log ในทรัพยากรส่วนกลางของ Stackdriver ในการใช้งานจริง คุณอาจมีข้อความอยู่ในตัวแปรโฟลว์ที่มีค่าที่คุณตั้งไว้ที่อื่นในพร็อกซี 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>stackdriver-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 ได้ที่การเพิ่มและการกำหนดค่าส่วนขยาย
การดำเนินการ
บันทึก
เขียนข้อความลงในบันทึก
การดำเนินการนี้จะเขียนรายการบันทึกของ Stackdriver รายการบันทึกประกอบด้วยข้อมูลเมตาและข้อมูลรายการ ดูข้อมูลเพิ่มเติมเกี่ยวกับรายการบันทึกได้ที่ข้อมูลอ้างอิงรายการ ดูข้อมูลเกี่ยวกับเนื้อหาของพร็อพเพอร์ตี้ metadata ได้ที่ออบเจ็กต์ LogEntry ในเอกสารประกอบของ Stackdriver Logging
ไวยากรณ์
<Action>log</Action>
<Input><![CDATA[{
"logName" : "stackdriver-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 | ชื่อของบันทึกซึ่งเป็นที่เก็บรายการนี้ | สตริง | ไม่มี | ได้ |
| ข้อมูลเมตา | ข้อมูลเมตาเกี่ยวกับรายการบันทึก ดูข้อมูลเพิ่มเติมและตัวเลือกในการตั้งค่า type และ labels ใน metadata ได้ที่ MonitoredResource |
JSON | ไม่มี | ไม่ |
| ข้อความ | ข้อมูลที่จะใช้เป็นค่าสำหรับรายการบันทึกนี้ คุณสามารถระบุสตริงอย่างง่ายหรือใช้ JSON เพื่อบันทึกข้อความที่มีโครงสร้างมากขึ้น | สตริงหรือ JSON | ไม่มี | ได้ |
การตอบกลับ
ไม่มี หากมีการเขียนข้อความลงในบันทึก ไม่เช่นนั้น คำขอจะแสดงข้อผิดพลาด ดูเพิ่มเติมที่การแก้ไขข้อบกพร่องของส่วนขยาย
ข้อมูลอ้างอิงการกำหนดค่า
ใช้ข้อมูลต่อไปนี้เมื่อกำหนดค่าและติดตั้งใช้งานส่วนขยายนี้เพื่อใช้ในพร็อกซี API
คุณสมบัติส่วนขยายทั่วไป
พร็อพเพอร์ตี้ต่อไปนี้มีอยู่ในส่วนขยายทุกรายการ
| พร็อพเพอร์ตี้ | คำอธิบาย | ค่าเริ่มต้น | ต้องระบุ |
|---|---|---|---|
name |
ชื่อที่คุณกําหนดให้การกําหนดค่านี้ของส่วนขยาย | ไม่มี | ได้ |
packageName |
ชื่อแพ็กเกจส่วนขยายที่ระบุโดย Apigee Edge | ไม่มี | ได้ |
version |
หมายเลขเวอร์ชันของแพ็กเกจส่วนขยายที่คุณกําหนดค่าส่วนขยาย | ไม่มี | ได้ |
configuration |
ค่าการกําหนดค่าเฉพาะสําหรับส่วนขยายที่คุณกําลังเพิ่ม ดูพร็อพเพอร์ตี้สําหรับแพ็กเกจส่วนขยายนี้ | ไม่มี | ได้ |
พร็อพเพอร์ตี้สำหรับแพ็กเกจส่วนขยายนี้
ระบุค่าสำหรับพร็อพเพอร์ตี้การกำหนดค่าต่อไปนี้ที่เฉพาะเจาะจงสำหรับส่วนขยายนี้
| พร็อพเพอร์ตี้ | คำอธิบาย | ค่าเริ่มต้น | ต้องระบุ |
|---|---|---|---|
| projectId | รหัสโปรเจ็กต์ GCP ที่ควรสร้างบันทึก | ไม่มี | ได้ |
| ข้อมูลเข้าสู่ระบบ | เมื่อป้อนในคอนโซล Apigee Edge นี่คือเนื้อหาของไฟล์คีย์บัญชีบริการ เมื่อส่งผ่าน Management API ค่าจะเป็นค่าที่เข้ารหัส Base64 ซึ่งสร้างจากไฟล์คีย์บัญชีบริการ | ไม่มี | ได้ |