יומני הפלטפורמה ב-Artifact Registry מספקים מידע על בקשות שהצליחו ונכשלו למאגרים של Artifact Registry. בדיקת היומנים האלה עוזרת לכם לפתור בעיות בבקשות שנכשלו, לשמור תיעוד של בקשות שהצליחו ולראות את מספר ההורדות של פריט מידע שנוצר בתהליך פיתוח התוכנה.
סקירה כללית
Artifact Registry יוצר יומני פלטפורמה לקריאות ל-API של מישור הנתונים ולקריאות ל-API של מישור הבקרה. פעולות במישור הבקרה כוללות פעולות לניהול מאגרים, כמו יצירת מאגרים, עריכת תיאורי מאגרים ומחיקת מאגרים, ופעולות לניהול פריטי מידע שנוצר, כמו הצגת פריטי מידע שנוצר ברשימה, תיוג פריטי מידע שנוצר ומחיקת פריטי מידע שנוצר. פעולות במישור הנתונים כוללות פעולות כמו דחיפה ומשיכה של פריטי מידע שנוצר ממאגרים של Artifact Registry.
Cloud Logging יוצר יומני פלטפורמה. אפשר לראות אותם ב-Logs Explorer. יומן פלטפורמה מופיע בפורמט של LogEntry.
היומנים של שני סוגי השיחות מכילים את הפרטים הבאים:
- פרטי הבקשה
- פרטי התשובה
- סטטוס
- תוויות
- שם השיטה
- שם המשאב
- מיקום המשאב
- מזהה הפעולה (לפעולות ממושכות)
- פורמט המאגר (למשאבי מאגר)
- מצב מאגר (למשאבי מאגר)
בנוסף, היומנים של קריאות ל-API של מישור הבקרה מכילים את המידע הבא:
- מידע על HTTP
- שיטת הבקשה
- בקש כתובת אתר
- גודל הבקשה (בבייטים)
- סטטוס
- גודל התגובה (בבייטים)
- סוכן משתמש
- כתובת IP מרוחקת (כתובת ה-IP של הלקוח ששלח את הבקשה)
- פרוטוקול
- מקור ההפניה (referrer)
- זמן אחזור
לפני שמתחילים
התפקידים הנדרשים
כדי לקבל את ההרשאות שדרושות לניהול יומני הפלטפורמה, בקשו מהאדמין לתת לכם את התפקידים הבאים ב-IAM ברמת הפרויקט:
- אדמין ב-Artifact Registry (
roles/artifactregistry.admin) - צפייה ביומנים (
roles/logging.viewer)
להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.
יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.
הפעלת רישום ביומן של הפלטפורמה
אתם יכולים להפעיל את רישום הפלטפורמה ביומן בכל הפרויקט ב- Google Cloud או במאגר ספציפי.
הפעלת רישום ביומן של פלטפורמה בפרויקט
כדי להפעיל את רישום הפלטפורמה ביומן בפרויקט Google Cloud , מריצים את הפקודה הבאה:
CLI של gcloud
gcloud artifacts projects update --enable-platform-logs --severity=SEVERITY --location LOCATION --project PROJECT
curl
curl -v -H "Authorization: Bearer $(gcloud auth print-access-token)" -X PATCH -H "X-GFE-SSL: yes" -H "Content-Type: application/json" -d '{"name": "projects/'PROJECT'/locations/'LOCATION'/projectConfig", "platformLogsConfig": {"logging_state": "ENABLED", "severity_level": "SEVERITY"}}' "https://artifactregistry.googleapis.com/v1/projects/PROJECT/locations/LOCATION/projectConfig"
כאשר:
- SEVERITY קובע את סוג הפעולות שמפעילות את יצירת יומן הפלטפורמה של Artifact Registry.
אפשר להזין
INFO,ERRORאו להחריג את השדה--severityכדי ליצור יומני פלטפורמה לכל הפעולות הנתמכות. - LOCATION הוא המיקום של המאגר.
- PROJECT הוא מזהה הפרויקט. אם לא מציינים את הדגל הזה, המערכת משתמשת בפרויקט הנוכחי או בפרויקט ברירת המחדל.
הפעלת רישום ביומן של הפלטפורמה במאגר
CLI של gcloud
gcloud artifacts repositories update --enable-platform-logs --severity=SEVERITY REPOSITORY --location LOCATION --project PROJECT
curl
curl -v -H "Authorization: Bearer $(gcloud auth print-access-token)" -X PATCH \
-H "X-GFE-SSL: yes" -H "Content-Type: application/json" \
-d '{"name": "projects/'PROJECT'/locations/'LOCATION'/repositories/'REPOSITORY'", "platformLogsConfig": {"loggingState": "ENABLED", "severityLevel": "SEVERITY"}' \
"https://artifactregistry.googleapis.com/v1/projects/PROJECT/locations/LOCATION/repositories/REPOSITORY?updateMask=platformLogsConfig"
כאשר:
- SEVERITY קובע את סוג הפעולות שמפעילות את יצירת יומן הפלטפורמה של Artifact Registry.
אפשר להזין
INFO,ERRORאו להחריג את השדה--severityכדי ליצור יומני פלטפורמה לכל הפעולות הנתמכות. - REPOSITORY הוא שם המאגר ב-Artifact Registry.
- LOCATION הוא המיקום של המאגר.
- PROJECT הוא מזהה הפרויקט. אם לא מציינים את הדגל הזה, המערכת משתמשת בפרויקט הנוכחי או בפרויקט ברירת המחדל.
אימות הגדרות הרישום ביומן של הפלטפורמה
אתם יכולים לבדוק אם רישום ביומן של פלטפורמת Artifact Registry מופעל בפרויקט או במאגר ספציפי.
אימות רישום ביומן של פלטפורמה בפרויקט
כדי לבדוק אם הרישום ביומן של פלטפורמת Artifact Registry מופעל בפרויקט, מריצים את הפקודה הבאה:
CLI של gcloud
gcloud artifacts projects describe --location LOCATION --project PROJECT
curl
curl -v -H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://artifactregistry.googleapis.com/v1/projects/PROJECT/locations/LOCATION/projectConfig"
כאשר:
- LOCATION הוא המיקום של המאגר.
- PROJECT הוא מזהה הפרויקט. אם לא מציינים את הדגל הזה, המערכת משתמשת בפרויקט הנוכחי או בפרויקט ברירת המחדל.
הפלט אמור להיראות כך:
{
"name": "projects/PROJECT/locations/{"<var>LOCATION</var>"}}/projectConfig"
"platformLogsConfig": {
"loggingState": "ENABLED"
"severityLevel": "INFO"
}
}
אימות הרישום ביומן של הפלטפורמה במאגר
כדי לבדוק אם הרישום ביומן של פלטפורמת Artifact Registry מופעל במאגר, מריצים את הפקודה הבאה:
CLI של gcloud
gcloud artifacts repositories describe REPOSITORY --location LOCATION --project PROJECT
curl
curl -v -H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://artifactregistry.googleapis.com/v1/projects/PROJECT/locations/LOCATION/repositories/REPOSITORY"
כאשר:
- REPOSITORY הוא שם המאגר.
- LOCATION הוא המיקום של המאגר.
- PROJECT הוא מזהה הפרויקט. אם לא מציינים את הדגל הזה, המערכת משתמשת בפרויקט הנוכחי או בפרויקט ברירת המחדל.
הפלט אמור להיראות כך:
{
"name": "projects/PROJECT/locations/LOCATION/repositories/REPOSITORY"
"platformLogsConfig": {
"loggingState": "ENABLED",
"severityLevel": "INFO"
}
}
השבתת הרישום ביומן של הפלטפורמה
אפשר להשבית את רישום הפעולות ביומן של הפלטפורמה בכל הפרויקט ב- Google Cloud או במאגר ספציפי.
השבתת הרישום ביומן של הפלטפורמה בפרויקט
כדי להשבית את הרישום ביומן של הפלטפורמה בפרויקט ב- Google Cloud , מריצים את הפקודה הבאה:
CLI של gcloud
gcloud artifacts projects update --disable-platform-logs --location LOCATION --project PROJECT
curl
curl -v -H "Authorization: Bearer $(gcloud auth print-access-token)" -X PATCH \
-H "X-GFE-SSL: yes" -H "Content-Type: application/json" \
-d '{"name": "projects/'PROJECT'/locations/'LOCATION'/projectConfig", "platformLogsConfig": {"logging_state": "DISABLED"}}' \
"https://artifactregistry.googleapis.com/v1/projects/PROJECT/locations/LOCATION/projectConfig"
כאשר:
- LOCATION הוא המיקום של המאגר.
- PROJECT הוא מזהה הפרויקט. אם לא מציינים את הדגל הזה, המערכת משתמשת בפרויקט הנוכחי או בפרויקט ברירת המחדל.
השבתת הרישום ביומן של הפלטפורמה במאגר
כדי להשבית את רישום הפלטפורמה ביומן של מאגר, מריצים את הפקודה הבאה:
CLI של gcloud
gcloud artifacts repositories update --disable-platform-logs REPOSITORY --location LOCATION --project PROJECT
curl
curl -v -H "Authorization: Bearer $(gcloud auth print-access-token)" -X PATCH \
-H "X-GFE-SSL: yes" -H "Content-Type: application/json" \
-d '{"name": "projects/'PROJECT'/locations/'LOCATION'/repositories/'REPOSITORY'", "platformLogsConfig": {"loggingState": "DISABLED", "severityLevel": "INFO"}' \
"https://artifactregistry.googleapis.com/v1/projects/PROJECT/locations/LOCATION/repositories/REPOSITORY?updateMask=platformLogsConfig"
כאשר:
- REPOSITORY הוא שם המאגר ב-Artifact Registry.
- LOCATION הוא המיקום של המאגר.
- PROJECT הוא מזהה הפרויקט. אם לא מציינים את הדגל הזה, המערכת משתמשת בפרויקט הנוכחי או בפרויקט ברירת המחדל.
ניקוי הגדרות הרישום ביומן של הפלטפורמה
אפשר למחוק את הגדרות הרישום ביומן של הפלטפורמה ברמת הפרויקט או ברמת המאגר. כשמריצים את פקודת הניקוי, הערכים של loggingState ו-severityLevel בפרויקט או במאגר מוגדרים כ-null.
אם תמחקו את ההגדרות של הפרויקט, רק מאגרים שכבר הופעל בהם רישום ביומן של הפלטפורמה יפיקו יומני פלטפורמה. אם תמחקו את ההגדרות של מאגר מסוים, הוא יקבל את הגדרות הרישום ביומן של הפלטפורמה מהפרויקט.
איך מוחקים את הגדרות הרישום ביומן של הפלטפורמה בפרויקט
כדי למחוק את הגדרות רישום היומנים של הפלטפורמה בפרויקט ב- Google Cloud , מריצים את הפקודה הבאה:
CLI של gcloud
gcloud artifacts projects update --clear-platform-logs --location LOCATION --project PROJECT
curl
curl -v -H "Authorization: Bearer $(gcloud auth print-access-token)" -X PATCH \
-H "X-GFE-SSL: yes" -H "Content-Type: application/json" \
-d '{"name": "projects/'PROJECT'/locations/'LOCATION'/projectConfig", "platformLogsConfig": {}}' \
"https://artifactregistry.googleapis.com/v1/projects/PROJECT/locations/LOCATION/projectConfig"
כאשר:
- LOCATION הוא המיקום של המאגר.
- PROJECT הוא מזהה הפרויקט. אם לא מציינים את הדגל הזה, המערכת משתמשת בפרויקט הנוכחי או בפרויקט ברירת המחדל.
מחיקת ההגדרות של רישום ביומן ברמת הפלטפורמה במאגר
כדי למחוק את הגדרות הרישום ביומן של הפלטפורמה במאגר, מריצים את הפקודה הבאה:
CLI של gcloud
gcloud artifacts repositories update --clear-platform-logs REPOSITORY --location LOCATION --project PROJECT
curl
curl -v -H "Authorization: Bearer $(gcloud auth print-access-token)" -X PATCH \
-H "X-GFE-SSL: yes" -H "Content-Type: application/json" \
-d '{"name": "projects/'PROJECT'/locations/'LOCATION'/repositories/'REPOSITORY'", "platformLogsConfig": {}' \
"https://artifactregistry.googleapis.com/v1/projects/PROJECT/locations/LOCATION/repositories/REPOSITORY?updateMask=platformLogsConfig"
כאשר:
- REPOSITORY הוא שם המאגר ב-Artifact Registry.
- LOCATION הוא המיקום של המאגר.
- PROJECT הוא מזהה הפרויקט. אם לא מציינים את הדגל הזה, המערכת משתמשת בפרויקט הנוכחי או בפרויקט ברירת המחדל.
הצגת יומני הפלטפורמה
כדי לראות את יומני הפלטפורמה:
פותחים את הדף Logs Explorer במסוף Google Cloud .
בחלונית השאילתה, לוחצים על התפריט הנפתח Log name.
מזינים requests ובוחרים את תיבת הסימון requests מתחת לכותרת Artifact Registry.
לוחצים על אישור.
ב-Logging, היומנים מקריאות ל-API של מישור הנתונים ומישור הבקרה מוצגים בחלונית Query results.
כדי לראות את התוכן של יומן, לוחצים על החץ לצד כל יומן שמופיע בתוצאות השאילתה.
למידע נוסף על הבנת תוצאות השאילתה ב-Logs Explorer, קראו את המאמר הצגת תוצאות השאילתה.
ניתוח יומני פלטפורמה באמצעות Observability Analytics
אתם יכולים להשתמש ב-Observability Analytics כדי להריץ שאילתות SQL על היומנים של Artifact Registry, וכך לנתח את היומנים בצורה מפורטת יותר. בקטע הזה מופיעות כמה שאילתות לדוגמה לתרחישים נפוצים. אתם יכולים להתאים את השאילתות האלה כדי לנתח היבטים אחרים של השימוש ב-Artifact Registry, על ידי סינון לפי שדות שונים במבנה של LogEntry.
לפני שמתחילים להשתמש ב-Observability Analytics, צריך לבצע את הפעולות הבאות:
מגדירים את קטגוריות היומנים לשימוש ב-Observability Analytics.
להגדיר תפקידים והרשאות בניהול הזהויות והרשאות הגישה (IAM) כדי להשתמש ב-Observability Analytics.
לאחר מכן, פועלים לפי השלבים להזנה והרצה של שאילתה בהתאמה אישית. כשמגיעים לחלונית שאילתת SQL, אפשר להזין אחת מהשאילתות לדוגמה הבאות:
דוגמה: 10 כתובות ה-IP המובילות לפי נפח ההורדה
השאילתה הזו בודקת את יומני הפלטפורמה של Artifact Registry ומחזירה את 10 כתובות ה-IP שהורידו הכי הרבה נתונים מהמאגרים שלכם ב-7 הימים האחרונים:
SELECT
http_request.remote_ip AS client_ip,
SUM(http_request.response_size) AS total_download_bytes
FROM
`YOUR_PROJECT.YOUR_LOCATION.YOUR_BUCKET._AllLogs`
WHERE
log_id = "artifactregistry.googleapis.com/requests"
AND JSON_VALUE(resource.labels.repository_id) IS NOT NULL
AND http_request.request_method = "GET"
AND http_request.status >= 200 AND http_request.status < 300
AND http_request.response_size > 0
AND CAST(http_request.response_size AS INT64) > 0
AND timestamp >= TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 7 DAY)
GROUP BY
client_ip
ORDER BY
total_download_bytes DESC
LIMIT 10;
דוגמה: בקשות לכל מאגר
השאילתה הזו מעריכה את יומני הפלטפורמה של Artifact Registry ומחזירה את מספר הבקשות שנשלחו לכל מאגר ב-24 השעות האחרונות:
SELECT
JSON_VALUE(resource.labels.repository_id) AS repository,
JSON_VALUE(resource.labels.location) AS location,
COUNT(*) AS request_count
FROM
`YOUR_PROJECT.YOUR_LOCATION.YOUR_BUCKET._AllLogs`
WHERE
log_id = "artifactregistry.googleapis.com/requests"
AND JSON_VALUE(resource.labels.repository_id) IS NOT NULL
AND timestamp >= TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 DAY)
GROUP BY
repository,
location
ORDER BY
request_count DESC;
דוגמה: בקשות שנכשלו
השאילתה הזו בודקת את יומני הפלטפורמה של Artifact Registry ומציגה פרטים על 10 הבקשות האחרונות שנכשלו בשעה האחרונה:
SELECT
timestamp,
http_request.status,
http_request.request_method,
http_request.request_url,
http_request.remote_ip,
JSON_VALUE(resource.labels.repository_id) AS repository,
JSON_VALUE(labels.resource_name) AS artifact_name,
trace
FROM
`YOUR_PROJECT.YOUR_LOCATION.YOUR_BUCKET._AllLogs`
WHERE
log_id = "artifactregistry.googleapis.com/requests"
AND JSON_VALUE(resource.labels.repository_id) IS NOT NULL
AND http_request.status >= 400
AND timestamp >= TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR)
ORDER BY
timestamp DESC
LIMIT 10;