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 Condition 陣列 |
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 Condition 陣列 |
定義 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 字串 |
Prometheus 抓取 podMetricsEndpoints 欄位中定義的指標端點時的頻率。 |
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 Condition 陣列 |
監控堆疊中觀察到的條件清單。 |
clusterStatuses ClusterStatus 陣列 |
ClusterStatuses 是每個叢集的清單，以及在該叢集的監控堆疊中觀察到的條件。 |
RecordRule
定義記錄規則設定。
出現位置： - MonitoringRuleSpec
| 欄位 | 說明 |
|---|---|
record 字串 |
要寫入記錄規則的時間序列。必須是有效的指標名稱。 |
expr 字串 |
用於評估記錄規則的 PromQL 或 LogQL 運算式。 |
labels 物件 (鍵：字串，值：字串) |
要新增或覆寫的標籤。 |
TLSConfig
顯示位置： - MonitoringTargetPodMetricsEndpoints
| 欄位 | 說明 |
|---|---|
ca 字串 |
要用於目標的 CA 憑證文字。 |
cert 字串 |
目標的用戶端憑證檔案文字。 |
server_name 字串 |
用於驗證目標的主機名稱。 |