שמירה ושיתוף של שאילתות SQL

במאמר הזה מוסבר איך לשמור ולשתף שאילתות שיוצרים ב-Observability Analytics.

במאמר הזה אנחנו מניחים שאתם מכירים את Observability Analytics ויודעים איך להשתמש בדף Observability Analytics כדי לשלוח שאילתות לנתוני היומן שלכם. אם אתם לא מכירים את הנושאים האלה, כדאי לעיין במאמר שאילתות וניתוח של יומנים.

במאמר יצירת תרשים של תוצאות שאילתת SQL מוסבר איך ליצור תרשים של תוצאות השאילתה ואיך לשמור את התרשימים האלה בלוח בקרה בהתאמה אישית.

ההבדל בין שאילתות שמורות לתצוגות ניתוח

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

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

אפשר לשמור שאילתות ששולפות נתונים מתצוגת יומן או מתצוגת ניתוח נתונים.

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

בקטע הזה מתוארים השלבים שצריך להשלים כדי להשתמש ב-Observability Analytics.

הגדרת קטגוריות ביומן

מוודאים ששדרגתם את מאגרי היומנים כדי להשתמש ב-Observability Analytics:

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

   כניסה אל Logs Storage

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

2. לכל קטגוריה ביומן שיש לה תצוגת יומנים שרוצים לשלוח אליה שאילתה, מוודאים שבעמודה Observability Analytics available מופיע הערך Open. אם הכפתור שדרוג מוצג, לוחצים עליו וממלאים את תיבת הדו-שיח.

הגדרת תפקידים והרשאות ב-IAM

בקטע הזה מתוארים התפקידים או ההרשאות של IAM שנדרשים לשימוש ב-Observability Analytics:

• כדי לקבל את ההרשאות שדרושות לשימוש ב-Observability Analytics ולשאילתות של תצוגות יומן, צריך לבקש מהאדמין להקצות לכם את תפקידי ה-IAM הבאים בפרויקט:

  • כדי להריץ שאילתה על מאגרי היומנים _Required ו-_Default: מציג היומנים (roles/logging.viewer)
  • כדי לשלוח שאילתה לכל תצוגות היומן בפרויקט: בעל הרשאת גישה לתצוגת יומנים (roles/logging.viewAccessor)

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

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

• כדי לקבל את ההרשאות שנדרשות לשליחת שאילתות לתצוגות ניתוח נתונים, צריך לבקש מהאדמין להקצות לכם את תפקיד ה-IAM‏ Observability Analytics User (roles/observability.analyticsUser) בפרויקט.

שמירת שאילתה

כל השאילתות שאתם מריצים נשמרות אוטומטית למשך 30 ימים, ואפשר לגשת אליהן דרך הכרטיסייה Recent בדף Observability Analytics. אפשר לחפש, להציג, להריץ ולשתף את השאילתות שמופיעות בכרטיסייה מהזמן האחרון.

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

אפשר לשמור 10,000 שאילתות לכל פרויקט Google Cloud .

המסוף

כדי לשמור שאילתה:

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

   עוברים אל Observability Analytics

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

2. מאכלסים את החלונית שאילתה בשאילתה.

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

   השאילתה יכולה לכלול כל תצוגה תקפה, כמה תצוגות ותצוגות של נתוני Analytics.

   אם השאילתה בחלונית Query (שאילתה) תקינה, הכפתור save Save (שמירה) מופעל.

3. לוחצים על שמירה שמירה, בוחרים באפשרות שמירת שאילתה וממלאים את השדות שם ותיאור. הערכים שאתם מגדירים בשדות האלה מוצגים בכרטיסייה שמורים.

4. אופציונלי: כדי לאפשר לכל מי שיש לו גישה לדף Observability Analytics בתצוגת הפרויקט Google Cloud להריץ את השאילתה השמורה, מפעילים את המתג Share with project.

   כברירת מחדל, המתג הזה מושבת והגישה מוגבלת רק לכם.

5. לוחצים על שמירת השאילתה.

6. אופציונלי: כדי לראות, למיין ולהריץ שאילתות שמורות שגלויות לכם, בוחרים בכרטיסייה שמורות.

   אפשר למיין ולסנן את השאילתות השמורות לפי השם, התיאור ותווית החשיפה שלהן. אפשר גם לסנן לפי תוכן השאילתה.

אתם יכולים לערוך ולמחוק שאילתות שיצרתם באמצעות האפשרויות שבכרטיסייה שמורות:

• כדי לערוך שאילתה, לוחצים על אפשרויות נוספות ובוחרים באפשרות עריכה. אפשר לשנות את הערכים בשדות שם ותיאור, אבל אי אפשר לשנות את השאילתה עצמה.

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

REST

אפשר לשמור שאילתה באמצעות Cloud Logging API. כדי לשמור שאילתה, משתמשים בשיטה savedQueries.create.

כדי להפעיל את השיטה הזו:

1. בוחרים באפשרות savedQueries.create.
2. בדף העזר, משתמשים ב-APIs Explorer כדי להנפיק פקודה. חובה לציין את השדה opsAnalyticsQuery.

בדוגמה הבאה מוצג גוף בקשה לדוגמה, שמכיל מופע של SavedQuery:

{
   "parent": "projects/my-project/locations/global"
   "saved_query":
   {
      "ops_analytics_query":
      {
         "sql_query_text" :
            "SELECT
            timestamp, log_name, severity, json_payload, resource, labels
            FROM
            `VIEW`
            WHERE
            timestamp > TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR)
            ORDER BY timestamp ASC
            LIMIT 100"
      }
   "visibility": "PRIVATE"
   }
}

שיתוף שאילתה

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

המסוף

כשמנסים לפתור בעיה או כשרואים תוצאות חריגות, יכול להיות שתרצו לשתף שאילתה ואת התוצאות שלה עם חבר צוות. כשצופים בתוצאות של שאילתה בדף Observability Analytics, אפשר להעתיק כתובת URL, וכשפותחים אותה מוצגת השאילתה שהפעלתם והתוצאות שלה.

כדי לשתף שאילתה ותוצאות עם חבר צוות:

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

   עוברים אל Observability Analytics

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

2. מאכלסים את החלונית Query בשאילתה ולוחצים על Run query.

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

3. לוחצים על שיתוף הקישור.

4. שולחים את הקישור לחבר הצוות.

   כשחבר הצוות יפתח את הקישור, הדף Observability Analytics ייפתח ויוצג, אבל השאילתה לא תופעל. השותף לצוות צריך להריץ את השאילתה באופן ידני.

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

   כדי שחבר הצוות יוכל לפתוח את כתובת ה-URL, תפקיד ה-IAM שלו בפרויקט Google Cloud צריך לכלול את ההרשאות שנדרשות לצפייה בדף Observability Analytics.

REST

אפשר להשתמש ב-Logging API כדי ליצור שאילתה משותפת באמצעות ה-method‏ savedQueries.Create, ולציין ערך של SHARED בשדה visibility. מידע נוסף זמין בדף העזרה בנושא savedQueries.create.

הצגה והפעלה של שאילתות אחרונות או שמורות

כדי לראות או להריץ מחדש שאילתה, בוחרים בכרטיסייה Recent בדף Observability Analytics ומחפשים את השאילתה:

• כדי להריץ את השאילתה, לוחצים על Run.
• כדי לראות את השאילתה, משתמשים באפשרויות בתפריט אפשרויות נוספות.

כדי להציג, לערוך או להריץ שאילתה שמורה, בוחרים בכרטיסייה Saved (שמורה) בדף Observability Analytics (ניתוח נתונים של יכולת התבוננות) ומחפשים את השאילתה:

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

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

• יצירה של תצוגות ניתוח נתונים והפעלת שאילתות עליהן
• שאילתות SQL לדוגמה
• יצירת תרשים של תוצאות שאילתת SQL
• הרצת שאילתות במערך נתונים מקושר של BigQuery ב-BigQuery