ส่วนขยาย Google Cloud Logging

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

เวอร์ชัน 1.6.7

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

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

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

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

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

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

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

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

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

• หากคุณเป็นลูกค้า Apigee Edge สำหรับระบบคลาวด์ส่วนตัว ให้ใช้ API อัปเดตพร็อพเพอร์ตี้ขององค์กร เพื่อตั้งค่าแฟล็ก 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 ในทรัพยากรที่เข้าถึงได้ทั่วโลกของระบบคลาวด์ ในการใช้งานจริง คุณอาจเก็บข้อความไว้ในตัวแปรโฟลว์ซึ่งคุณตั้งค่าไว้ที่อื่นในพร็อกซี 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

พร็อพเพอร์ตี้ส่วนขยายทั่วไป

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

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

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