monitoring.gdc.goog/v1
モニタリング グループの API スキーマ定義が含まれています。
AlertRule
アラートルールの構成を定義します。
表示場所: - MonitoringRuleSpec
| フィールド | 説明 |
|---|---|
alert 文字列 |
アラート名。値は有効なラベル値にする必要があります。 |
expr 文字列 |
アラート ルールを評価する PromQL 式または LogQL 式。 |
for 文字列 |
アラートを保留状態からオープン状態に移行するために、指定された条件を満たす必要がある期間（秒単位）。 |
labels オブジェクト（キー:文字列、値:文字列） |
追加または上書きするラベル。このフィールドの必須ラベルは、severity: [error, critical, warning, info]、code: <short code for the error>、resource: <component, service, or hardware related to the alert> です。追加のラベルは省略可能です。 |
annotations オブジェクト（キー:文字列、値:文字列） |
追加するアノテーション。 |
ClusterStatus
ClusterStatus は、特定のクラスタに影響する条件のリストです。
表示場所: - MonitoringTargetStatus
| フィールド | 説明 |
|---|---|
cluster 文字列 |
|
conditions 条件の配列 |
MonitoringRule
Monitoring Rules API のスキーマを定義します。
表示場所: - MonitoringRuleList
| フィールド | 説明 |
|---|---|
apiVersion 文字列 |
monitoring.gdc.goog/v1 |
kind 文字列 |
MonitoringRule |
metadata ObjectMeta |
metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。 |
spec MonitoringRuleSpec |
|
status MonitoringRuleStatus |
MonitoringRuleList
モニタリング ルールのリストが含まれます。
| フィールド | 説明 |
|---|---|
apiVersion 文字列 |
monitoring.gdc.goog/v1 |
kind 文字列 |
MonitoringRuleList |
metadata ListMeta |
metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。 |
items MonitoringRule 配列 |
MonitoringRuleSpec
MonitoringRule オブジェクトの仕様または想定される状態を定義します。
表示場所: - MonitoringRule
| フィールド | 説明 |
|---|---|
interval 文字列 |
ルールの評価間隔。 |
limit 整数 |
アラートの制限数。値 0 は上限がないことを意味します。 |
recordRules RecordRule の配列 |
レコードルールのリスト。 |
alertRules AlertRule の配列 |
アラートルールのリスト。 |
MonitoringRuleStatus
MonitoringRule オブジェクトの観測状態を定義します。
表示場所: - MonitoringRule
| フィールド | 説明 |
|---|---|
conditions 条件の配列 |
MonitoringRule オブジェクトの観測状態を定義します。 |
errorStatus ErrorStatus |
ErrorStatus には、現在のエラーのリストと、このフィールドが更新されたタイムスタンプが含まれます。 |
MonitoringTarget
モニタリング ターゲット API のスキーマを定義します。
表示場所: - MonitoringTargetList
| フィールド | 説明 |
|---|---|
apiVersion 文字列 |
monitoring.gdc.goog/v1 |
kind 文字列 |
MonitoringTarget |
metadata ObjectMeta |
metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。 |
spec MonitoringTargetSpec |
|
status MonitoringTargetStatus |
MonitoringTargetList
モニタリング ターゲットのリストが含まれます。
| フィールド | 説明 |
|---|---|
apiVersion 文字列 |
monitoring.gdc.goog/v1 |
kind 文字列 |
MonitoringTargetList |
metadata ListMeta |
metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。 |
items MonitoringTarget 配列 |
MonitoringTargetMetricsRelabeling
ラベルに基づいて指標を保持または破棄するフィルタを定義します。
表示場所: - MonitoringTargetPodMetricsEndpoints
| フィールド | 説明 |
|---|---|
sourceLabels 文字列配列 |
既存のラベルから選択された値。コンテンツは separator を使用して連結され、replace、keep、drop アクションの regex 式と照合されます。 |
separator 文字列 |
連結されたソースラベル値の間に配置される区切り文字の値。 |
regex 文字列 |
抽出された値と照合する正規表現。 |
action 文字列 |
regex 式が抽出された値と一致した場合に実行するアクション。 |
targetLabel 文字列 |
replace アクションで結果の値を書き込むラベル。このフィールドは replace アクションでは必須です。正規表現のキャプチャ グループを使用できます。 |
replacement 文字列 |
正規表現が replace アクションで抽出された値と一致した場合に使用する置換値。正規表現のキャプチャ グループを使用できます。 |
MonitoringTargetPodMetricsEndpoints
スクレイピングされた Pod の指標エンドポイントを構成します。
表示場所: - MonitoringTargetSpec
| フィールド | 説明 |
|---|---|
port MonitoringTargetPodMetricsPort |
指標がスクレイピングされるポート。 |
path MonitoringTargetPodMetricsPath |
指標がスクレイピングされるパス。 |
scheme MonitoringTargetPodMetricsScheme |
指標のスクレイピング時に使用するスキーム。 |
params オブジェクト（キー:文字列、値:文字列配列） |
path から指標をスクレイピングするときに使用するクエリ パラメータ。 |
scrapeInterval 文字列 |
podMetricsEndpoints フィールドで定義された指標エンドポイントを Prometheus が取得する頻度。 |
scrapeTimeout 文字列 |
Prometheus が podMetricsEndpoints フィールドで定義された指標エンドポイントからのレスポンスを待つ時間。 |
metricsRelabelings MonitoringTargetMetricsRelabeling 配列 |
ラベルに基づいて指標を含める（allowlist）か除外する（denylist）かのフィルタ。 |
ipAddresses 文字列配列 |
IPAddress は、スクレイピングする静的 IP アドレスを構成するためのものです。 |
tlsConfig TLSConfig |
カスタム TLS 構成を指定します。これは、スクレイピングが必要な Kubernetes 外部のワークロード用に提供されます。 |
authCredential 文字列 |
スクレイピング エンドポイントに提供する認証情報。 |
MonitoringTargetPodMetricsPath
Pod から指標をスクレイピングするために使用するパスを決定します。
表示場所: - MonitoringTargetPodMetricsEndpoints
| フィールド | 説明 |
|---|---|
value 文字列 |
指標を収集するパス。アノテーションが指定されている場合、このフィールドよりも優先されます。 |
annotation 文字列 |
アノテーションを使用して指標を収集するパス。 |
MonitoringTargetPodMetricsPort
Pod から指標を取得するために使用するポートを決定します。
表示場所: - MonitoringTargetPodMetricsEndpoints
| フィールド | 説明 |
|---|---|
value 整数 |
指標を収集するポート。アノテーションが指定されている場合、このフィールドよりも優先されます。 |
annotation 文字列 |
アノテーションを使用して指標を収集するポート。 |
MonitoringTargetPodMetricsScheme
Pod から指標をスクレイピングするために使用するスキームを決定します。
表示場所: - MonitoringTargetPodMetricsEndpoints
| フィールド | 説明 |
|---|---|
value 文字列 |
指標を収集するときに使用するスキーム。アノテーションが指定されている場合、このフィールドよりも優先されます。 |
annotation 文字列 |
アノテーションを使用して指標を収集するときに使用するスキーム。 |
MonitoringTargetSelectors
モニタリングする Pod を決定するセレクタを提供します。
表示場所: - MonitoringTargetSpec
| フィールド | 説明 |
|---|---|
matchClusters 文字列配列 |
このジョブで考慮するクラスタ。デフォルトの構成では、プロジェクトに適用可能なすべてのクラスタが考慮されます。異なるクラスタ間の関係は OR 関係です。たとえば、値 ["admin", "system"] は、管理クラスタ OR をシステム クラスタと見なすことを示します。 |
matchLabels オブジェクト（キー:文字列、値:文字列） |
このジョブで考慮する Pod ラベル。デフォルトの構成では、ラベルに基づくフィルタは考慮されません。異なるペア間の関係は AND 関係であるため、すべてのペアが考慮されます。 |
matchAnnotations オブジェクト（キー:文字列、値:文字列） |
このジョブで考慮するアノテーション。デフォルトの構成では、アノテーションに基づくフィルタは考慮されません。異なるペア間の関係は AND 関係であるため、すべてのペアが考慮されます。 |
MonitoringTargetSpec
MonitoringTarget オブジェクトの仕様または想定される状態を定義します。
表示場所: - MonitoringTarget
| フィールド | 説明 |
|---|---|
selector MonitoringTargetSelectors |
このジョブの Pod を識別する一致パターン。異なるセレクタ間の関係を確立するには、AND を使用します。 |
podMetricsEndpoints MonitoringTargetPodMetricsEndpoints |
このジョブ用に公開されたエンドポイント。エンドポイントは Prometheus のスタイルを使用します。 |
MonitoringTargetStatus
MonitoringTarget オブジェクトの観測状態を定義します。
表示場所: - MonitoringTarget
| フィールド | 説明 |
|---|---|
conditions 条件の配列 |
モニタリング スタックで検出された条件のリスト。 |
clusterStatuses ClusterStatus 配列 |
ClusterStatuses は、各クラスタと、そのクラスタのモニタリング スタックで観測された条件のリストです。 |
RecordRule
レコードルールの構成を定義します。
表示場所: - MonitoringRuleSpec
| フィールド | 説明 |
|---|---|
record 文字列 |
レコードルールを書き込む時系列。有効な指標名である必要があります。 |
expr 文字列 |
レコードルールを評価する PromQL 式または LogQL 式。 |
labels オブジェクト（キー:文字列、値:文字列） |
追加または上書きするラベル。 |
TLSConfig
表示場所: - MonitoringTargetPodMetricsEndpoints
| フィールド | 説明 |
|---|---|
ca 文字列 |
ターゲットに使用する CA 証明書のテキスト。 |
cert 文字列 |
ターゲットのクライアント証明書ファイルのテキスト。 |
server_name 文字列 |
ターゲットのホスト名の検証に使用されます。 |