KRM API monitoring.gdc.goog/v1

monitoring.gdc.goog/v1

Enthält API-Schemadefinitionen für die Monitoring-Gruppe.

AlertRule

Definiert die Konfiguration der Benachrichtigungsregeln.

Wird angezeigt in: - MonitoringRuleSpec

Feld Beschreibung
alert String Der Name der Benachrichtigung. Der Wert muss ein gültiger Labelwert sein.
expr String Der PromQL- oder LogQL-Ausdruck, mit dem die Benachrichtigungsregel ausgewertet wird.
for String Die Dauer in Sekunden, über die die angegebene Bedingung erfüllt sein muss, damit die Benachrichtigung vom Status „Ausstehend“ in den Status „Offen“ wechselt.
labels object (keys:string, values:string) Die Labels, die hinzugefügt oder überschrieben werden sollen. Die erforderlichen Labels in diesem Feld sind severity: [error, critical, warning, info], code: <short code for the error> und resource: <component, service, or hardware related to the alert>. Zusätzliche Labels sind optional.
annotations object (keys:string, values:string) Die hinzuzufügenden Annotationen.

ClusterStatus

ClusterStatus ist eine Liste von Bedingungen, die sich auf einen bestimmten Cluster auswirken.

Wird angezeigt in: - MonitoringTargetStatus

Feld Beschreibung
cluster String
conditions Condition-Array

MonitoringRule

Definiert das Schema für die Monitoring Rules API.

Wird angezeigt in: - MonitoringRuleList

Feld Beschreibung
apiVersion String monitoring.gdc.goog/v1
kind String MonitoringRule
metadata ObjectMeta Informationen zu den Feldern von metadata finden Sie in der Dokumentation zur Kubernetes API.
spec MonitoringRuleSpec
status MonitoringRuleStatus

MonitoringRuleList

Enthält eine Liste mit Überwachungsregeln.

Feld Beschreibung
apiVersion String monitoring.gdc.goog/v1
kind String MonitoringRuleList
metadata ListMeta Informationen zu den Feldern von metadata finden Sie in der Dokumentation zur Kubernetes API.
items MonitoringRule-Array

MonitoringRuleSpec

Definiert die Spezifikation oder den erwarteten Status des MonitoringRule-Objekts.

Wird angezeigt in: - MonitoringRule

Feld Beschreibung
interval String Das Regelauswertungsintervall.
limit Ganzzahl Die Anzahl der Benachrichtigungen ist begrenzt. Ein Wert von 0 bedeutet kein Limit.
recordRules RecordRule-Array Die Liste der Datensatzregeln.
alertRules AlertRule-Array Die Liste der Benachrichtigungsregeln.

MonitoringRuleStatus

Definiert den beobachteten Status des MonitoringRule-Objekts.

Wird angezeigt in: - MonitoringRule

Feld Beschreibung
conditions Condition-Array Definiert den beobachteten Status des MonitoringRule-Objekts.
errorStatus ErrorStatus „ErrorStatus“ enthält eine Liste der aktuellen Fehler und den Zeitstempel, zu dem dieses Feld aktualisiert wird.

MonitoringTarget

Definiert das Schema für die API für Monitoring-Ziele.

Wird angezeigt in: - MonitoringTargetList

Feld Beschreibung
apiVersion String monitoring.gdc.goog/v1
kind String MonitoringTarget
metadata ObjectMeta Informationen zu den Feldern von metadata finden Sie in der Dokumentation zur Kubernetes API.
spec MonitoringTargetSpec
status MonitoringTargetStatus

MonitoringTargetList

Enthält eine Liste mit Monitoringzielen.

Feld Beschreibung
apiVersion String monitoring.gdc.goog/v1
kind String MonitoringTargetList
metadata ListMeta Informationen zu den Feldern von metadata finden Sie in der Dokumentation zur Kubernetes API.
items MonitoringTarget-Array

MonitoringTargetMetricsRelabeling

Definiert einen Filter zum Beibehalten oder Verwerfen von Messwerten basierend auf Labels.

Wird angezeigt in: - MonitoringTargetPodMetricsEndpoints

Feld Beschreibung
sourceLabels String-Array Die ausgewählten Werte aus vorhandenen Labels. Die Inhalte werden mit separator verkettet und mit dem Ausdruck regex für die Aktionen replace, keep und drop abgeglichen.
separator String Das Trennzeichen zwischen verketteten Quelllabelwerten.
regex String Der reguläre Ausdruck, der mit dem extrahierten Wert abgeglichen werden soll.
action String Die Aktion, die ausgeführt werden soll, wenn der Ausdruck regex mit dem extrahierten Wert übereinstimmt.
targetLabel String Das Label, in das der resultierende Wert in einer replace-Aktion geschrieben werden soll. Dieses Feld ist für replace-Aktionen erforderlich. Gruppen für die Erfassung regulärer Ausdrücke sind verfügbar.
replacement String Der Ersatzwert, der verwendet werden soll, wenn der reguläre Ausdruck mit dem extrahierten Wert in einer replace-Aktion übereinstimmt. Gruppen für die Erfassung regulärer Ausdrücke sind verfügbar.

MonitoringTargetPodMetricsEndpoints

Konfiguriert die Messwertendpunkte für gescrapte Pods.

Wird angezeigt in: - MonitoringTargetSpec

Feld Beschreibung
port MonitoringTargetPodMetricsPort Der Port, von dem Messwerte erfasst werden.
path MonitoringTargetPodMetricsPath Der Pfad, aus dem Messwerte abgerufen werden.
scheme MonitoringTargetPodMetricsScheme Das Schema, das beim Erfassen von Messwerten verwendet werden soll.
params object (keys:string, values:string array) Die Abfrageparameter, die beim Abrufen von Messwerten aus der path verwendet werden sollen.
scrapeInterval String Die Häufigkeit, mit der Prometheus die im Feld podMetricsEndpoints definierten Messwert-Endpunkte abruft.
scrapeTimeout String Die Zeit, die Prometheus auf die Antwort von den im Feld podMetricsEndpoints definierten Messwert-Endpunkten wartet.
metricsRelabelings MonitoringTargetMetricsRelabeling-Array Der Filter zum Einbeziehen (allowlist) oder Ausschließen (denylist) von Messwerten basierend auf Labels.
ipAddresses String-Array Mit „IPAddress“ werden statische IP-Adressen für das Scraping konfiguriert.
tlsConfig TLSConfig Eine benutzerdefinierte TLS-Konfiguration angeben Dies wird für Arbeitslasten außerhalb von Kubernetes bereitgestellt, die erfasst werden müssen.
authCredential String Anmeldedaten, die für den Scraping-Endpunkt angegeben werden müssen.

MonitoringTargetPodMetricsPath

Legt den Pfad fest, der zum Erfassen von Messwerten aus Pods verwendet werden soll.

Wird angezeigt in: - MonitoringTargetPodMetricsEndpoints

Feld Beschreibung
value String Der Pfad, aus dem Messwerte erfasst werden sollen. Wenn Anmerkungen angegeben sind, haben sie Vorrang vor diesem Feld.
annotation String Der Pfad, aus dem Messwerte mithilfe von Annotationen erfasst werden sollen.

MonitoringTargetPodMetricsPort

Legt den Port fest, der zum Extrahieren von Messwerten aus Pods verwendet werden soll.

Wird angezeigt in: - MonitoringTargetPodMetricsEndpoints

Feld Beschreibung
value Ganzzahl Der Port, von dem Messwerte erfasst werden sollen. Wenn Anmerkungen angegeben sind, haben sie Vorrang vor diesem Feld.
annotation String Der Port, über den Messwerte mithilfe von Anmerkungen erfasst werden sollen.

MonitoringTargetPodMetricsScheme

Bestimmt das Schema, das zum Erfassen von Messwerten aus Pods verwendet werden soll.

Wird angezeigt in: - MonitoringTargetPodMetricsEndpoints

Feld Beschreibung
value String Das Schema, das beim Erfassen von Messwerten verwendet werden soll. Wenn Anmerkungen angegeben sind, haben sie Vorrang vor diesem Feld.
annotation String Das Schema, das beim Erfassen von Messwerten mit Annotationen verwendet werden soll.

MonitoringTargetSelectors

Bietet Selektoren, mit denen festgelegt wird, welche Pods überwacht werden sollen.

Wird angezeigt in: - MonitoringTargetSpec

Feld Beschreibung
matchClusters String-Array Die Cluster, die für diesen Job berücksichtigt werden sollen. In der Standardkonfiguration werden alle für das Projekt infrage kommenden Cluster berücksichtigt. Die Beziehung zwischen verschiedenen Clustern ist eine OR-Beziehung. Der Wert ["admin", "system"] gibt beispielsweise an, dass der Administratorcluster OR als Systemcluster betrachtet werden soll.
matchLabels object (keys:string, values:string) Die Pod-Labels, die für diesen Job berücksichtigt werden sollen. In der Standardkonfiguration wird kein Filter auf Grundlage von Labels berücksichtigt. Die Beziehung zwischen den verschiedenen Paaren ist eine AND-Beziehung, sodass alle Paare berücksichtigt werden.
matchAnnotations object (keys:string, values:string) Die für diesen Job zu berücksichtigenden Anmerkungen. In der Standardkonfiguration wird kein Filter auf Grundlage von Anmerkungen berücksichtigt. Die Beziehung zwischen den verschiedenen Paaren ist eine AND-Beziehung, sodass alle Paare berücksichtigt werden.

MonitoringTargetSpec

Definiert die Spezifikation oder den erwarteten Status des MonitoringTarget-Objekts.

Wird angezeigt in: - MonitoringTarget

Feld Beschreibung
selector MonitoringTargetSelectors Das übereinstimmende Muster, das Pods für diesen Job identifiziert. Verwenden Sie AND, um eine Beziehung zwischen verschiedenen Selektoren herzustellen.
podMetricsEndpoints MonitoringTargetPodMetricsEndpoints Der für diesen Job bereitgestellte Endpunkt. Der Endpunkt verwendet den Stil von Prometheus.

MonitoringTargetStatus

Definiert den beobachteten Status des MonitoringTarget-Objekts.

Wird angezeigt in: - MonitoringTarget

Feld Beschreibung
conditions Condition-Array Eine Liste der im Monitoring-Stack beobachteten Bedingungen.
clusterStatuses ClusterStatus-Array ClusterStatuses ist eine Liste der einzelnen Cluster und der Bedingungen, die im Monitoring-Stack für diesen Cluster beobachtet werden.

RecordRule

Definiert die Konfiguration der Datensatzregeln.

Wird angezeigt in: - MonitoringRuleSpec

Feld Beschreibung
record String Die Zeitreihe, in die die Datensatzregel geschrieben werden soll. Es muss ein gültiger Messwertname sein.
expr String Der PromQL- oder LogQL-Ausdruck, mit dem die Aufzeichnungsregel ausgewertet wird.
labels object (keys:string, values:string) Die Labels, die hinzugefügt oder überschrieben werden sollen.

TLSConfig

Wird angezeigt in: - MonitoringTargetPodMetricsEndpoints

Feld Beschreibung
ca String Text des CA-Zertifikats, das für die Ziele verwendet werden soll.
cert String Text der Clientzertifikatsdatei für die Ziele.
server_name String Wird verwendet, um den Hostnamen für die Ziele zu überprüfen.