Benutzerdefinierte Ressourcendefinition für ObservabilityConfig

Spezifikationsschema

ObservabilityConfigSpec definiert den ausgewählten Status von 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

Feld

Typ
Erforderlich oder optional

 

Beschreibung
customMetrics
object
Erforderlich
Gibt die Konfiguration für benutzerdefinierte Messwerte an.
customMetrics.definitions
list (object)
Erforderlich
Eine Liste mit Definitionen benutzerdefinierter Messwerte.
customMetrics.definitions[].database
string
Erforderlich
Der Name der Datenbank, zu der für diese Abfrage eine Verbindung hergestellt werden soll.
customMetrics.definitions[].metricGroup
string
Erforderlich
Ein Name, mit dem zusammengehörige Messwerte gruppiert werden. Wird im endgültigen Messwertnamen verwendet: alloydb_omni_custom_<metricGroup>_<metric_name>.
customMetrics.definitions[].metrics
list (object)
Erforderlich
Eine Liste der Messwerte, die aus dem Abfrageergebnis extrahiert werden sollen.
customMetrics.definitions[].metrics[].desc
string
Erforderlich
Eine menschenlesbare Beschreibung des Messwerts oder Labels.
customMetrics.definitions[].metrics[].name
string
Erforderlich
Der Name der Spalte im SQL-Abfrageergebnis. Dieser Wert wird als Teil des Prometheus-Messwertnamens oder als Labelname verwendet.
customMetrics.definitions[].metrics[].usage
string
Erforderlich
Gibt an, wie diese Spalte verwendet wird. Gültige Werte sind „label“, „gauge“ und „counter“.
customMetrics.definitions[].query
string
Erforderlich
Die auszuführende SQL SELECT-Anweisung.
customMetrics.resourceLimits
object
Optional
ResourceLimits gibt die Ressourcenlimits für die Ausführung der benutzerdefinierten Abfragen an.
customMetrics.resourceLimits.maxParallelWorkers
integer
Optional
Gibt die maximale Anzahl paralleler Worker für eine Abfrage an. Wenn Sie diesen Wert auf 0 festlegen, wird die parallele Ausführung von Abfragen deaktiviert.
customMetrics.resourceLimits.statementTimeout
string
Optional
Gibt die maximal zulässige Zeit für die Ausführung einer Anweisung an. Beispiel: „2s“.
customMetrics.resourceLimits.workMemory
string
Optional
Gibt die maximale Menge an Arbeitsspeicher an, die von einem Abfragevorgang verwendet werden soll. Beispiel: „4 MB“.
dbClusterRefs
list (string)
Erforderlich
Liste der Verweise auf DBCluster-Instanzen, die von dieser ObservabilityConfig betroffen sind.

Statusschema

„ObservabilityConfigStatus“ definiert den beobachteten Status von „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

Feld

Typ
Erforderlich oder optional

 

Beschreibung
conditions[]
object
Optional
Liste der neuesten verfügbaren Beobachtungen zum aktuellen Status der Entität.
conditions[].lastTransitionTime
string
Erforderlich
Der Zeitpunkt der letzten Änderung der Bedingung von einem Status in einen anderen. Das sollte der Zeitpunkt sein, an dem sich die zugrunde liegende Bedingung geändert hat. Wenn diese Zeit nicht bekannt ist, kann die Zeit verwendet werden, zu der sich das API-Feld geändert hat.
conditions[].message
string
Erforderlich
Eine menschenlesbare Nachricht, die die Umstellung beschreibt. Das kann ein leerer String sein.
conditions[].observedGeneration
integer
Optional
Die .metadata.generation, auf der diese Bedingung basiert. Wenn .metadata.generation beispielsweise 12 ist, .status.conditions[x].observedGeneration aber 9, ist die Bedingung nicht mehr aktuell und spiegelt nicht den aktuellen Zustand der Instanz wider.
conditions[].reason
string
Erforderlich
Eine programmatische Kennung, die den Grund für die letzte Statusänderung der Bedingung angibt. Anbieter bestimmter Bedingungstypen können erwartete Werte und Bedeutungen für dieses Feld definieren und festlegen, ob die Werte als stabile API gelten. Der Wert muss ein String im Binnenmajuskelformat sein. Dieses Feld darf nicht leer sein.
conditions[].status
string
Erforderlich
Der Status der Bedingung („Wahr“, „Falsch“ oder „Unbekannt“).
conditions[].type
string
Erforderlich
Bedingungstyp im Binnenmajuskelformat oder in foo.example.com/CamelCase. Viele .condition.type-Werte sind ressourcenübergreifend konsistent, z. B. „Available“. Da jedoch beliebige Bedingungen nützlich sein können (siehe .node.status.conditions), ist die Möglichkeit zur Konfliktlösung wichtig. Der entsprechende reguläre Ausdruck lautet (dns1123SubdomainFmt/)?(qualifiedNameFmt).
criticalIncidents
list (object)
Optional
Eine einfache Liste aller aktiven kritischen Vorfälle.
criticalIncidents[]
object
Optional
Liefert Informationen zu einem laufenden kritischen Vorfall.
criticalIncidents[].code
string
Erforderlich
Der Fehlercode. Fehlercodes sind DBSE-Strings mit einer Zahl, z. B. „DBSE1012“.
criticalIncidents[].createTime
string
Erforderlich
Der Zeitstempel für den Zeitpunkt, zu dem dieser Vorfall erstellt wurde.
criticalIncidents[].message
string
Optional
Die Nachricht beschreibt den Vorfall oder Fehler, der aufgetreten ist.
criticalIncidents[].messageTemplateParams
object
Optional
Das Schlüssel/Wert-Paar, das zum Generieren einer nutzerfreundlichen datengesteuerten Version der Mitteilung in der Benutzeroberfläche erforderlich ist.
criticalIncidents[].resource
object
Erforderlich
Informationen zur Database Service-Komponente, die den Vorfall gemeldet hat, sowie Informationen zur Cluster Manager-Ressource.
criticalIncidents[].resource.component
string
Erforderlich
Eine interne Kennung des Database Service-Subsystems, das den Vorfall gemeldet hat.
criticalIncidents[].resource.location
object
Optional
Der Kubernetes-spezifische Speicherort (z. B. Cluster, Namespace, Art und Name) der betroffenen Ressource.
criticalIncidents[].resource.location.cluster
string
Optional
Der Name des Clusters der betroffenen Ressource.
criticalIncidents[].resource.location.group
string
Optional
Der Gruppenname der Cluster Manager-Ressource.
criticalIncidents[].resource.location.kind
string
Optional
Beschreibt die Art der Ressource.
criticalIncidents[].resource.location.name
string
Optional
Der Name der betroffenen Ressource.
criticalIncidents[].resource.location.namespace
string
Optional
Der Namespace der betroffenen Ressource.
criticalIncidents[].resource.location.version
string
Optional
Die Version der Ressource.
criticalIncidents[].stackTrace
object
Optional
Eine unstrukturierte Liste von Nachrichten aus dem Stacktrace.
criticalIncidents[].stackTrace.component
string
Optional
Der Name einer Database Service-Komponente, die die Nachricht in Logs erfasst hat.
criticalIncidents[].stackTrace.message
string
Optional
Logeintrag.
criticalIncidents[].transientUntil
string
Optional
Wenn vorhanden, gibt dies an, dass das Problem bis zum angegebenen Zeitpunkt als vorübergehend betrachtet werden muss.
observedGeneration
integer
Optional
Intern: Die vom Controller beobachtete Generierung.
reconciled
boolean
Optional
Gibt an, ob die Ressource vom Controller abgeglichen wurde.