במאמר הזה מוסבר איך לשמור ולשתף שאילתות שיוצרים ב-Observability Analytics. אם אתם לא מכירים את Observability Analytics, תוכלו לעיין במאמר בנושא שאילתות וניתוח של נתוני מעקב.
מידע על יצירת תרשימים של שאילתות או על שליחת שאילתות לנתוני המעקב ב-BigQuery זמין במסמכים שמפורטים בקטע השלבים הבאים במסמך הזה.
לפני שמתחילים
- נכנסים לחשבון Google Cloud . אם אתם משתמשים חדשים ב- Google Cloud, צרו חשבון כדי שתוכלו להעריך את הביצועים של המוצרים שלנו בתרחישים מהעולם האמיתי. לקוחות חדשים מקבלים בחינם גם קרדיט בשווי 300$ להרצה, לבדיקה ולפריסה של עומסי העבודה.
-
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 theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
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 theserviceusage.services.enablepermission. Learn how to grant roles.-
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 theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
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 theserviceusage.services.enablepermission. Learn how to grant roles.-
כדי לקבל את ההרשאות שדרושות לטעינת הדף Observability Analytics, לכתיבה, להרצה ולשמירה של שאילתות פרטיות בנתוני המעקב, צריך לבקש מהאדמין להקצות לכם את תפקידי ה-IAM הבאים:
- Observability View Accessor (
roles/observability.viewAccessor) בתצוגות הניראות שרוצים לשלוח אליהן שאילתות. התפקיד הזה תומך בתנאי IAM, שמאפשרים להגביל את ההרשאה לתצוגה ספציפית. אם לא מצרפים תנאי להענקת התפקיד, לחשבון המשתמש תהיה גישה לכל תצוגות הנתונים של יכולת התצפית. - Observability Analytics User (
roles/observability.analyticsUser) on your project. התפקיד הזה כולל את ההרשאות שנדרשות לשמירה ולהרצה של שאילתות פרטיות, ולהרצה של שאילתות משותפות. - מציג היומנים (
roles/logging.viewer) בפרויקט.
להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.
יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.
- Observability View Accessor (
שמירת שאילתה
כל השאילתות שאתם מריצים נשמרות אוטומטית למשך 30 ימים, ואפשר לגשת אליהן דרך הכרטיסייה Recent בדף Observability Analytics. אפשר לחפש, להציג, להריץ ולשתף את השאילתות שמופיעות בכרטיסייה מהזמן האחרון.
אם רוצים לשמור שאילתה לשימוש עתידי, אפשר להוסיף לה הערות עם מידע שימושי או לאפשר לחברי הצוות לצפות בה ולהריץ אותה. אתם יכולים לחפש ולמיין את השאילתות השמורות לפי השם, התיאור ותווית החשיפה שלהן. אפשר גם לערוך ולמחוק את השאילתות האלה. שאילתות ששומרים נשמרות עד שמוחקים אותן.
אפשר לשמור 10,000 שאילתות לכל פרויקט Google Cloud .
המסוף
כדי לשמור שאילתה:
-
נכנסים לדף manage_search Observability Analytics במסוף Google Cloud :
עוברים אל Observability Analytics
אם משתמשים בסרגל החיפוש כדי למצוא את הדף הזה, בוחרים בתוצאה שכותרת המשנה שלה היא Logging.
מאכלסים את החלונית שאילתה בשאילתה.
אפשר לאכלס את החלונית שאילתה על ידי הזנת שאילתה חדשה, בחירת שאילתה מהכרטיסייה אחרונים או בחירת שאילתה מהכרטיסייה שמורות.
השאילתה יכולה לכלול כל תצוגה תקפה, כמה תצוגות ותצוגות של נתוני Analytics.
אם השאילתה בחלונית Query (שאילתה) תקינה, הכפתור Save (שמירה) מופעל.
לוחצים על שמירה, בוחרים באפשרות שמירת שאילתה וממלאים את השדות שם ותיאור. הערכים שאתם מגדירים בשדות האלה מוצגים בכרטיסייה שמורים.
אופציונלי: כדי לאפשר לכל מי שיש לו גישה לדף Observability Analytics בתצוגת הפרויקט Google Cloud להריץ את השאילתה השמורה, מפעילים את המתג Share with project.
כברירת מחדל, המתג הזה מושבת והגישה מוגבלת רק לכם.
לוחצים על שמירת השאילתה.
אופציונלי: כדי לראות, למיין ולהריץ שאילתות שמורות שגלויות לכם, בוחרים בכרטיסייה שמורות.
אפשר למיין ולסנן את השאילתות השמורות לפי השם, התיאור ותווית החשיפה שלהן. אפשר גם לסנן לפי תוכן השאילתה.
אתם יכולים לערוך ולמחוק שאילתות שיצרתם באמצעות האפשרויות שבכרטיסייה שמורות:
כדי לערוך שאילתה, לוחצים על more_vert אפשרויות נוספות ובוחרים באפשרות עריכה. אפשר לשנות את הערכים בשדות שם ותיאור, אבל אי אפשר לשנות את השאילתה עצמה.
כדי למחוק שאילתה שמורה, לוחצים על more_vert אפשרויות נוספות ובוחרים באפשרות מחיקה.
REST
אפשר לשמור שאילתה באמצעות Cloud Logging API. כדי לשמור שאילתה, משתמשים בשיטה savedQueries.create.
כדי להפעיל את השיטה הזו:
- בוחרים באפשרות
savedQueries.create. - בדף העזר, משתמשים ב-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, וכשפותחים אותה מוצגת השאילתה שהפעלתם והתוצאות שלה.
כדי לשתף שאילתה ותוצאות עם חבר צוות:
-
נכנסים לדף manage_search Observability Analytics במסוף Google Cloud :
עוברים אל Observability Analytics
אם משתמשים בסרגל החיפוש כדי למצוא את הדף הזה, בוחרים בתוצאה שכותרת המשנה שלה היא Logging.
מאכלסים את החלונית Query בשאילתה ולוחצים על Run query.
אפשר לאכלס את החלונית שאילתה על ידי הזנת שאילתה חדשה, בחירת שאילתה מהכרטיסייה אחרונים או בחירת שאילתה מהכרטיסייה שמורות.
לוחצים על link שיתוף הקישור.
שולחים את הקישור לחבר הצוות.
כשחבר הצוות יפתח את הקישור, הדף 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.
- כדי לראות את השאילתה, משתמשים באפשרויות בתפריט more_vert אפשרויות נוספות.
כדי להציג, לערוך או להריץ שאילתה שמורה, בוחרים בכרטיסייה Saved (שמורה) בדף Observability Analytics (ניתוח נתונים של יכולת התבוננות) ומחפשים את השאילתה:
- כדי להריץ את השאילתה, לוחצים על Run.
- כדי לערוך, לראות או למחוק את השאילתה, משתמשים באפשרויות בתפריט more_vert אפשרויות נוספות.