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

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

גרסה 1.2.1

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

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

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

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

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

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

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

מידע על Stackdriver Logging

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

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

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

דוגמאות

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

יומן גלובלי

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

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

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

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

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