הגדרת מדדי מונה

במאמר הזה מוסבר איך ליצור מדד מבוסס-יומן מסוג מונה באמצעות מסוף Google Cloud‏, Logging API ו-Google Cloud CLI. Google Cloud

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

לסקירה כללית של מדדים מבוססי-יומנים, ראו סקירה כללית של מדדים מבוססי-יומנים.

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

1. כדי להשתמש במדדים מבוססי-יומן, צריך Google Cloud פרויקט שמופעל בו חיוב:

   נכנסים לחשבון 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 the resourcemanager.projects.create permission. Learn how to grant roles.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

   Verify that billing is enabled for your Google Cloud project.

   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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

   Verify that billing is enabled for your Google Cloud project.

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

יצירת מדד מבוסס-יומן מסוג מונה

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

אל תכללו מידע רגיש במסנן. מסננים נחשבים לנתוני שירות.

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

המסוף

כדי ליצור מדד של מונה במסוףGoogle Cloud בפרויקט Google Cloud :

1. נכנסים לדף Log-based Metrics במסוף Google Cloud :

   כניסה אל מדדים מבוססי-יומנים

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

2. לוחצים על יצירת מדד. החלונית Create logs metric (יצירת מדד של יומנים) מופיעה.

3. מגדירים את סוג המדד: בוחרים באפשרות מונה.

4. מגדירים את השדות הבאים בקטע פרטים:

   • שם המדד מבוסס-היומן: בוחרים שם ייחודי בין המדדים מבוססי-היומן בפרויקט Google Cloud . יש הגבלות מסוימות על שמות. פרטים נוספים זמינים במאמר פתרון בעיות.
   • תיאור: מזינים תיאור למדד.
   • יחידות: משאירים את השדה הזה ריק או מזינים את הספרה 1.

5. מגדירים את מסנן המדדים בקטע Filter selection.

   1. בתפריט Select project or log bucket בוחרים אם המדד יספור את רשומות היומן בפרויקט Google Cloud או רק את רשומות היומן בקטגוריה ביומן ספציפית.

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

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

6. (אופציונלי) מוסיפים תווית בקטע Labels (תוויות). הוראות ליצירת תוויות זמינות במאמר יצירת תווית.

7. לוחצים על יצירת מדד כדי ליצור את המדד.

gcloud

אפשר ליצור מדד מבוסס-יומן ללא תוויות מותאמות אישית באמצעות הפקודה הבאה:

gcloud logging metrics create METRIC_NAME \
  --description="METRIC_DESCRIPTION" \
  --log-filter="FILTER" \
  [--bucket-name="BUCKET_NAME"]

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

לדוגמה, הפקודה הבאה יוצרת מדד מבוסס-יומן ברמת הפרויקט בשם error_count.

gcloud logging metrics create error_count \
     --description "Errors in syslog." \
     --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR"

כדי ליצור מדד מבוסס-יומן עם היקף קטגוריה, צריך לספק את הדגל --bucket_name:

gcloud logging metrics create error_count \
    --description "Errors in syslog." \
    --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR" \
    --bucket-name projects/my-project/locations/global/buckets/my-test-bucket

הוראות ליצירת תוויות מופיעות במאמר הגדרת תוויות במדדים מבוססי-יומן.

API

כדי ליצור מדד מסוג מונה, משתמשים ב-method‏ projects.metrics.create של Logging API. אם משתמשים בחלונית APIs Explorer בדף ההפניה, צריך להכין את הארגומנטים באופן הבא:

1. מגדירים את השדה parent לפרויקט או לקטגוריה שבהם רוצים ליצור את המדד:

   • כדי להגדיר מדד מבוסס-יומן ברמת הפרויקט, מציינים את הפרויקט:

   projects/PROJECT_ID
   

   • כדי להגדיר מדד מבוסס-יומן שמוגבל לקטגוריה, מציינים את הקטגוריה:

   projects/PROJECT_ID/locations/LOCATION/bucket/BUCKET_ID
   

2. מגדירים את גוף הבקשה לאובייקט LogMetric. זוהי דוגמה לאובייקט של מדד מסוג מונה:

   {
     name:        "my-metric"
     description: "This is my metric."
     filter:      "resource.type=gce_instance AND log_id(\"syslog\")",
     metricDescriptor: {
         labels: [
           {
             key: "my-label",
             valueType: STRING,
             description: "This is my label.",
           }
         ]
     },
     labelExtractors: {
       "my-label":
         "REGEXP_EXTRACT(jsonPayload.someField, \"before ([0-9]+) after\")",
       ...
     },
   }
   

הערות:

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

• במדדי מונה, השדות LogMetric,‏ valueExtractor ו-bucketOptions לא רלוונטיים ומושמטים.

• אם למדד שלכם אין תוויות, אפשר להשמיט את השדות metricDescriptor ו-labelExtractors. אם למדד יש תוויות, כדאי לעיין במאמר תוויות של מדדים מבוססי-יומן כדי לקבל מידע על תוויות ועל יצירת תוויות ב-API.

פרטים נוספים זמינים במאמר בנושא סוג LogMetric.

השהיה של מדדים חדשים

המדד החדש יופיע מיד ברשימת המדדים בכלי Logs Explorer ובקטגוריות הרלוונטיות בתפריט Monitoring. הנתונים בדרך כלל זמינים תוך פחות מדקה.

בדיקת מדדים מבוססי-יומנים

כדי להציג את רשימת המדדים מבוססי-היומן שהוגדרו על ידי המשתמש בפרויקט Google Cloud או כדי לבדוק מדד מסוים בפרויקט Google Cloud :

המסוף

1. נכנסים לדף Log-based Metrics במסוף Google Cloud :

   כניסה אל מדדים מבוססי-יומנים

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

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

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

gcloud

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

gcloud logging metrics list

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

gcloud logging metrics describe METRIC_NAME

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

gcloud logging metrics --help

אי אפשר לקרוא נתונים של סדרת זמן של מדד מ-Google Cloud CLI.

API

רשימת מדדים

כדי להציג את המדדים מבוססי-היומן שהוגדרו על ידי המשתמש בפרויקט Google Cloud , משתמשים בשיטת ה-API‏ projects.metrics.list. ממלאים את הפרמטרים של השיטה באופן הבא:

• ‫parent: שם המשאב של Google Cloud הפרויקט: projects/PROJECT_ID.
• ‫pageSize: המספר המקסימלי של התוצאות.
• ‫pageToken: אחזור הדף הבא של התוצאות. מידע על השימוש באסימוני דפים זמין במאמר projects.metrics.list.

אחזור הגדרות של מדדים

כדי לאחזר מדד יחיד מבוסס-יומן שהוגדר על ידי המשתמש, משתמשים ב-method ‏projects.metrics.get של API. ממלאים את הפרמטרים של השיטה באופן הבא:

• ‫metricName: שם המשאב של המדד:

  projects/PROJECT_ID/metrics/METRIC_ID
  

קריאת נתוני מדדים

כדי לקרוא את נתוני סדרת הזמנים במדד מבוסס-יומן, משתמשים ב-projects.timeseries.list ב-Cloud Monitoring API. לפרטים על נתוני סדרות זמנים, ראו קריאת סדרות זמנים.

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

logging.googleapis.com/user/METRIC_ID

עדכון מדדים מבוססי-יומנים

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

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

כדי לערוך מדד מבוסס-יומן:

המסוף

1. נכנסים לדף Log-based Metrics במסוף Google Cloud :

   כניסה אל מדדים מבוססי-יומנים

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

2. לוחצים על עריכת מדד בתפריט של המדד מבוסס-היומן שרוצים לשנות.

3. לשנות את הפריטים המותרים במדד.

4. לוחצים על עדכון המדד.

gcloud

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

gcloud logging update METRIC_NAME \
  --description="METRIC_DESCRIPTION" \
  --log-filter="FILTER" \
  --bucket-name=BUCKET_NAME

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

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

כדי לעדכן מדדי הפצה או שדות אחרים של מדדי מונה, לא כולל METRIC_NAME, יוצרים קובץ שמכיל את המפרט המתוקן של LogMetric בפורמט JSON או YAML. לאחר מכן, מעדכנים את המדד באמצעות הפעלת הפקודה update עם השדה ‎--config-from-file, ומחליפים את FILENAME בשם של קובץ ה-JSON או ה-YAML:

gcloud logging update METRIC_NAME --config-from-file FILENAME

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

gcloud logging metrics update --help

API

כדי לערוך מדד שמבוסס על יומן, משתמשים ב-method‏ projects.metrics.update ב-API. מגדירים את השדות באופן הבא:

• ‫metricName: שם המשאב המלא של המדד:

  projects/PROJECT_ID/metrics/METRIC_ID
  

  לדוגמה:

  projects/my-gcp-project/metrics/my-error-metric
  

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

מחיקת מדדים מבוססי-יומנים

כדי למחוק מדד מבוסס-יומן שהוגדר על ידי המשתמש:

המסוף

1. נכנסים לדף Log-based Metrics במסוף Google Cloud :

   כניסה אל מדדים מבוססי-יומנים

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

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

   לחלופין, לוחצים על מחיקת מדד בתפריט של המדד מבוסס-היומן שרוצים למחוק.

gcloud

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

gcloud logging metrics delete METRIC_NAME

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

gcloud logging metrics delete --help

API

כדי למחוק מדד מבוסס-יומן שהוגדר על ידי המשתמש, משתמשים ב-method ‏projects.metrics.delete ב-API.

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