规范架构
ObservabilityConfigSpec 定义了 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
字段 类型必需或可选 |
说明 |
|---|---|
customMetrics
| |
object必需 | 指定自定义指标配置。 |
customMetrics.definitions
| |
list (object)必需 | 自定义指标定义的列表。 |
customMetrics.definitions[].database
| |
string必需 | 要连接以进行此查询的数据库的名称。 |
customMetrics.definitions[].metricGroup
| |
string必需 | 用于对相关指标进行分组的名称。在最终指标名称中使用:alloydb_omni_custom_<metricGroup>_<metric_name>。 |
customMetrics.definitions[].metrics
| |
list (object)必需 | 要从查询结果中提取的指标的列表。 |
customMetrics.definitions[].metrics[].desc
| |
string必需 | 指标或标签的人类可读说明。 |
customMetrics.definitions[].metrics[].name
| |
string必需 | SQL 查询结果中的列的名称。这用作 Prometheus 指标名称的一部分或用作标签名称。 |
customMetrics.definitions[].metrics[].usage
| |
string必需 | 指定此列的使用方式。有效值为“label”“gauge”“counter”。 |
customMetrics.definitions[].query
| |
string必需 | 要执行的 SQL SELECT 语句。 |
customMetrics.resourceLimits
| |
object可选 | ResourceLimits 指定运行自定义查询的资源限制。 |
customMetrics.resourceLimits.maxParallelWorkers
| |
integer可选 | 指定查询的并行工作器的最大数量。将其设置为 0 会停用并行查询执行。 |
customMetrics.resourceLimits.statementTimeout
| |
string可选 | 指定任何语句运行所允许的最长时间。例如:“2s”。 |
customMetrics.resourceLimits.workMemory
| |
string可选 | 指定查询操作要使用的最大内存量。例如:“4MB”。 |
dbClusterRefs
| |
list (string)必需 | 受此 ObservabilityConfig 影响的 DBCluster 实例的引用列表。 |
状态架构
ObservabilityConfigStatus 定义了 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
字段 类型必需或可选 |
说明 |
|---|---|
conditions[]
| |
object可选 | 实体当前状态的最新可用观测结果的列表。 |
conditions[].lastTransitionTime
| |
string必需 | 条件上次从一种状态转换到另一种状态的时间。这应该是底层条件发生变化的时间。如果该信息未知,则可以使用 API 字段更改的时间。 |
conditions[].message
| |
string必需 | 描述转换的人类可读消息。此字段可以为空字符串。 |
conditions[].observedGeneration
| |
integer可选 | 此条件所基于的 .metadata.generation。例如,如果 .metadata.generation 为 12,但 .status.conditions[x].observedGeneration 为 9,则表示条件已过时,无法反映实例的当前状态。 |
conditions[].reason
| |
string必需 | 一个程序化标识符,用于指明条件上次转换的原因。特定条件类型的生成者可能会为此字段定义预期值和含义,以及这些值是否被视为稳定的 API。值必须是 CamelCase 字符串。此字段不得为空。 |
conditions[].status
| |
string必需 | 条件的状态(True、False 或 Unknown)。 |
conditions[].type
| |
string必需 | 条件的类型,采用 CamelCase 或 foo.example.com/CamelCase 形式。许多 .condition.type 值在各种资源中都是一致的,例如“Available”,但由于任意条件可能很有用(请参阅 .node.status.conditions),因此能够消除冲突非常重要。它匹配的正则表达式为 (dns1123SubdomainFmt/)?(qualifiedNameFmt)。 |
criticalIncidents
| |
list (object)可选 | 所有活跃严重突发事件的扁平列表。 |
criticalIncidents[]
| |
object可选 | 提供有关正在发生的严重突发事件的信息。 |
criticalIncidents[].code
| |
string必需 | 错误代码。错误代码是 DBSE+数字字符串,例如“DBSE1012”。 |
criticalIncidents[].createTime
| |
string必需 | 创建此突发事件的时间戳。 |
criticalIncidents[].message
| |
string可选 | Message 描述发生的突发事件或错误。 |
criticalIncidents[].messageTemplateParams
| |
object可选 | 在界面中生成用户友好的数据驱动型消息版本所需的键值对。 |
criticalIncidents[].resource
| |
object必需 | 有关报告突发事件的数据库服务组件的信息,以及有关 Cluster Manager 资源的信息。 |
criticalIncidents[].resource.component
| |
string必需 | 报告突发事件的数据库服务子系统的内部标识符。 |
criticalIncidents[].resource.location
| |
object可选 | 受影响资源的 Kubernetes 特定位置(例如集群、命名空间、种类和名称)。 |
criticalIncidents[].resource.location.cluster
| |
string可选 | 受影响资源的集群名称。 |
criticalIncidents[].resource.location.group
| |
string可选 | Cluster Manager 资源的组名称。 |
criticalIncidents[].resource.location.kind
| |
string可选 | 描述资源的种类。 |
criticalIncidents[].resource.location.name
| |
string可选 | 受影响资源的名称。 |
criticalIncidents[].resource.location.namespace
| |
string可选 | 受影响资源的命名空间。 |
criticalIncidents[].resource.location.version
| |
string可选 | 资源的版本。 |
criticalIncidents[].stackTrace
| |
object可选 | 来自堆栈轨迹的消息的非结构化列表。 |
criticalIncidents[].stackTrace.component
| |
string可选 | 记录消息的数据库服务组件的名称。 |
criticalIncidents[].stackTrace.message
| |
string可选 | 记录的消息。 |
criticalIncidents[].transientUntil
| |
string可选 | 如果存在,则表示必须将问题视为暂时性问题,直到指定的时间为止。 |
observedGeneration
| |
integer可选 | 内部:控制器观察到的生成。 |
reconciled
| |
boolean可选 | 资源是否由控制器进行了协调。 |