Définition de ressource personnalisée ObservabilityConfig v1.9.0

Sélectionnez une version de la documentation :

Schéma de spécification

ObservabilityConfigSpec définit l'état souhaité d'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

Champ

Type
Obligatoire ou facultatif

 

Description
customMetrics
object
Obligatoire
CustomMetrics spécifie la configuration des métriques personnalisées.
customMetrics.definitions
list (object)
Obligatoire
"definitions" est une liste de définitions de métriques personnalisées.
customMetrics.definitions[].database
string
Obligatoire
"Database" est le nom de la base de données à laquelle se connecter pour cette requête.
customMetrics.definitions[].metricGroup
string
Obligatoire
MetricGroup est un nom permettant de regrouper des métriques associées. Utilisé dans le nom de la métrique finale : alloydb_omni_custom_<metricGroup>_<metric_name>.
customMetrics.definitions[].metrics
list (object)
Obligatoire
"metrics" : liste des métriques à extraire du résultat de la requête.
customMetrics.definitions[].metrics[].desc
string
Obligatoire
"Desc" est une description lisible par l'humain de la métrique ou du libellé.
customMetrics.definitions[].metrics[].name
string
Obligatoire
"Name" correspond au nom de la colonne dans le résultat de la requête SQL. Il sera utilisé dans le nom de la métrique Prometheus ou comme nom d'étiquette.
customMetrics.definitions[].metrics[].usage
string
Obligatoire
L'utilisation spécifie comment cette colonne sera utilisée. Les valeurs valides sont "label", "gauge" et "counter".
customMetrics.definitions[].query
string
Obligatoire
"Query" correspond à l'instruction SQL SELECT à exécuter.
customMetrics.resourceLimits
object
(facultatif)
ResourceLimits spécifie les limites de ressources pour l'exécution des requêtes personnalisées.
customMetrics.resourceLimits.maxParallelWorkers
integer
(facultatif)
"MaxParallelWorkers" spécifie le nombre maximal de nœuds de calcul parallèles pour une requête. Si vous définissez cette valeur sur 0, l'exécution des requêtes en parallèle est désactivée.
customMetrics.resourceLimits.statementTimeout
string
(facultatif)
StatementTimeout spécifie la durée maximale autorisée pour l'exécution d'une instruction. Exemple : "2s".
customMetrics.resourceLimits.workMemory
string
(facultatif)
WorkMemory spécifie la quantité maximale de mémoire à utiliser par une opération de requête. Exemple : "4MB".
dbClusterRefs
list (string)
Obligatoire
"DBClusterRefs" est une liste de références aux noms des DBClusters auxquels s'applique cette ObservabilityConfig. Les DBClusters référencés doivent se trouver dans le même espace de noms.

Schéma d'état

"ObservabilityConfigStatus" définit l'état observé d'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

Champ

Type
Obligatoire ou facultatif

 

Description
conditions
list (object)
(facultatif)
"Conditions" représente les dernières observations disponibles pour l'état actuel de l'entité.
conditions[].lastTransitionTime
string
Obligatoire
"lastTransitionTime" correspond à la dernière fois où cette condition est passée d'un état à un autre. Il doit s'agir du moment où la condition sous-jacente a changé. Si cette valeur n'est pas connue, vous pouvez utiliser l'heure à laquelle le champ d'API a changé.
conditions[].message
string
Obligatoire
"message" est un message lisible par l'humain indiquant des détails sur la transition. Il peut s'agir d'une chaîne vide.
conditions[].observedGeneration
integer
(facultatif)
"observedGeneration" représente le .metadata.generation sur lequel la condition a été définie. Par exemple, si .metadata.generation est défini sur 12, mais que .status.conditions[x].observedGeneration est défini sur 9, la condition est obsolète par rapport à l'état actuel de l'instance.
conditions[].reason
string
Obligatoire
"reason" contient un identifiant programmatique indiquant la raison de la dernière transition de la condition. Les producteurs de types de conditions spécifiques peuvent définir des valeurs et des significations attendues pour ce champ, et indiquer si les valeurs sont considérées comme une API garantie. La valeur doit être une chaîne CamelCase. Ce champ ne peut pas être vide.
conditions[].status
string
Obligatoire
État de la condition. Sa valeur peut être "True", "False" ou "Unknown".
conditions[].type
string
Obligatoire
Type de condition au format CamelCase ou foo.example.com/CamelCase. De nombreuses valeurs .condition.type sont cohérentes entre les ressources (par exemple, "Available"), mais comme des conditions arbitraires peuvent être utiles (voir .node.status.conditions), il est important de pouvoir résoudre les conflits. L'expression régulière à laquelle ce type correspond est (dns1123SubdomainFmt/)?(qualifiedNameFmt).
criticalIncidents
list (object)
(facultatif)
"CriticalIncidents" est une liste plate de tous les incidents critiques actifs.
criticalIncidents[].code
string
Obligatoire
Code d'erreur de cette erreur spécifique. Les codes d'erreur sont des chaînes DBSE suivies d'un nombre, comme "DBSE1012".
criticalIncidents[].createTime
string
Obligatoire
Code temporel d'origine de la création de cet incident.
criticalIncidents[].message
string
(facultatif)
"Message" décrit l'incident survenu ou l'erreur qui s'est produite.
criticalIncidents[].messageTemplateParams
object
(facultatif)
Contient des paires clé-valeur nécessaires pour générer une version conviviale et axée sur les données de Message dans l'interface utilisateur.
criticalIncidents[].resource
object
Obligatoire
Contient des informations sur le composant Database Service qui a signalé l'incident, ainsi que sur la ressource K8s.
criticalIncidents[].resource.component
string
Obligatoire
Identifiant interne du sous-système Database Service qui a signalé l'incident.
criticalIncidents[].resource.location
object
(facultatif)
Emplacement
criticalIncidents[].resource.location.cluster
string
(facultatif)
Nom du cluster de la ressource Kubernetes concernée.
criticalIncidents[].resource.location.group
string
(facultatif)
Nom du groupe de la ressource Kubernetes.
criticalIncidents[].resource.location.kind
string
(facultatif)
Genre de la ressource Kubernetes.
criticalIncidents[].resource.location.name
string
(facultatif)
Nom de la ressource Kubernetes concernée.
criticalIncidents[].resource.location.namespace
string
(facultatif)
Espace de noms de la ressource Kubernetes concernée.
criticalIncidents[].resource.location.version
string
(facultatif)
Version de la ressource Kubernetes.
criticalIncidents[].stackTrace
list (object)
(facultatif)
Liste non structurée des messages provenant de la trace de la pile.
criticalIncidents[].stackTrace[].component
string
(facultatif)
Nom d'un composant Database Service ayant enregistré le message.
criticalIncidents[].stackTrace[].message
string
(facultatif)
Message enregistré.
criticalIncidents[].transientUntil
string
(facultatif)
Si cette option est sélectionnée, cela indique que le problème doit être considéré comme temporaire jusqu'à l'heure spécifiée.
observedGeneration
integer
(facultatif)
Interne : génération observée par le contrôleur.
reconciled
boolean
(facultatif)
Interne : indique si la ressource a été rapprochée par le contrôleur.