תוסף Google Cloud Logging

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

גרסה 1.6.1

כותבים רשומות ביומני Cloud Logging.

התוכן הזה כולל חומר עזר להגדרת התוסף הזה ולשימוש בו.

דרישות מוקדמות

לפני שמשתמשים בתוסף הזה משרת proxy ל-API, צריך:

1. ב-IAM, מקצים את הפקודה Logging > תפקיד Logs Writer אצל חבר הפרויקט שייצג את התוסף שלך במערכת Cloud Logging. במאמר הקצאת תפקידים לחשבון שירות למשאבים ספציפיים מוסבר איך מקצים תפקידים. מידע נוסף על תפקידי רישום ביומן זמין במדריך לבקרת גישה.

2. משתמשים במסוף Google Cloud כדי ליצור מפתח לחשבון השירות.

3. משתמשים בתוכן של קובץ ה-JSON של המפתח שנוצר כשמוסיפים ומגדירים את התוסף באמצעות קובץ התצורה.

אפשר להפעיל את התוסף הזה באמצעות מדיניות תוסף יתרונות מרכזיים שנמצאת ב-PostClientFlow. אם ברצונך להשתמש במדיניות בנושא יתרונות מרכזיים של תוסף כדי להפעיל את התוסף הזה PostClientFlow, יש לוודא שהדגל features.allowExtensionsInPostClientFlow הערך שהוגדר הוא true בארגון שלך.

• אם אתם לקוחות של Apigee Edge לענן ציבורי, עליכם לפנות לתמיכה של Apigee Edge כדי לוודא הדגל features.allowExtensionsInPostClientFlow מוגדר לערך true בארגון שלך.

• אם אתם לקוחות של Apigee Edge לענן פרטי, API לעדכון מאפייני הארגון כדי להגדיר את הדגל features.allowExtensionsInPostClientFlow ל-true.

מידע על Cloud Logging

Cloud Logging הוא חלק . הוא כולל אחסון ליומנים, ממשק משתמש שנקרא 'יומנים' וממשק API לניהול יומנים באופן פרוגרמטי. בעזרת Cloud Logging תוכלו לקרוא ולכתוב רשומות ביומן, לחפש ולסנן את היומנים, לייצא את היומנים, יצירת מדדים מבוססי יומנים.

כרגע התוסף של Cloud Logging כותב רשומות ביומן. לקבלת מידע נוסף, כדאי לעיין במסמכי Cloud Logging.

דוגמאות

הדוגמאות הבאות ממחישות איך להגדיר תמיכה ב-Cloud Logging פעולות של תוספים באמצעות המדיניות בנושא יתרונות מרכזיים של תוספים.

יומן גלובלי

לפי המדיניות הבאה, ההודעה This is a test נכתבת ביומן שנקרא example-log במשאב Cloud Global. בשימוש בפועל, סביר להניח להכיל את ההודעה במשתנה זרימה, שאת הערך שלו הגדרתם במקום אחר ב-Proxy ל-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 הוספה והגדרה של תוסף

פעולות

log

כותב הודעה ביומן.

הפעולה הזו תכתוב רשומה ביומן של 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 אם ההודעה נכתבה ביומן. אחרת, הבקשה תחזיר שגיאה. אפשר לקרוא מידע נוסף בקטע ניפוי באגים בתוסף.

מסמך עזר בנושא הגדרות אישיות

כשאתם מגדירים ופורסים את התוסף הזה לשימוש בשרתי proxy ל-API, יש להשתמש באפשרויות הבאות.

מאפייני תוספים נפוצים

המאפיינים הבאים קיימים בכל תוסף.

מאפיינים של חבילת התוספים הזו

יש לציין ערכים למאפיינים הבאים של הגדרות אישיות שספציפיים לתוסף הזה.