תוסף Google Cloud Logging

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

גרסה 2.0.0

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

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

דוגמאות

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

יומן גלובלי

המדיניות הבאה כותבת את ההודעה 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.

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

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

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

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