תוסף רישום ביומן של Google Stackdriver

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

גרסה 1.3.7

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

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

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

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

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

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

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

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

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

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

מידע על Stackdriver Logging

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

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

טעימות

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

יומן גלובלי

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

פעולות

log

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

הפעולה הזו כותבת רשומה ביומן של 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>

פרמטרים של בקשה

תשובה

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

סימוכין לתצורה

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

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

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

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

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