ส่วนขยาย Google Cloud Logging

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

เวอร์ชัน 2.0.2

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

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

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

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

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

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

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

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

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

• หากคุณเป็นลูกค้า Apigee Edge สำหรับ Private Cloud ให้ใช้ API Update organization properties เพื่อตั้งค่าสถานะ features.allowExtensionsInPostClientFlow เป็น true

เกี่ยวกับ Cloud Logging

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

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

ตัวอย่าง

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

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

นโยบายต่อไปนี้จะเขียนข้อความ 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 ได้ที่ การเพิ่มและการกำหนดค่าส่วนขยาย

การดำเนินการ

บันทึก

เขียนข้อความลงในบันทึก

การดำเนินการนี้จะเขียนรายการบันทึกของ 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>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : { "info" :  "This is a test." }
}]]></Input>

พารามิเตอร์คำขอ

การตอบกลับ

None หากมีการเขียนข้อความลงในบันทึก ไม่เช่นนั้น คำขอจะแสดงข้อผิดพลาด ดูเพิ่มเติมที่การแก้ไขข้อบกพร่องของส่วนขยาย

ข้อมูลอ้างอิงการกำหนดค่า

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

คุณสมบัติส่วนขยายทั่วไป

พร็อพเพอร์ตี้ต่อไปนี้มีอยู่ในส่วนขยายทุกรายการ

พร็อพเพอร์ตี้สำหรับแพ็กเกจส่วนขยายนี้

ระบุค่าสำหรับพร็อพเพอร์ตี้การกำหนดค่าต่อไปนี้ที่เฉพาะเจาะจงสำหรับส่วนขยายนี้