ObservabilityConfig v1.7.0 custom resource definition

Select a documentation version:

Spec schema

ObservabilityConfigSpec defines the desired 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 		CustomMetrics specifies the custom metrics configuration.
customMetrics.definitions
list (object)
Required 		Definitions is a list of custom metric definitions.
customMetrics.definitions[].database
string
Required 		Database is the name of the database to connect to for this query.
customMetrics.definitions[].metricGroup
string
Required 		MetricGroup is a name to group related metrics. Used in the final metric name: alloydb_omni_custom__.
customMetrics.definitions[].metrics
list (object)
Required 		Metrics is a list of metrics to extract from the query result.
customMetrics.definitions[].metrics[].desc
string
Required 		Desc is a human-readable description of the metric or label.
customMetrics.definitions[].metrics[].name
string
Required 		Name is the name of the column in the SQL query result. This will be used as part of the Prometheus metric name or as a label name.
customMetrics.definitions[].metrics[].usage
string
Required 		Usage specifies how this column will be used. Valid values are "label", "gauge", "counter".
customMetrics.definitions[].query
string
Required 		Query is 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 		MaxParallelWorkers specifies the maximum number of parallel workers for a query. Setting to 0 disables parallel query execution.
customMetrics.resourceLimits.statementTimeout
string
Optional 		StatementTimeout specifies the maximum time allowed for any statement to run. Example: "2s".
customMetrics.resourceLimits.workMemory
string
Optional 		WorkMemory specifies the maximum amount of memory to be used by a query operation. Example: "4MB".
dbClusterRefs
list (string)
Required 		DBClusterRefs is a list of references to the names of the DBClusters this ObservabilityConfig applies to. The referenced DBClusters must be in the same namespace.

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
list (object)
Optional 		Conditions represents the latest available observations of the Entity's current state.
conditions[].lastTransitionTime
string
Required 		lastTransitionTime is 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 		message is a human readable message indicating details about the transition. This may be an empty string.
conditions[].observedGeneration
integer
Optional 		observedGeneration represents the .metadata.generation that the condition was set based upon. For example, if .metadata.generation is 12 but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
conditions[].reason
string
Required 		reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
conditions[].status
string
Required 		Status of the condition, one of True, False, Unknown.
conditions[].type
string
Required 		Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt).
criticalIncidents
list (object)
Optional 		CriticalIncidents is a flat list of all active Critical Incidents.
criticalIncidents[].code
string
Required 		The error code of this particular error. Error codes are DBSE+numeric strings, like "DBSE1012".
criticalIncidents[].createTime
string
Required 		The timestamp when this Incident was created at the origin.
criticalIncidents[].message
string
Optional 		Message describes the incident/error that occurred.
criticalIncidents[].messageTemplateParams
object
Optional 		Contains key-value pairs necessary for generating a user-friendly data-driven version of Message in the user interface.
criticalIncidents[].resource
object
Required 		Contains information about the Database Service component that reported the incident as well as about the K8s resource.
criticalIncidents[].resource.component
string
Required 		An internal identifier of the Database Service subsystem that reported the incident.
criticalIncidents[].resource.location
object
Optional 		Location.
criticalIncidents[].resource.location.cluster
string
Optional 		The name of the cluster of the affected Kubernetes resource.
criticalIncidents[].resource.location.group
string
Optional 		The Group name of the Kubernetes resource.
criticalIncidents[].resource.location.kind
string
Optional 		The Kind of the Kubernetes resource.
criticalIncidents[].resource.location.name
string
Optional 		The name of the affected Kubernetes resource.
criticalIncidents[].resource.location.namespace
string
Optional 		The namespace of the affected Kubernetes resource.
criticalIncidents[].resource.location.version
string
Optional 		The Version of the Kubernetes resource.
criticalIncidents[].stackTrace
list (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 should be considered transient until the specified time.
observedGeneration
integer
Optional 		Internal: The generation observed by the controller.
reconciled
boolean
Optional 		Internal: Whether the resource was reconciled by the controller.