הגדרת משאב מותאם אישית ObservabilityConfig v1.7.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__.
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
חובה
השאילתה היא הצהרת SQL SELECT שצריך להריץ.
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 היא רשימה של הפניות לשמות של DBClusters שה-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 מייצג את התצפיות העדכניות ביותר לגבי המצב הנוכחי של הישות.
conditions[].lastTransitionTime
string
חובה
‫lastTransitionTime הוא הזמן האחרון שבו התנאי עבר מסטטוס אחד לסטטוס אחר. התאריך הזה צריך להיות התאריך שבו השתנה התנאי הבסיסי. אם לא ידוע מתי זה קרה, אפשר להשתמש בשעה שבה השדה ב-API השתנה.
conditions[].message
string
חובה
ההודעה היא הודעה קריאה שמציינת פרטים על המעבר. יכול להיות שמדובר במחרוזת ריקה.
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
אופציונלי
השם של רכיב בשירות מסד הנתונים שרשם את ההודעה ביומן.
criticalIncidents[].stackTrace[].message
string
אופציונלי
הודעה שנרשמה ביומן.
criticalIncidents[].transientUntil
string
אופציונלי
אם השדה הזה מופיע, המשמעות היא שצריך להתייחס לבעיה כאל בעיה זמנית עד למועד שצוין.
observedGeneration
integer
אופציונלי
פנימי: הדור שנצפה על ידי הבקר.
reconciled
boolean
אופציונלי
פנימי: האם המשאב הותאם על ידי בקר.