ส่วนขยาย Google Stackdriver Logging

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

เวอร์ชัน 1.2.0

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

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

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

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

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

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

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

เกี่ยวกับ Stackdriver Logging

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

ขณะนี้ส่วนขยายนี้เขียนรายการลงในบันทึก

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบของ Stackdriver Logging

ตัวอย่าง

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

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

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