תוסף רישום ביומן של 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 של המפתח שנוצר כשמוסיפים ומגדירים את התוסף באמצעות הפניה להגדרות.

התוסף הזה תומך בקריאה על ידי מדיניות 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.

מידע על Stackdriver Logging

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

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

דוגמאות

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

יומן גלובלי

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

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

תשובה

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

הסבר על ההגדרות

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

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

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

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

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