仕様スキーマ
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 は、カスタム指標の構成を指定します。 |
customMetrics.definitions
| |
list (object)必須 | definitions は、カスタム指標定義のリストです。 |
customMetrics.definitions[].database
| |
string必須 | database は、このクエリで接続するデータベースの名前です。 |
customMetrics.definitions[].metricGroup
| |
string必須 | MetricGroup は、関連する指標をグループ化する名前です。最終的な指標名（alloydb_omni_custom_<metricGroup>_<metric_name>）で使用されます。 |
customMetrics.definitions[].metrics
| |
list (object)必須 | metrics は、クエリ結果から抽出する指標のリストです。 |
customMetrics.definitions[].metrics[].desc
| |
string必須 | Desc は、指標またはラベルの説明（人が読める形式）です。 |
customMetrics.definitions[].metrics[].name
| |
string必須 | name は、SQL クエリ結果の列の名前です。これは、Prometheus 指標名の一部またはラベル名として使用されます。 |
customMetrics.definitions[].metrics[].usage
| |
string必須 | [Usage] では、この列の使用方法を指定します。有効な値は「label」、「gauge」、「counter」です。 |
customMetrics.definitions[].query
| |
string必須 | Query は、実行する SQL SELECT ステートメントです。 |
customMetrics.resourceLimits
| |
object省略可 | ResourceLimits は、カスタムクエリの実行に関するリソース上限を指定します。 |
customMetrics.resourceLimits.maxParallelWorkers
| |
integer省略可 | maxParallelWorkers は、クエリの並列ワーカーの最大数を指定します。0 に設定すると、並列クエリの実行が無効になります。 |
customMetrics.resourceLimits.statementTimeout
| |
string省略可 | StatementTimeout は、ステートメントの実行が許可される最大時間を指定します。例: 「2s」。 |
customMetrics.resourceLimits.workMemory
| |
string省略可 | WorkMemory は、クエリ オペレーションで使用される最大メモリ量を指定します。例: 「4MB」。 |
dbClusterRefs
| |
list (string)必須 | DBClusterRefs は、この ObservabilityConfig が適用される DBCluster の名前への参照のリストです。参照される DBCluster は同じ Namespace に存在する必要があります。 |
ステータス スキーマ
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
| |
list (object)省略可 | conditions は、エンティティの現在の状態について利用可能な最新の観測値を表します。 |
conditions[].lastTransitionTime
| |
string必須 | lastTransitionTime は、この条件があるステータスから別のステータスに最後に遷移した時刻です。これは、基本的な条件が変更されたときです。不明な場合は、API フィールドが変更された時刻を使用できます。 |
conditions[].message
| |
string必須 | message は、移行の詳細を示す人間が読めるメッセージです。空の文字列にすることもできます。 |
conditions[].observedGeneration
| |
integer省略可 | observedGeneration は、条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が 12 で、.status.conditions[x].observedGeneration が 9 の場合、その状態はインスタンスの現在の状態に関して古くなっています。 |
conditions[].reason
| |
string必須 | reason には、条件の最後の遷移の理由を示すプログラマティック ID が含まれます。特定の条件タイプのプロデューサーは、このフィールドの想定される値と意味、および値が保証付き 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 は、アクティブなすべての重大インシデントのフラットなリストです。 |
criticalIncidents[].code
| |
string必須 | この特定のエラーのエラーコード。エラーコードは DBSE と数値文字列で構成されます（例: DBSE1012）。 |
criticalIncidents[].createTime
| |
string必須 | このインシデントが発生元で作成されたときのタイムスタンプ。 |
criticalIncidents[].message
| |
string省略可 | message には、発生したインシデントまたはエラーの説明が含まれます。 |
criticalIncidents[].messageTemplateParams
| |
object省略可 | ユーザー インターフェースでユーザー フレンドリーなデータドリブン バージョンのメッセージを生成するために必要な Key-Value ペアが含まれます。 |
criticalIncidents[].resource
| |
object必須 | このインシデントを報告した Database Service コンポーネントに関する情報と、K8s リソースに関する情報が含まれます。 |
criticalIncidents[].resource.component
| |
string必須 | このインシデントを報告した Database Service サブシステムの内部識別子。 |
criticalIncidents[].resource.location
| |
object省略可 | 場所。 |
criticalIncidents[].resource.location.cluster
| |
string省略可 | 影響を受けた Kubernetes リソースのクラスタの名前。 |
criticalIncidents[].resource.location.group
| |
string省略可 | Kubernetes リソースのグループの名前。 |
criticalIncidents[].resource.location.kind
| |
string省略可 | Kubernetes リソースの Kind。 |
criticalIncidents[].resource.location.name
| |
string省略可 | 影響を受けた Kubernetes リソースの名前。 |
criticalIncidents[].resource.location.namespace
| |
string省略可 | 影響を受けた Kubernetes リソースの Namespace。 |
criticalIncidents[].resource.location.version
| |
string省略可 | Kubernetes リソースのバージョン。 |
criticalIncidents[].stackTrace
| |
list (object)省略可 | スタック トレースに含まれるメッセージの非構造化リスト。 |
criticalIncidents[].stackTrace[].component
| |
string省略可 | このメッセージをログに記録した Database Service コンポーネントの名前。 |
criticalIncidents[].stackTrace[].message
| |
string省略可 | ログ メッセージ。 |
criticalIncidents[].transientUntil
| |
string省略可 | 指定されている場合、その問題は指定された日時まで一時的な問題と見なされます。 |
observedGeneration
| |
integer省略可 | 内部: コントローラによって観測された世代。 |
reconciled
| |
boolean省略可 | Internal: リソースがコントローラによって調整されたかどうか。 |