ObservabilityConfig Custom Resource Definition

Spec schema

ObservabilityConfigSpec defines the selected state of 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

Field Type Required or optional	Description
customMetrics
object Required	Specifies the custom metrics configuration.
customMetrics.definitions
list (object) Required	A list of custom metric definitions.
customMetrics.definitions[].database
string Required	The name of the database to connect to for this query.
customMetrics.definitions[].metricGroup
string Required	A name used to group related metrics. Used in the final metric name: alloydb_omni_custom_<metricGroup>_<metric_name>.
customMetrics.definitions[].metrics
list (object) Required	A list of metrics to extract from the query result.
customMetrics.definitions[].metrics[].desc
string Required	A human-readable description of the metric or label.
customMetrics.definitions[].metrics[].name
string Required	The name of the column in the SQL query result. This is used as part of the Prometheus metric name or as a label name.
customMetrics.definitions[].metrics[].usage
string Required	Specifies how this column is used. Valid values are "label", "gauge", "counter".
customMetrics.definitions[].query
string Required	The SQL SELECT statement to execute.
customMetrics.resourceLimits
object Optional	ResourceLimits specifies the resource limits for running the custom queries.
customMetrics.resourceLimits.maxParallelWorkers
integer Optional	Specifies the maximum number of parallel workers for a query. Setting this to 0 disables parallel query execution.
customMetrics.resourceLimits.statementTimeout
string Optional	Specifies the maximum time allowed for any statement to run. For example: "2s".
customMetrics.resourceLimits.workMemory
string Optional	Specifies the maximum amount of memory to be used by a query operation. For example: "4MB".
dbClusterRefs
list (string) Required	List of references to DBCluster instances affected by this ObservabilityConfig.

Status schema

ObservabilityConfigStatus defines the observed state of 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

Field Type Required or optional	Description
conditions[]
object Optional	List of the latest available observations of the entity's current state.
conditions[].lastTransitionTime
string Required	The last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
conditions[].message
string Required	A human readable message describing the transition. This can be an empty string.
conditions[].observedGeneration
integer Optional	The .metadata.generation on which this condition is based. For example, if .metadata.generation is 12, but .status.conditions[x].observedGeneration is 9, then the condition is stale and doesn't reflect the current state of the instance.
conditions[].reason
string Required	A programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types might define expected values and meanings for this field, and whether the values are considered a stable API. The value must be a CamelCase string. This field must not be empty.
conditions[].status
string Required	The status of the condition (True, False, or Unknown).
conditions[].type
string Required	Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources, for example "Available", but because arbitrary conditions might be useful (see .node.status.conditions), the ability to deconflict is important. The regular expression it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt).
criticalIncidents
list (object) Optional	A flat list of all active critical incidents.
criticalIncidents[]
object Optional	Provides information about an ongoing critical incident.
criticalIncidents[].code
string Required	The error code. Error codes are DBSE+numeric strings, like "DBSE1012".
criticalIncidents[].createTime
string Required	The timestamp when this incident was created.
criticalIncidents[].message
string Optional	Message describes the incident or error that occurred.
criticalIncidents[].messageTemplateParams
object Optional	The key-value pair necessary for generating a user-friendly data-driven version of the message in the user interface.
criticalIncidents[].resource
object Required	Information about the Database Service component that reported the incident, as well as information about the Cluster Manager resource.
criticalIncidents[].resource.component
string Required	An internal identifier of the Database Service subsystem that reported the incident.
criticalIncidents[].resource.location
object Optional	The Kubernetes-specific location (such as cluster, namespace, kind, and name) of the affected resource.
criticalIncidents[].resource.location.cluster
string Optional	The name of the cluster of the affected resource.
criticalIncidents[].resource.location.group
string Optional	The group name of the Cluster Manager resource.
criticalIncidents[].resource.location.kind
string Optional	Describes the kind of resource.
criticalIncidents[].resource.location.name
string Optional	The name of the affected resource.
criticalIncidents[].resource.location.namespace
string Optional	The namespace of the affected resource.
criticalIncidents[].resource.location.version
string Optional	The version of the resource.
criticalIncidents[].stackTrace
object Optional	An unstructured list of messages from the stack trace.
criticalIncidents[].stackTrace.component
string Optional	The name of a Database Service component that logged the message.
criticalIncidents[].stackTrace.message
string Optional	Logged message.
criticalIncidents[].transientUntil
string Optional	If present, indicates that the issue must be considered transient until the specified time.
observedGeneration
integer Optional	Internal: The generation observed by the controller.
reconciled
boolean Optional	Whether the resource was reconciled by the controller.