תוסף 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 ב-Public Cloud, עליכם לפנות לתמיכה של Apigee Edge כדי לוודא שהדגל features.allowExtensionsInPostClientFlow מוגדר בתור true בארגון שלכם.

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

מידע על Cloud Logging

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

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

טעימות

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

יומן גלובלי

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

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

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

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

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