Benutzerdefinierte Ressourcendefinition für ObservabilityConfig v1.9.0

Wählen Sie eine Dokumentationsversion aus:

Spezifikationsschema

ObservabilityConfigSpec definiert den gewünschten 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 		CustomMetrics gibt die Konfiguration für benutzerdefinierte Messwerte an.
customMetrics.definitions
list (object)
Erforderlich 		„definitions“ ist eine Liste benutzerdefinierter Messwertdefinitionen.
customMetrics.definitions[].database
string
Erforderlich 		„Database“ ist der Name der Datenbank, zu der für diese Abfrage eine Verbindung hergestellt werden soll.
customMetrics.definitions[].metricGroup
string
Erforderlich 		MetricGroup ist ein Name, um zusammengehörige Messwerte zu gruppieren. Wird im endgültigen Messwertnamen verwendet: alloydb_omni_custom_<metricGroup>_<metric_name>.
customMetrics.definitions[].metrics
list (object)
Erforderlich 		„Metrics“ ist eine Liste von Messwerten, die aus dem Abfrageergebnis extrahiert werden sollen.
customMetrics.definitions[].metrics[].desc
string
Erforderlich 		„Desc“ ist eine menschenlesbare Beschreibung des Messwerts oder Labels.
customMetrics.definitions[].metrics[].name
string
Erforderlich 		„Name“ ist 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 		„Verwendung“ gibt an, wie diese Spalte verwendet wird. Gültige Werte sind „label“, „gauge“ und „counter“.
customMetrics.definitions[].query
string
Erforderlich 		„Query“ ist die SQL-SELECT-Anweisung, die ausgeführt werden soll.
customMetrics.resourceLimits
object
Optional 		ResourceLimits gibt die Ressourcenlimits für die Ausführung der benutzerdefinierten Abfragen an.
customMetrics.resourceLimits.maxParallelWorkers
integer
Optional 		„MaxParallelWorkers“ gibt die maximale Anzahl paralleler Worker für eine Abfrage an. Wenn Sie diesen Wert auf 0 festlegen, wird die parallele Abfrageausführung deaktiviert.
customMetrics.resourceLimits.statementTimeout
string
Optional 		„StatementTimeout“ gibt die maximal zulässige Zeit für die Ausführung einer Anweisung an. Beispiel: „2s“.
customMetrics.resourceLimits.workMemory
string
Optional 		„WorkMemory“ gibt die maximale Arbeitsspeichermenge an, die von einem Abfragevorgang verwendet werden soll. Beispiel: „4 MB“.
dbClusterRefs
list (string)
Erforderlich 		„DBClusterRefs“ ist eine Liste von Verweisen auf die Namen der DBCluster, für die diese ObservabilityConfig gilt. Die referenzierten DBCluster müssen sich im selben Namespace befinden.

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
list (object)
Optional 		„Bedingungen“ entspricht den neuesten verfügbaren Beobachtungen zum aktuellen Status der Entität.
conditions[].lastTransitionTime
string
Erforderlich 		Mit „lastTransitionTime“ wird der Zeitpunkt angegeben, zu dem die Bedingung zuletzt von einem Status zu einem anderen Status geändert wurde. 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 		„message“ ist eine menschenlesbare Nachricht mit Details zur Umstellung. Dies kann auch ein leerer String sein.
conditions[].observedGeneration
integer
Optional 		„observedGeneration“ stellt die .metadata.generation dar, auf der die Bedingung basiert. Wenn beispielsweise .metadata.generation 12 ist, .status.conditions[x].observedGeneration aber 9, ist die Bedingung im Hinblick auf den aktuellen Zustand der Instanz nicht mehr aktuell.
conditions[].reason
string
Erforderlich 		„reason“ enthält eine programmatische Kennung mit dem Grund für die letzte Statusänderung der Bedingung. Anbieter bestimmter Bedingungstypen können erwartete Werte und Bedeutungen für dieses Feld definieren und festlegen, ob die Werte als garantierte API gelten. Der Wert muss ein String in CamelCase-Schreibweise sein. Dieses Feld darf nicht leer sein.
conditions[].status
string
Erforderlich 		Status der Bedingung, entweder „True“, „False“ oder „Unknown“.
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 künstliche Bedingungen nützlich sein können (siehe .node.status.conditions), ist die Möglichkeit zur Konfliktbereinigung wichtig. Der entsprechende reguläre Ausdruck lautet (dns1123SubdomainFmt/)?(qualifiedNameFmt).
criticalIncidents
list (object)
Optional 		„CriticalIncidents“ enthält eine einfache Liste aller aktiven kritischen Vorfälle.
criticalIncidents[].code
string
Erforderlich 		Der Fehlercode dieses bestimmten Fehlers. Fehlercodes sind DBSE-Strings mit einer Zahl, z. B. „DBSE1012“.
criticalIncidents[].createTime
string
Erforderlich 		Der Zeitstempel für den Zeitpunkt, zu dem dieser Vorfall am Ursprungsort erstellt wurde.
criticalIncidents[].message
string
Optional 		Die Nachricht beschreibt den Vorfall/Fehler, der aufgetreten ist.
criticalIncidents[].messageTemplateParams
object
Optional 		Enthält Schlüssel/Wert-Paare, die zum Generieren einer nutzerfreundlichen, datengesteuerten Version der Mitteilung in der Benutzeroberfläche erforderlich sind.
criticalIncidents[].resource
object
Erforderlich 		Enthält Informationen zur Database Service-Komponente, die den Vorfall gemeldet hat, sowie zur K8s-Ressource.
criticalIncidents[].resource.component
string
Erforderlich 		Eine interne Kennung des Database Service-Subsystems, das den Vorfall gemeldet hat.
criticalIncidents[].resource.location
object
Optional 		Standort.
criticalIncidents[].resource.location.cluster
string
Optional 		Der Name des Clusters der betroffenen Kubernetes-Ressource.
criticalIncidents[].resource.location.group
string
Optional 		Der Gruppenname der Kubernetes-Ressource.
criticalIncidents[].resource.location.kind
string
Optional 		Die Art der Kubernetes-Ressource.
criticalIncidents[].resource.location.name
string
Optional 		Der Name der betroffenen Kubernetes-Ressource.
criticalIncidents[].resource.location.namespace
string
Optional 		Der Namespace der betroffenen Kubernetes-Ressource.
criticalIncidents[].resource.location.version
string
Optional 		Die Version der Kubernetes-Ressource.
criticalIncidents[].stackTrace
list (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 sollte.
observedGeneration
integer
Optional 		Intern: Die vom Controller beobachtete Generierung.
reconciled
boolean
Optional 		Intern: Gibt an, ob die Ressource vom Controller abgeglichen wurde.