ObservabilityConfig カスタム リソース定義

仕様スキーマ

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
必須
この条件の最後の遷移の理由を示すプログラマティック 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[]
object
省略可
進行中の重大インシデントに関する情報を提供します。
criticalIncidents[].code
string
必須
エラーコード。エラーコードは DBSE と数値文字列で構成されます(例: DBSE1012)。
criticalIncidents[].createTime
string
必須
このインシデントが作成されたときのタイムスタンプ。
criticalIncidents[].message
string
省略可
message は、発生したインシデントまたはエラーの説明です。
criticalIncidents[].messageTemplateParams
object
省略可
ユーザー インターフェースでユーザー フレンドリーなデータドリブン バージョンのメッセージを生成するために必要な Key-Value ペア。
criticalIncidents[].resource
object
必須
インシデントを報告した Database Service コンポーネントに関する情報と、Cluster Manager リソースに関する情報。
criticalIncidents[].resource.component
string
必須
このインシデントを報告した Database Service サブシステムの内部識別子。
criticalIncidents[].resource.location
object
省略可
影響を受けるリソースの Kubernetes 固有の場所(クラスタ、Namespace、種類、名前など)。
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
省略可
影響を受けるリソースの Namespace。
criticalIncidents[].resource.location.version
string
省略可
リソースのバージョン。
criticalIncidents[].stackTrace
object
省略可
スタック トレースに含まれるメッセージの非構造化リスト。
criticalIncidents[].stackTrace.component
string
省略可
このメッセージをログに記録した Database Service コンポーネントの名前。
criticalIncidents[].stackTrace.message
string
省略可
ログに記録されたメッセージ。
criticalIncidents[].transientUntil
string
省略可
指定されている場合、その問題は指定された日時まで一時的な問題と見なされます。
observedGeneration
integer
省略可
内部: コントローラによって観測された世代。
reconciled
boolean
省略可
リソースがコントローラによって調整されたかどうか。