הגדרת משאב מותאם אישית ObservabilityConfig v1.8.0

בחירת גרסת תיעוד:

סכמת המפרט

‫ObservabilityConfigSpec מגדיר את המצב הרצוי של ObservabilityConfig.

customMetrics:
  definitions:
  - database: string
    metricGroup: string
    metrics:
    - desc: string
      name: string
      usage: string
    query: string
  resourceLimits:
    maxParallelWorkers: integer
    statementTimeout: string
    workMemory: string
dbClusterRefs:
- string

שדה

סוג
חובה או אופציונלי

 

תיאור
customMetrics
object
חובה
השדה CustomMetrics מציין את ההגדרה של המדדים המותאמים אישית.
customMetrics.definitions
list (object)
חובה
Definitions היא רשימה של הגדרות של מדדים מותאמים אישית.
customMetrics.definitions[].database
string
חובה
‫Database הוא השם של מסד הנתונים שאליו רוצים להתחבר בשביל השאילתה הזו.
customMetrics.definitions[].metricGroup
string
חובה
‫MetricGroup הוא שם לקבוצת מדדים קשורים. השם הזה משמש בשם המדד הסופי: alloydb_omni_custom_<metricGroup>_<metric_name>.
customMetrics.definitions[].metrics
list (object)
חובה
‫Metrics היא רשימה של מדדים לחילוץ מתוצאת השאילתה.
customMetrics.definitions[].metrics[].desc
string
חובה
‫Desc הוא תיאור קריא לאנשים של המדד או התווית.
customMetrics.definitions[].metrics[].name
string
חובה
‫Name הוא השם של העמודה בתוצאת שאילתת ה-SQL. הערך הזה ישמש כחלק משם המדד של Prometheus או כשם של תווית.
customMetrics.definitions[].metrics[].usage
string
חובה
השימוש מציין איך העמודה הזו תשמש אתכם. הערכים התקינים הם "label",‏ "gauge",‏ "counter".
customMetrics.definitions[].query
string
חובה
השאילתה היא הצהרת SELECT ב-SQL שצריך להריץ.
customMetrics.resourceLimits
object
אופציונלי
‫ResourceLimits מציין את מגבלות המשאבים להרצת השאילתות בהתאמה אישית.
customMetrics.resourceLimits.maxParallelWorkers
integer
אופציונלי
ההגדרה MaxParallelWorkers מציינת את המספר המקסימלי של עובדים מקבילים לשאילתה. הגדרה של הערך 0 משביתה את הביצוע המקביל של שאילתות.
customMetrics.resourceLimits.statementTimeout
string
אופציונלי
המאפיין StatementTimeout מציין את משך הזמן המקסימלי המותר להרצת הצהרה כלשהי. לדוגמה: "2s".
customMetrics.resourceLimits.workMemory
string
אופציונלי
המאפיין WorkMemory מציין את כמות הזיכרון המקסימלית שתשמש לפעולת שאילתה. דוגמה: "4MB".
dbClusterRefs
list (string)
חובה
‫DBClusterRefs היא רשימה של הפניות לשמות של DBCluster שה-ObservabilityConfig הזה חל עליהם. אשכולות מסדי הנתונים שאליהם מפנים צריכים להיות באותו מרחב שמות.

סכימת סטטוס

‫ObservabilityConfigStatus מגדיר את המצב הנצפה של ObservabilityConfig.

conditions:
- lastTransitionTime: string
  message: string
  observedGeneration: integer
  reason: string
  status: string
  type: string
criticalIncidents:
- code: string
  createTime: string
  message: string
  messageTemplateParams: object
  resource:
    component: string
    location:
      cluster: string
      group: string
      kind: string
      name: string
      namespace: string
      version: string
  stackTrace:
  - component: string
    message: string
  transientUntil: string
observedGeneration: integer
reconciled: boolean

שדה

סוג
חובה או אופציונלי

 

תיאור
conditions
list (object)
אופציונלי
התנאים מייצגים את התצפיות העדכניות ביותר על המצב הנוכחי של הישות.
conditions[].lastTransitionTime
string
חובה
‫lastTransitionTime הוא הזמן האחרון שבו התנאי עבר מסטטוס אחד לאחר. התאריך הזה צריך להיות התאריך שבו השתנה התנאי הבסיסי. אם המידע הזה לא ידוע, אפשר להשתמש בשעה שבה השדה של ה-API השתנה.
conditions[].message
string
חובה
‫message הוא הודעה קריאה לאנשים שמציינת פרטים על המעבר. הערך יכול להיות מחרוזת ריקה.
conditions[].observedGeneration
integer
אופציונלי
‫observedGeneration מייצג את ‎ .metadata.generation שעליו התנאי הוגדר. לדוגמה, אם הערך של ‎ .metadata.generation הוא 12, אבל הערך של ‎ .status.conditions[x].observedGeneration הוא 9, התנאי לא עדכני ביחס למצב הנוכחי של המכונה.
conditions[].reason
string
חובה
הסיבה מכילה מזהה פרוגרמטי שמציין את הסיבה למעבר האחרון של התנאי. מפיקים של סוגים מסוימים של תנאים יכולים להגדיר ערכים ומשמעויות צפויים לשדה הזה, ולקבוע אם הערכים נחשבים ל-API מובטח. הערך צריך להיות מחרוזת בפורמט CamelCase. השדה הזה לא יכול להיות ריק.
conditions[].status
string
חובה
הסטטוס של התנאי, אחד מהערכים True,‏ False או Unknown.
conditions[].type
string
חובה
סוג התנאי ב-CamelCase או ב-foo.example.com/CamelCase. הרבה ערכים של ‎ .condition.type עקביים במשאבים כמו Available, אבל מכיוון שתנאים שרירותיים יכולים להיות שימושיים (ראו ‎ .node.status.conditions), חשוב שתהיה אפשרות לפתור קונפליקטים. הביטוי הרגולרי שתואם לו הוא (dns1123SubdomainFmt/)?(qualifiedNameFmt).
criticalIncidents
list (object)
אופציונלי
‫CriticalIncidents היא רשימה של כל האירועים הקריטיים הפעילים.
criticalIncidents[].code
string
חובה
קוד השגיאה של השגיאה הספציפית הזו. קודי השגיאה הם מחרוזות של DBSE+מספרים, כמו "DBSE1012".
criticalIncidents[].createTime
string
חובה
חותמת הזמן שבה האירוע הזה נוצר במקור.
criticalIncidents[].message
string
אופציונלי
ההודעה מתארת את האירוע או השגיאה שהתרחשו.
criticalIncidents[].messageTemplateParams
object
אופציונלי
מכיל צמדי מפתח/ערך שנדרשים כדי ליצור גרסה ידידותית למשתמש של ההודעה בממשק המשתמש, שמבוססת על נתונים.
criticalIncidents[].resource
object
חובה
מכיל מידע על רכיב שירות מסד הנתונים שדיווח על האירוע וגם על משאב K8s.
criticalIncidents[].resource.component
string
חובה
מזהה פנימי של תת-המערכת של שירות מסד הנתונים שדיווחה על האירוע.
criticalIncidents[].resource.location
object
אופציונלי
מיקום.
criticalIncidents[].resource.location.cluster
string
אופציונלי
השם של האשכול של משאב ב-Kubernetes שהושפע.
criticalIncidents[].resource.location.group
string
אופציונלי
שם הקבוצה של המשאב ב-Kubernetes.
criticalIncidents[].resource.location.kind
string
אופציונלי
הסוג של המשאב ב-Kubernetes.
criticalIncidents[].resource.location.name
string
אופציונלי
השם של משאב ב-Kubernetes שהושפע.
criticalIncidents[].resource.location.namespace
string
אופציונלי
מרחב השמות של משאב ב-Kubernetes שהושפע.
criticalIncidents[].resource.location.version
string
אופציונלי
הגרסה של משאב ב-Kubernetes.
criticalIncidents[].stackTrace
list (object)
אופציונלי
רשימה לא מובנית של הודעות מדוח קריסות.
criticalIncidents[].stackTrace[].component
string
אופציונלי
השם של רכיב Database Service שתיעד את ההודעה ביומן.
criticalIncidents[].stackTrace[].message
string
אופציונלי
הודעה ביומן.
criticalIncidents[].transientUntil
string
אופציונלי
אם השדה הזה מופיע, המשמעות היא שהבעיה נחשבת זמנית עד למועד שצוין.
observedGeneration
integer
אופציונלי
פנימי: הדור שנצפה על ידי הבקר.
reconciled
boolean
אופציונלי
פנימי: אם המשאב הותאם על ידי הבקר.