תוסף Google Cloud Logging

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

גרסה 2.0.2

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

התוכן הזה מספק הפניה להגדרת התוסף הזה ולשימוש בו.

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

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

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

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

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

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

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

• אם אתם לקוחות של Apigee Edge לענן פרטי, אתם יכולים להשתמש ב-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 proxy.

<?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, צריך להשתמש בפרטים הבאים.

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

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

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

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