ส่วนขยาย Google Cloud Logging

คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X
info

เวอร์ชัน 2.0.0

เขียนรายการลงในบันทึกของ Cloud Logging

เนื้อหานี้ให้ข้อมูลอ้างอิงสำหรับการกำหนดค่าและการใช้ส่วนขยายนี้

ข้อกำหนดเบื้องต้น

คุณต้องดำเนินการต่อไปนี้ก่อนใช้ส่วนขยายนี้จากพร็อกซี API

  1. ใน IAM ให้มอบหมายบทบาท Logging > Logs Writer ให้กับสมาชิกโปรเจ็กต์ที่จะแสดงส่วนขยายของคุณในระบบการบันทึก Cloud ดูวิธีการมอบบทบาทได้ที่การมอบบทบาทให้กับบัญชีบริการสําหรับทรัพยากรที่เฉพาะเจาะจง ดูข้อมูลเพิ่มเติมเกี่ยวกับบทบาทการบันทึกได้ที่คำแนะนำเกี่ยวกับการควบคุมการเข้าถึง

  2. ใช้คอนโซล Google Cloud เพื่อสร้างคีย์สำหรับบัญชีบริการ

  3. ใช้เนื้อหาของไฟล์คีย์ JSON ที่ได้เมื่อเพิ่มและกําหนดค่าส่วนขยายโดยใช้ข้อมูลอ้างอิงการกําหนดค่า

ส่วนขยายนี้รองรับการเรียกใช้โดยนโยบาย ExtensionCallout ซึ่งอยู่ใน PostClientFlow หากต้องการใช้นโยบาย ExtensionCallout เพื่อเรียกใช้ชิ้นงานนี้จาก PostClientFlow ให้ตรวจสอบว่าได้ตั้งค่า Flag features.allowExtensionsInPostClientFlow เป็น true ในองค์กรแล้ว

  • หากคุณเป็นลูกค้า Apigee Edge สําหรับระบบคลาวด์สาธารณะ คุณต้องติดต่อทีมสนับสนุนของ Apigee Edge เพื่อตรวจสอบว่าได้ตั้งค่า Flag features.allowExtensionsInPostClientFlow เป็น true ในองค์กรแล้ว

  • หากคุณเป็นลูกค้า Apigee Edge สําหรับระบบคลาวด์ส่วนตัว ให้ใช้ API อัปเดตพร็อพเพอร์ตี้องค์กรเพื่อตั้งค่า Flag features.allowExtensionsInPostClientFlow เป็น true

เกี่ยวกับ Cloud Logging

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

ขณะนี้ส่วนขยาย Cloud Logging เขียนรายการลงในบันทึก ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบของ Cloud Logging

ตัวอย่าง

ตัวอย่างต่อไปนี้แสดงวิธีกำหนดค่าการรองรับการดำเนินการของส่วนขยายการบันทึกในระบบคลาวด์โดยใช้นโยบาย ExtensionCallout

บันทึกส่วนกลาง

นโยบายต่อไปนี้จะเขียนข้อความ 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>

ตัวอย่าง: String

<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 เนื้อหาของไฟล์คีย์บัญชีบริการจะเป็นดังนี้ เมื่อส่งผ่าน Management API ค่าจะเป็นค่าที่เข้ารหัส Base64 ที่สร้างขึ้นจากไฟล์คีย์ของบัญชีบริการ ไม่มี ใช่