יצירה וניהול של היקפי יומנים

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

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

מידע על היקפי היומן

היקפי יומנים הם משאבים קבועים ברמת הפרויקט שמפרטים קבוצה של משאבים. המשאבים האלה יכולים להיות פרויקטים, תיקיות, ארגונים ותצוגות של יומנים. לדוגמה, אפשר להגדיר אוסף תצוגות יומן (log scope) שמפרט את הפרויקטים שמכילים משאבים שמשמשים לייצור, או אוסף שמפרט את תצוגות היומן שכוללות רשומות ביומן של סוג משאב ספציפי.

כשיוצרים משאב של Google Cloud פרויקט, תיקייה או ארגון, Logging יוצר אוסף תצוגות יומן (log scope) בשם _Default. ההיקף הזה כולל את הפרויקט, התיקייה או הארגון שנוצרו. כשמחפשים משאב שהוא פרויקט, תיקייה או ארגון, התוצאות כוללות את רשומות היומן שמקורן במשאב ואז מאוחסנות בקטגוריה ביומן. Google Cloud קטגוריית היומנים יכולה להיות בכל פרויקט. כשמחפשים פרויקט, התוצאות כוללות גם רשומות ביומן שמועברות לפרויקט על ידי יעד בפרויקט אחר, ואז מאוחסנות בקטגוריית יומנים.

אפשר ליצור היקפי יומן. אפשר גם לערוך ולמחוק את היקפי היומן שיוצרים. עם זאת, אי אפשר לערוך או למחוק את אוסף תצוגות היומן (log scope) שנקרא _Default.

היקף היומן מאפשר לקבוע באילו משאבים יתבצע חיפוש של נתוני יומן בדף Logs Explorer. כשפותחים את הדף הזה ובוחרים אוסף תצוגות יומן (log scope), המערכת מחפשת בדף את המשאבים שמופיעים בהיקף הזה ואז מרעננת את התצוגה.

אפשר גם להשתמש באוסף תצוגות יומן (log scope) כדי לקבוע באילו משאבים חלונית היומנים תחפש נתוני יומן. חלונית יומנים היא ווידג'ט של מרכז בקרה בהתאמה אישית שמציג נתוני יומנים. לכל חלונית של יומנים יש הגדרה משלה, כך שאפשר ליצור לוח בקרה שמכיל כמה חלוניות של יומנים, וכל חלונית מציגה נתוני יומן שונים. מידע נוסף מופיע במאמר הצגת יומנים ושגיאות בלוח בקרה בהתאמה אישית.

בפרויקטים, היקף היומן שמוגדר כברירת מחדל קובע את קבוצת המשאבים שבדף Logs Explorer מתבצע חיפוש כשפותחים אותו. עם זאת, התפקידים שלכם ב-IAM (הפלטפורמה לניהול זהויות והרשאות גישה) במשאבים שחיפשתם והגדרת טווח הזמן קובעים אילו רשומות ביומן יאוחזרו מהאחסון. כשיוצרים פרויקטים, אוסף תצוגות היומן (log scope) שנקרא _Default מוגדר כאוסף תצוגות היומן (log scope) שמוגדר כברירת מחדל. אתם יכולים להגדיר איזה אוסף תצוגות יומן (log scope) יהיה אוסף תצוגות היומן (log scope) שמוגדר כברירת מחדל.

מה ההבדל בין היקפי יומנים לבין אחסון יומנים מרכזי

אחסון מרכזי של יומנים והיקפי יומנים מאפשרים לכם לצפות בנתוני יומנים שמקורם בפרויקטים שונים.

כשמרכזים את האחסון של היומנים, מגדירים את ה-sinks בארגון או בתיקייה כדי לנתב את רשומות היומן למיקום אחסון יחיד. אחסון מרכזי מספק מקום אחד לשאילתות של נתוני יומן, וכך מפשט את השאילתות כשמחפשים מגמות או בודקים בעיות. מבחינת אבטחה, יש גם מיקום אחסון אחד, מה שמפשט את המשימות של אנליסטים בתחום האבטחה.

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

כשפותחים את הדף Logs Explorer, המערכת מריצה שאילתות על המשאבים שמופיעים בהיקף ברירת המחדל של היומן. לכן, כדאי להגדיר את היקף ברירת המחדל כך שבדף יוצגו הנתונים שאתם בדרך כלל רוצים לראות. לדוגמה, אפשר להגדיר את אוסף תצוגות היומן (log scope) של ברירת המחדל להצגת תצוגת יומן, שאחרי שליחת שאילתה עליה מחזירה את נתוני היומן של אפליקציה ב-מרכז האפליקציות.

שיטות מומלצות

היקפי יומנים מאפשרים לכם להגדיר ולשמור הגדרות לשימוש עתידי, ולכן מומלץ ליצור היקפי יומנים להגדרות חיפוש מורכבות.

לדוגמה, נניח שאתם מנסים לפתור בעיה ורוצים לראות את רשומות היומן של כל המכונות הווירטואליות (VM) שבבעלות הצוות שלכם. כדי לבצע את המשימה הזו, אפשר לעשות את הפעולות הבאות:

  1. אתם קובעים שהרשומות ביומן שאתם רוצים לראות מאוחסנות בכמה קטגוריות של יומנים ובכמה פרויקטים. ברוב מאגרי היומנים, יש תצוגת יומן שכוללת את רשומות היומן שרוצים לנתח. אם אין תצוגת יומן, אפשר ליצור אחת.

  2. אתם מחליטים ליצור אוסף תצוגות יומן (log scope) כי אתם צופים שתצטרכו לבצע משימת פתרון בעיות דומה בעתיד.

  3. פותחים את הדף Logs Explorer במסוף Google Cloud ומשתמשים בתפריט Refine scope כדי לבחור את היקף היומן החדש.

  4. בודקים את הרשומות ביומן ומחפשים את המידע שדרוש לפתרון הבעיה שנבדקה.

  5. אחרי שפותרים את הבעיה, משתפים את הסיבה לכשל עם הקולגות. ציינת גם שאתה מצפה לראות כשלים דומים בעתיד, ולכן יצרת אוסף תצוגות יומן (log scope) שיאפשר לך או למי שיחקור את הכשל למצוא במהירות רשומות יומן רלוונטיות.

אפליקציות של מרכז האפליקציות והיקפי יומן

יכול להיות שהאפליקציות שלכם ב-מרכז האפליקציות יכתבו נתוני יומן לכמה פרויקטים. יכול להיות שנתוני היומן מאוחסנים בפרויקט שממנו הם מגיעים, או שאדמין בארגון הגדיר אחסון מרכזי. כדי לראות את נתוני היומן של האפליקציה, צריך ליצור אוסף תצוגות יומן (log scope), להגדיר אותו כך שיציג את הפרויקטים או את תצוגות היומן שבהם מאוחסנים נתוני היומן של האפליקציה, ואז להגדיר אותו כאוסף תצוגות יומן (log scope) שמוגדר כברירת מחדל. כשמשלימים את השלבים האלה, הדף Logs Explorer מציג באופן אוטומטי את הנתונים שנכתבו על ידי האפליקציה, גם אם הנתונים האלה מאוחסנים בפרויקטים שונים או בדלי מרכזי של יומנים.

יוצרים את אוסף תצוגות יומן (log scope) המותאם אישית בפרויקט שממנו תצפו בנתוני היומן. הפרויקט הזה הוא פרויקט המארח או פרויקט הניהול של מרכז האפליקציות. לדוגמה, אם השם המוצג של תיקייה הוא My Folder, אז השם המוצג של פרויקט הניהול של התיקייה הוא My Folder-mp.

מגבלות

  • אי אפשר למחוק או לשנות את אוסף תצוגות היומן (log scope) שנקרא _Default.
  • רק Google Cloud פרויקטים תומכים באוסף תצוגות יומן (log scope) ברירת מחדל.
  • אי אפשר להוסיף תיקיות או ארגונים לאוסף תצוגות יומן (log scope) שמוגדר על ידי המשתמש.
  • היקפי היומן נוצרים במיקום global.

לפני שמתחילים

  1. נכנסים לחשבון Google Cloud . אם אתם משתמשים חדשים ב- Google Cloud, צרו חשבון כדי שתוכלו להעריך את הביצועים של המוצרים שלנו בתרחישים מהעולם האמיתי. לקוחות חדשים מקבלים בחינם גם קרדיט בשווי 300$ להרצה, לבדיקה ולפריסה של עומסי העבודה.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  8. כדי לקבל את ההרשאות שדרושות ליצירה ולהצגה של היקפי יומנים ולהגדרת היקף ברירת המחדל של היומנים, צריך לבקש מהאדמין להקצות לכם את תפקידי ה-IAM הבאים בפרויקט:

    להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.

    התפקידים המוגדרים מראש האלה כוללים את ההרשאות שנדרשות כדי ליצור ולהציג אוספי תצוגות יומן (log scope), וכדי להגדיר את אוסף תצוגות היומן (log scope) של ברירת המחדל. כדי לראות בדיוק אילו הרשאות נדרשות, אפשר להרחיב את הקטע ההרשאות הנדרשות:

    ההרשאות הנדרשות

    כדי ליצור אוספי תצוגות יומן (log scope) ולצפות בהם, וכדי להגדיר את אוסף תצוגות היומן (log scope) שמוגדר כברירת מחדל, נדרשות ההרשאות הבאות:

    • כדי להגדיר את היקף ברירת המחדל של היומן: observability.scopes.{get, update}
    • כדי ליצור ולנהל היקפי יומן: logging.logScopes.{create, delete, get, list, update}

    יכול להיות שתקבלו את ההרשאות האלה באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש אחרים.

  9. צריך לבחור את הכרטיסייה הרלוונטית לאופן שבו תכננתם להשתמש בדוגמאות בדף הזה:

    המסוף

    כשמשתמשים במסוף Google Cloud כדי לגשת לשירותים ולממשקי ה-API, לא צריך להגדיר אימות. Google Cloud

    gcloud

    במסוף Google Cloud , מפעילים את Cloud Shell.

    הפעלת Cloud Shell

    בחלק התחתון של Google Cloud המסוף יתחיל סשן של Cloud Shell ותופיע הודעה של שורת הפקודה. Cloud Shell היא סביבת מעטפת שבה ה-CLI של Google Cloud מותקן ומוגדרים ערכים לפרויקט הקיים. הסשן יופעל תוך כמה שניות.

    Terraform

    כדי להשתמש בסביבת פיתוח מקומית בדוגמאות של Terraform שבדף הזה, מתקינים ומפעילים את ה-CLI של gcloud, ואז מגדירים את Application Default Credentials באמצעות פרטי הכניסה של המשתמש.

    1. התקינו את ה-CLI של Google Cloud.

    2. אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

    3. אם אתם משתמשים במעטפת מקומית, אתם צריכים ליצור פרטי כניסה לאימות מקומי עבור חשבון המשתמש:

      gcloud auth application-default login

      אם אתם משתמשים ב-Cloud Shell, אין צורך לבצע את הפעולה הזו.

      אם מוחזרת שגיאת אימות ואתם משתמשים בספק זהויות חיצוני (IdP), ודאו ש נכנסתם ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

    למידע נוסף, ראו הגדרת ADC לסביבת פיתוח מקומית במאמרי העזרה בנושא אימות Google Cloud .

    REST

    כדי להשתמש בסביבת פיתוח מקומית בדוגמאות של API בארכיטקטורת REST שבדף הזה, צריך להשתמש בפרטי הכניסה שאתם נותנים ל-CLI של gcloud.

      התקינו את ה-CLI של Google Cloud.

      אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

    מידע נוסף מופיע במאמר אימות לשימוש ב-REST במסמכי האימות של Google Cloud .

הצגת היקפי היומן

המסוף

כדי להציג את היקפי היומן:

  1. נכנסים לדף  Settings במסוף Google Cloud :

    עוברים אל הגדרות.

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

  2. בסרגל הכלים של מסוף Google Cloud , בוחרים את הפרויקט, התיקייה או הארגון. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  3. לוחצים על הכרטיסייה היקפי יומן.

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

gcloud

כדי להציג את היקפי היומן בפרויקט, משתמשים בפקודה gcloud logging scopes list:

gcloud logging scopes list --project=PROJECT_ID

לפני שמריצים את הפקודה, מעדכנים את השדות הבאים:

  • PROJECT_ID: מזהה הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.

כדי לקבל את הפרטים של אוסף תצוגות יומן (log scope) בפרויקט, משתמשים בפקודה gcloud logging scopes describe:

gcloud logging scopes describe LOG_SCOPE_ID --project=PROJECT_ID

לפני שמריצים את הפקודה, מעדכנים את השדות הבאים:

  • PROJECT_ID: מזהה הפרויקט.
  • LOG_SCOPE_ID: המזהה של היקף היומן. לדוגמה, my-scope.

Terraform

אפשר להשתמש ב-Terraform כדי ליצור ולשנות אוסף תצוגות יומן (log scope). עם זאת, אי אפשר להשתמש ב-Terraform כדי להציג רשימה של היקפי יומנים.

REST

ה-Cloud Logging API מכיל פקודות שמפרטות את אוספי תצוגות היומן (log scope) במשאב, או שמדווחות על הפרטים של אוסף תצוגות יומן (log scope) ספציפי. לרשימה מלאה של הפקודות, ראו את מאמרי העזרה של ה-API.

בפרויקטים של Google Cloud משתמשים בפקודות הבאות:

בפקודות הקודמות, השדה parent הוא בתחביר הבא:

projects/PROJECT_ID/locations/LOCATION_ID

השדות בביטוי הקודם מייצגים את המשמעויות הבאות:

  • PROJECT_ID: מזהה הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  • הערך של LOCATION_ID חייב להיות global.

יצירת היקף של יומן

אפשר ליצור 100 היקפי יומן לכל פרויקט. אוסף תצוגות יומן (log scope) יכול לכלול סך של 100 תצוגות יומן ופרויקטים, אבל הוא יכול לכלול רק 5 פרויקטים. אי אפשר להוסיף תיקיות או ארגונים לאוסף תצוגות יומן (log scope).

המסוף

כדי ליצור אוסף תצוגות יומן (log scope):

  1. נכנסים לדף  Settings במסוף Google Cloud :

    עוברים אל הגדרות.

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

  2. בסרגל הכלים של מסוף Google Cloud , בוחרים את הפרויקט, התיקייה או הארגון. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  3. לוחצים על הכרטיסייה Log Scopes (היקפי יומן) ואז על Create log scope (יצירת היקף יומן).
  4. כדי להוסיף פרויקט אחד או יותר, לוחצים על הוספת פרויקטים ומשלימים את ההוראות בתיבת הדו-שיח.

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

  5. כדי להוסיף תצוגות יומן אחת או יותר, לוחצים על הוספת תצוגות יומן ומשלימים את תיבת הדו-שיח.

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

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

    אחרי שמוסיפים תצוגת יומן, תפקידי ה-IAM שלכם בתצוגת היומן או בפרויקט שבו מאוחסנת תצוגת היומן קובעים לאילו רשומות ביומן תהיה לכם גישה. מידע נוסף על בקרת גישה לתצוגת יומן

  6. בקטע Name log scope (שם היקף היומן), מזינים את השם והתיאור שרוצים שיוצגו בכרטיסייה Log Scopes (היקפי יומן).

    אי אפשר לשנות את השם של אוסף תצוגות יומן (log scope), והוא חייב להיות ייחודי בפרויקט.

  7. לוחצים על יצירת אוסף תצוגות יומן (log scope).

gcloud

כדי ליצור אוסף תצוגות יומן (log scope) בפרויקט, משתמשים בפקודה gcloud logging scopes create:

gcloud logging scopes create LOG_SCOPE_ID --project=PROJECT_ID \
  --description=DESCRIPTION \
  --resource-names=RESOURCE_NAMES

לפני שמריצים את הפקודה, מעדכנים את השדות הבאים:

  • PROJECT_ID: מזהה הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  • LOG_SCOPE_ID: המזהה של היקף היומן. לדוגמה, my-scope.
  • DESCRIPTION: אופציונלי. תיאור אוסף תצוגות יומן (log scope). התיאור צריך להיות בפורמט של מחרוזת.

  • RESOURCE_NAMES: רשימה מופרדת בפסיקים של השמות המלאים של פרויקטים או תצוגות יומן. לדוגמה, כדי לכלול את my-project בהיקף היומן, מציינים my-project.projects/my-project

Terraform

כדי ללמוד איך להחיל הגדרות ב-Terraform או להסיר אותן, ראו פקודות בסיסיות ב-Terraform. מידע נוסף מופיע במאמרי העזרה על ספק Terraform.

כדי ליצור אוסף תצוגות יומן (log scope) בפרויקט, בתיקייה או בארגון באמצעות Terraform, משתמשים במשאב Terraform‏ google_logging_log_scope.

בפקודה, מגדירים את השדות הבאים:

  • parent: השם המלא של הפרויקט, התיקייה או הארגון. לדוגמה, אפשר להגדיר את השדה הזה לערך "projects/PROJECT_ID", כאשר PROJECT_ID הוא מזהה הפרויקט ב- Google Cloud . בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  • location: מוגדר לערך "global".
  • name: מוגדר לשם המלא של אוסף תצוגות יומן (log scope). בפרויקטים, הפורמט של השדה הזה הוא:

    "projects/PROJECT_ID/locations/global/logScopes/LOG_SCOPE_ID"
    

    בביטוי הקודם, LOG_SCOPE_ID הוא השם של אוסף תצוגות יומן (log scope), כמו 'production'.

  • resource_names: מערך של פרויקטים ותצוגות יומנים, כאשר כל פרויקט ותצוגת יומן מצוינים על ידי השם המלא שלהם.

  • description: תיאור קצר. לדוגמה, 'היקף המשאבים לייצור'.

REST

ב-Cloud Logging API אפשר גם ליצור היקפי יומנים בתיקייה או בארגון. מידע נוסף מופיע במאמרי העזרה של ה-API.

בפרויקטים של Google Cloud , משתמשים בפקודה הבאה:

בפקודות הקודמות, השדה parent הוא בתחביר הבא:

projects/PROJECT_ID/locations/LOCATION_ID

השדות בביטוי הקודם מייצגים את המשמעויות הבאות:

  • PROJECT_ID: מזהה הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  • הערך של LOCATION_ID חייב להיות global.

איך משנים או מוחקים אוסף תצוגות יומן (log scope)

המסוף

כדי לשנות או למחוק אוסף תצוגות יומן (log scope) שאתם או עמיתים שלכם יצרתם:

  1. נכנסים לדף  Settings במסוף Google Cloud :

    עוברים אל הגדרות.

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

  2. בסרגל הכלים של מסוף Google Cloud , בוחרים את הפרויקט, התיקייה או הארגון. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  3. לוחצים על הכרטיסייה היקפי יומן.
  4. מוצאים את היקפי היומן שרוצים לשנות או למחוק, לוחצים על  אפשרויות נוספות, ואז מבצעים אחת מהפעולות הבאות:

    • כדי לשנות את ההיקף, בוחרים באפשרות עריכת ההיקף ומשלימים את תיבת הדו-שיח.
    • כדי למחוק, בוחרים באפשרות מחיקת היקף ומשלימים את תיבת הדו-שיח.

gcloud

כדי לשנות את התיאור של רשימת המשאבים באוסף תצוגות יומן (log scope) בפרויקט, משתמשים בפקודה gcloud logging scopes update:

gcloud logging scopes update LOG_SCOPE_ID --project=PROJECT_ID \
  --description=DESCRIPTION \
  --resource-names=RESOURCE_NAMES

לפני שמריצים את הפקודה, מעדכנים את השדות הבאים:

  • PROJECT_ID: מזהה הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  • LOG_SCOPE_ID: המזהה של היקף היומן. לדוגמה, my-scope.
  • DESCRIPTION: תיאור אוסף תצוגות יומן (log scope). התיאור צריך להיות בפורמט של מחרוזת. אם לא רוצים לשנות את התיאור של אוסף תצוגות יומן (log scope), לא מציינים את השדה הזה.

  • RESOURCE_NAMES: רשימה מופרדת בפסיקים של השמות המלאים של פרויקטים או תצוגות יומן. אם לא רוצים לשנות את רשימת המשאבים, לא מציינים את השדה הזה.

כדי למחוק אוסף תצוגות יומן (log scope) בפרויקט, משתמשים בפקודה gcloud logging scopes delete:

gcloud logging scopes delete LOG_SCOPE_ID --project=PROJECT_ID

לפני שמריצים את הפקודה, מעדכנים את השדות הבאים:

  • PROJECT_ID: מזהה הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  • LOG_SCOPE_ID: המזהה של היקף היומן. לדוגמה, my-scope.

Terraform

כדי ללמוד איך להחיל הגדרות ב-Terraform או להסיר אותן, ראו פקודות בסיסיות ב-Terraform. מידע נוסף מופיע במאמרי העזרה על ספק Terraform.

כדי לשנות את היקף היומן בפרויקט, בתיקייה או בארגון באמצעות Terraform, משתמשים במשאב Terraform‏ google_logging_log_scope.

REST

‫Cloud Logging API מכיל פקודות שיכולות לשנות או למחוק אוסף תצוגות יומן (log scope). לרשימה מלאה של הפקודות, ראו את מאמרי העזרה של ה-API.

בפרויקטים של Google Cloud משתמשים בפקודות הבאות:

בפקודות הקודמות, השדה parent הוא בתחביר הבא:

projects/PROJECT_ID/locations/LOCATION_ID/logScopes/LOG_SCOPE_ID

השדות בביטוי הקודם מייצגים את המשמעויות הבאות:

  • PROJECT_ID: מזהה הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  • הערך של LOCATION_ID חייב להיות global.
  • LOG_SCOPE_ID: המזהה של היקף היומן. לדוגמה, my-scope.

הגדרת אוסף תצוגות יומן (log scope) ברירת המחדל

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

כשיוצרים פרויקט, נוצר אוסף תצוגות יומן (log scope) בשם _Default. ההיקף הזה כולל משאב אחד, שהוא הפרויקט שלכם, והוא מוגדר כהיקף ברירת המחדל של היומן. אם יוצרים פרויקט ולא משנים את היקף ברירת המחדל של היומן, כשפותחים את הדף Logs Explorer, המערכת מחפשת את כל רשומות היומן שמקורן בפרויקט.

אפשר ליצור אוסף תצוגות יומן (log scope) משלכם ולהגדיר אותו כאוסף תצוגות יומן (log scope) ברירת המחדל. היכולת הזו מאפשרת לכם להגדיר באילו משאבים יתבצע החיפוש של רשומות ביומן בדף Logs Explorer.

המסוף

כדי להגדיר את אוסף תצוגות היומן (log scope) שמוגדר כברירת מחדל בפרויקט, מבצעים את הפעולות הבאות:

  1. בסרגל הכלים של מסוף Google Cloud , בוחרים את Google Cloud הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות. . אפשר להגדיר רק את אוסף תצוגות יומן (log scope) ברירת המחדל לפרויקט.

  2. נכנסים לדף  Settings במסוף Google Cloud :

    עוברים אל הגדרות.

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

    דף ההגדרות מכיל כמה כרטיסיות. בכל כרטיסייה מוצגת הגדרת ההיקף של סוג מסוים של טלמטריה.

  3. לוחצים על הכרטיסייה היקפי יומן.

    בכרטיסייה מוצגים אוספי תצוגות היומן הקיימים ולחצן ליצירת אוסף תצוגות יומן מותאם אישית.

  4. מוצאים את אוסף תצוגות היומן (log scope) שרוצים להגדיר כברירת המחדל, לוחצים על  סמל האפשרויות הנוספות ובוחרים באפשרות הגדרה כברירת מחדל.

    היקף היומן שבחרתם מוצג עם סמל ברירת המחדל, .

gcloud

כדי לראות ולעדכן את היקף יכולת התצפית:

  1. כדי לראות את ההגדרות של היקף יכולת התצפית, מריצים את הפקודה gcloud observability scopes describe.

    לפני השימוש בנתוני הפקודה הבאים, צריך להחליף את הנתונים הבאים:

    • OBSERVABILITY_SCOPE_ID: השם של אובייקט Scope. הערך הזה חייב להיות _Default.
    • LOCATION: שדה המיקום צריך להיות מוגדר ל-global.
    • PROJECT_ID: מזהה הפרויקט.

    מריצים את הפקודה gcloud observability scopes describe:

    ‫Linux,‏ macOS או Cloud Shell

    gcloud observability scopes describe OBSERVABILITY_SCOPE_ID \
       --location=LOCATION\
       --project=PROJECT_ID

    ‏Windows (PowerShell)

    gcloud observability scopes describe OBSERVABILITY_SCOPE_ID `
       --location=LOCATION`
       --project=PROJECT_ID

    Windows‏ (cmd.exe)

    gcloud observability scopes describe OBSERVABILITY_SCOPE_ID ^
       --location=LOCATION^
       --project=PROJECT_ID

    התגובה לפקודה תהיה דומה לזו:

    logScope: logging.googleapis.com/projects/my-project/locations/global/logScopes/_Default
    traceScope: projects/my-project/locations/global/traceScopes/_Default
    name: projects/my-project/locations/global/scopes/_Default
    
  2. כדי לעדכן את היקף יכולת התצפית, מריצים את הפקודה gcloud observability scopes update. בפקודה update אפשר לכלול את הדגל --log-scope, את הדגל --trace-scope או את שני הדגלים.

    לפני השימוש בנתוני הפקודה הבאים, צריך להחליף את הנתונים הבאים:

    • OBSERVABILITY_SCOPE_ID: השם של אובייקט Scope. הערך הזה חייב להיות _Default.
    • LOG_SCOPE_FQN_ID: שם המשאב המלא של אוסף תצוגות יומן (log scope). השדה הזה הוא בפורמט הבא:
      logging.googleapis.com/projects/PROJECT_ID/locations/LOCATION/logScopes/LOG_SCOPE_ID

      בביטוי הקודם, LOG_SCOPE_ID הוא המזהה של אוסף תצוגות יומן (log scope). לדוגמה, my-scope.

    • TRACE_SCOPE_FQN_ID: שם המשאב המלא של היקף המעקב. השדה הזה הוא בפורמט הבא:
      projects/PROJECT_ID/locations/LOCATION/traceScopes/TRACE_SCOPE_NAME

      בביטוי הקודם, TRACE_SCOPE_NAME הוא השם של היקף המעקב. לדוגמה, my-trace-scope.

    • LOCATION: שדה המיקום צריך להיות מוגדר ל-global.
    • PROJECT_ID: מזהה הפרויקט.

    מריצים את הפקודה gcloud observability scopes update:

    ‫Linux,‏ macOS או Cloud Shell

    gcloud observability scopes update OBSERVABILITY_SCOPE_ID \
       --log-scope=LOG_SCOPE_FQN_ID\
       --trace-scope=TRACE_SCOPE_FQN_ID\
       --location=LOCATION\
       --project=PROJECT_ID

    ‏Windows (PowerShell)

    gcloud observability scopes update OBSERVABILITY_SCOPE_ID `
       --log-scope=LOG_SCOPE_FQN_ID`
       --trace-scope=TRACE_SCOPE_FQN_ID`
       --location=LOCATION`
       --project=PROJECT_ID

    Windows‏ (cmd.exe)

    gcloud observability scopes update OBSERVABILITY_SCOPE_ID ^
       --log-scope=LOG_SCOPE_FQN_ID^
       --trace-scope=TRACE_SCOPE_FQN_ID^
       --location=LOCATION^
       --project=PROJECT_ID

    לדוגמה, אם הערך של LOG_SCOPE_ID הוא my-log-scope והערך של TRACE_SCOPE_NAME הוא my-trace-scope, התגובה תהיה דומה לזו:

    Updated scope [_Default].
    logScope: logging.googleapis.com/projects/my-project/locations/global/logScopes/my-log-scope
    traceScope: projects/my-project/locations/global/traceScopes/my-trace-scope
    name: projects/my-project/locations/global/scopes/_Default
    

Terraform

אפשר להשתמש ב-Terraform כדי ליצור ולשנות אוסף תצוגות יומן (log scope). עם זאת, אי אפשר להשתמש ב-Terraform כדי להגדיר את אוסף תצוגות היומן (log scope) שמוגדר כברירת מחדל.

REST

כדי לקבל ולהגדיר את אוסף תצוגות יומן (log scope) ברירת המחדל או את היקף ברירת המחדל של יומן מעקב באמצעות קריאה ל-API, צריך להגדיר את היקף ניראות (observability). בהיקף הניראות מפורטים אוסף תצוגות יומן (log scope) ברירת המחדל והיקף ברירת המחדל של המעקב:

  • כדי לקבל את היקף ברירת המחדל של יכולת הצפייה בפרויקט, שולחים בקשה לנקודת הקצה projects.locations.scopes.get. חובה לציין פרמטר של נתיב. התגובה היא אובייקט Scope שמפרט את אוסף תצוגות היומן (log scope) שמוגדר כברירת מחדל ואת היקף המעקב שמוגדר כברירת מחדל.
  • כדי לעדכן את היקף ברירת המחדל של יכולת הצפייה בפרויקט, שולחים בקשה לנקודת הקצה projects.locations.scopes.patch. צריך לציין פרמטר של נתיב, פרמטרים של שאילתה ולספק אובייקט Scope. פרמטרים של שאילתה מזהים אילו שדות משתנים. התגובה היא אובייקט Scope.

פרמטר הנתיב בשתי נקודות הקצה הוא מהצורה הבאה:

projects/PROJECT_ID/locations/LOCATION/scopes/OBSERVABILITY_SCOPE_ID

השדות בביטוי הקודם מייצגים את המשמעויות הבאות:

  • PROJECT_ID: מזהה הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  • LOCATION: שדה המיקום צריך להיות מוגדר ל-global.
  • OBSERVABILITY_SCOPE_ID: השם של אובייקט Scope. הערך בשדה הזה חייב להיות _Default. האובייקט Scope עם השם _Default, שנוצר באופן אוטומטי, מאחסן מידע על אוסף תצוגות יומן (log scope) ברירת המחדל ועל היקף ברירת המחדל של המעקב.

כדי לשלוח פקודה לנקודת קצה ל-API, אפשר להשתמש ב-APIs Explorer, שמאפשר לשלוח פקודה מדף הפניה. לדוגמה, כדי לקבל את היקף ברירת המחדל הנוכחי, אפשר לבצע את הפעולות הבאות:

  1. לוחצים על projects.locations.scopes.get.
  2. בווידג'ט Try this method (כדאי לנסות את השיטה הזו), מזינים את הפרטים הבאים בשדה name (שם):
        projects/PROJECT_ID/locations/global/scopes/_Default
        

    לפני שמעתיקים את השדה הקודם, מחליפים את PROJECT_ID בשם הפרויקט.

  3. לוחצים על Execute.
  4. בתיבת הדו-שיח של ההרשאה, משלימים את השלבים הנדרשים.

    התגובה אמורה להיראות כך:

        {
        "name": "projects/my-project/locations/global/scopes/_Default",
        "logScope": "logging.googleapis.com/projects/my-project/locations/global/logScopes/_Default"
        "traceScope": "projects/my-project/locations/global/traceScopes/_Default"
        }
        

המאמרים הבאים