ส่วนขยาย Google Stackdriver Logging

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

เวอร์ชัน 1.3.7

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

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

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

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

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

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

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

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

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

  • หากคุณเป็นลูกค้า Apigee Edge สำหรับ Private Cloud ให้ใช้ อัปเดตพร็อพเพอร์ตี้ขององค์กร API เพื่อตั้งค่าแฟล็ก features.allowExtensionsInPostClientFlow เป็น true

เกี่ยวกับ Stackdriver Logging

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

ส่วนขยายนี้จะเขียนรายการลงในบันทึกอยู่ในขณะนี้ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเอกสารการบันทึกสแต็ก

ตัวอย่าง

ตัวอย่างต่อไปนี้แสดงวิธีกำหนดค่าการสนับสนุนสำหรับการดำเนินการของส่วนขยาย Stackdriver Logging โดยใช้นโยบาย ส่วนขยายข้อความไฮไลต์

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

นโยบายต่อไปนี้จะเขียนข้อความ "นี่คือการทดสอบ" ไปยังบันทึกที่ชื่อว่า example-log ในทรัพยากร Stackdriver 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>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" : "stackdriver-log-name-to-use",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : "data-to-log-as-entry"
}]]></Input>

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

พารามิเตอร์ คำอธิบาย ประเภท ค่าเริ่มต้น ต้องระบุ
logName ชื่อของบันทึกที่มีรายการนี้ สตริง ไม่มี ได้
ข้อมูลเมตา ข้อมูลเมตาเกี่ยวกับรายการบันทึก
ดูข้อมูลเพิ่มเติมและตัวเลือกเกี่ยวกับการตั้งค่า type และ labels ใน metadata ได้ที่ MonitoredResource
JSON ไม่มี ไม่
ข้อความ ข้อมูลที่จะใช้เป็นค่าสำหรับรายการบันทึกนี้ สตริง ไม่มี ได้

คำตอบ

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

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

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

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

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

พร็อพเพอร์ตี้ คำอธิบาย ค่าเริ่มต้น ต้องระบุ
name ชื่อที่คุณกําหนดให้การกําหนดค่านี้ของส่วนขยาย ไม่มี ได้
packageName ชื่อแพ็กเกจส่วนขยายที่ระบุโดย Apigee Edge ไม่มี ได้
version หมายเลขเวอร์ชันของแพ็กเกจส่วนขยายที่คุณกําหนดค่าส่วนขยาย ไม่มี ได้
configuration ค่าการกําหนดค่าเฉพาะสําหรับส่วนขยายที่คุณกําลังเพิ่ม ดูพร็อพเพอร์ตี้สําหรับแพ็กเกจส่วนขยายนี้ ไม่มี ได้

พร็อพเพอร์ตี้ของแพ็กเกจส่วนขยายนี้

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

พร็อพเพอร์ตี้ คำอธิบาย ค่าเริ่มต้น ต้องระบุ
projectId รหัสโปรเจ็กต์ GCP ที่ควรสร้างบันทึก ไม่มี ได้
ข้อมูลเข้าสู่ระบบ เมื่อป้อนในคอนโซล Apigee Edge นี่จะเป็นเนื้อหาในไฟล์คีย์บัญชีบริการของคุณ เมื่อส่งผ่าน API การจัดการ ค่านี้จะเป็นค่าที่เข้ารหัสฐาน 64 ซึ่งสร้างขึ้นจากไฟล์คีย์บัญชีบริการ ไม่มี ได้