14 Cluster-Management APIs

14.1 Überblick

Die Cluster-Management APIs bieten wesentliche Werkzeuge zur Überwachung und Verwaltung von OpenSearch-Clustern. Diese APIs wurden mit OpenSearch 1.0 eingeführt und umfassen drei Hauptkomponenten: Cluster-Gesundheit, Cluster-Statistiken und Cluster-Einstellungen.

14.2 Cluster-Gesundheit API

14.2.1 Beschreibung

Die Cluster-Gesundheit API ermöglicht die grundlegende Überwachung des Gesundheitszustands Ihres Clusters. OpenSearch verwendet drei Farben zur Darstellung des Gesundheitszustands:

Grün: Alle primären Shards und ihre Replikate sind Knoten zugewiesen
Gelb: Alle primären Shards sind zugewiesen, aber einige Replikate nicht
Rot: Mindestens ein primärer Shard ist keinem Knoten zugewiesen

14.2.2 Basis-Endpunkte

GET _cluster/health
GET _cluster/health/<index>

14.2.3 Wichtige Abfrageparameter

Parameter	Typ	Beschreibung
level	Enum	Detailgrad der Gesundheitsinformationen (cluster, indices, shards, awareness_attributes)
wait_for_status	Enum	Warten auf bestimmten Status (green, yellow, red)
wait_for_nodes	String	Warten auf N Knoten (z.B. “12” für exakt, “>12” oder “<12” für Bereich)
timeout	Time	Wartezeit auf Antwort (Standard: 30s)
wait_for_active_shards	String	Warten auf Anzahl aktiver Shards (Standard: 0)
wait_for_events	Enum	Warten auf Events in der Warteschlange (immediate, urgent, high, normal, low, languid)

14.3 Cluster-Statistiken API

14.3.1 Beschreibung

Liefert detaillierte Statistiken über den aktuellen Zustand Ihres Clusters, einschließlich:

Knoteninformationen
Index-Statistiken
Shard-Zuweisungen
JVM-Nutzung
Speicherstatus
Dateisysteminformationen
Plugin-Details

14.3.2 Endpunkte

GET _cluster/stats
GET _cluster/stats/nodes/<node-filters>
GET _cluster/stats/<metric>/nodes/<node-filters>

14.3.3 Verfügbare Metriken

indices: Index-bezogene Statistiken
os: Betriebssystem-Statistiken
process: Prozess-Statistiken
jvm: JVM-Statistiken
fs: Dateisystem-Nutzung
plugins: Plugin-Informationen
network_types: Netzwerkverbindungsinformationen
discovery_type: Knotenerkennungsmethode
ingest: Pipeline-Statistiken

14.4 Cluster-Einstellungen API

14.4.1 Beschreibung

Ermöglicht das Prüfen und Ändern clusterweiter Einstellungen. Änderungen gelten für alle Knoten im Cluster.

14.4.2 Endpunkte

GET _cluster/settings
PUT _cluster/settings

14.4.3 Einstellungstypen

Persistent: Einstellungen, die Cluster-Neustarts überdauern
Transient: Temporäre Einstellungen, die sich nach einem Neustart zurücksetzen

14.4.4 Beispiel für Einstellungsänderung

PUT _cluster/settings
{
  "persistent": {
    "cluster.max_shards_per_node": 500
  }
}

14.5 Statusfarben und ihre Bedeutung

Der Cluster-Gesundheitsstatus wird durch drei Farben dargestellt:

Farbe	Bedeutung
Grün	Alle primären Shards und Replikate sind aktiv
Gelb	Alle primären Shards sind aktiv, aber einige Replikate fehlen
Rot	Ein oder mehrere primäre Shards sind nicht aktiv

14.6 Sicherheitsaspekte

Bei Verwendung des Security-Plugins müssen folgende Berechtigungen vorhanden sein: - Für die Health-API: cluster:monitor/health - Für die Stats-API: Entsprechende Cluster-Überwachungsberechtigungen - Für die Settings-API: Cluster-Verwaltungsberechtigungen

14.7 Bewährte Praktiken

Regelmäßige Gesundheitsüberwachung
- Überwachen Sie den Cluster-Gesundheitsstatus regelmäßig
- Richten Sie Benachrichtigungen für Statusänderungen ein
- Achten Sie auf nicht zugewiesene Shards
Einstellungsverwaltung
- Verwenden Sie persistente Einstellungen für langfristige Änderungen
- Dokumentieren Sie alle Einstellungsänderungen
- Testen Sie Änderungen zuerst in Nicht-Produktionsumgebungen
Leistungsoptimierung
- Überwachen Sie Cluster-Statistiken auf Leistungsengpässe
- Verfolgen Sie Speichernutzung und JVM-Metriken
- Behalten Sie die Shard-Verteilung im Auge

14.8 Praktische Anwendungsbeispiele

14.8.1 Überwachung der Cluster-Gesundheit

# Basis-Gesundheitsprüfung
GET _cluster/health

# Detaillierte Gesundheitsinformationen auf Index-Ebene
GET _cluster/health?level=indices

# Warten auf grünen Status mit Timeout
GET _cluster/health?wait_for_status=green&timeout=50s

14.8.2 Abfragen von Cluster-Statistiken

# Allgemeine Cluster-Statistiken
GET _cluster/stats

# Spezifische Metriken für bestimmte Knoten
GET _cluster/stats/jvm,fs/nodes/_all

14.8.3 Verwalten von Cluster-Einstellungen

# Aktuelle Einstellungen prüfen
GET _cluster/settings?include_defaults=true

# Persistente Einstellung ändern
PUT _cluster/settings
{
  "persistent": {
    "cluster.routing.allocation.disk.watermark.low": "85%"
  }
}