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

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

מידע על Stackdriver Logging

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

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

דוגמאות

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

יומן גלובלי

במדיניות הבאה כתוב "זוהי בדיקה" ליומן שנקרא example-log במשאב Stackdriver 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>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, יש להשתמש באפשרויות הבאות.

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

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

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

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