iWay Knowledge Base - Benutzerbeiträge [de-ch]

Opensearch

2026-02-05T08:28:03Z

Andrew.willi:

<div class="databox">
<div class="tbl">
{|
|-
!Anwendung:
|OpenSearch
|}
</div>
<div class="tbl">
{|
|-
!Status:
|'''Entwurf'''/ freigegeben
|}
</div>
</div>

==Ziel==
Diese Anleitung richtet automatisches Index-Lifecycle-Management ein:

*'''Rollover''': Neuen Index erstellen wenn Bedingungen erfüllt sind (Alter + Dokumentenanzahl)
*'''Löschen''': Alte Indizes nach einer Aufbewahrungsfrist entfernen

<pre>
provisioning_v2-000001 → Rollover → provisioning_v2-000002 → Rollover → ...
↓ (3h später)
LÖSCHEN
</pre>

==Voraussetzungen und Vorbereitung==
*Zugang zu OpenSearch Cluster (Admin-Rechte)
*OpenSearch Dashboard oder API-Zugang (z.B. via curl oder Dev Tools)
*Python-Anwendung mit <code>opensearch-logger</code> Bibliothek

==Vorgang 1: Index-Lifecycle einrichten==
Erstellung der ISM-Policy, Index-Template und des initialen Index für automatisches Rollover und Löschen.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|ISM-Policy erstellen
|Definiert Rollover- und Lösch-Bedingungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Index-Template erstellen
|Stellt korrekte Einstellungen für neue Indizes sicher
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Initialen Index erstellen
|Erster Index mit korrekter Benennung
|-
| style="vertical-align:middle;text-align:center;width:80px;" |4
|Write-Alias hinzufügen
|Alias für Schreiboperationen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |5
|Rollover-Alias am Index setzen
|Index mit Alias verknüpfen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |6
|Policy an Index anhängen
|Lifecycle-Management aktivieren
|}

===Schritt-für-Schritt Anleitung===
'''Note: Unter Management/Dev tools kann man die Befehle einfügen und ausführen'''
#'''Erstellen''' Sie die '''ISM-Policy''' (JSON editor oder Visual editor):[[Datei:ISM-Policy Dashboard.png|none|1210x1210px]]
#:
#:<syntaxhighlight lang="json">
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}
</syntaxhighlight>
#:'''Bedingungen:'''
#:*<code>min_index_age: 1h</code> - Index muss ≥1 Stunde alt sein
#:*<code>min_rollover_age: 3h</code> - Löschen 3 Stunden nach Rollover
#:'''Hinweis:''' Rollover-Bedingungen sind '''keine''' UND Bedingung. Wenn man zum Beispiel <code>min''index''age</code> und <code>min_<u>''doc_''count</u></code> und eines davon die Bedingung erfüllt, wird das Rollover ausgeführt<br />
#'''Erstellen''' Sie das '''Index-Template''':[[Datei:Index-Template.png|none|976x976px]]
#:<syntaxhighlight lang="json">
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}
</syntaxhighlight>
#:
#'''Erstellen''' Sie den '''initialen Index (Visual editor wurde nicht mehr genutzt, weil es mühsam ist)''':
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001
</syntaxhighlight>
#:Der Index muss mit einer Nummer enden (z.B. -000001).
#'''Fügen''' Sie den '''Write-Alias''' hinzu:
#:<syntaxhighlight lang="json">
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}
</syntaxhighlight>
#'''Setzen''' Sie den '''Rollover-Alias''' am Index:
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
</syntaxhighlight>
#'''Hängen''' Sie die '''Policy''' an den Index an:
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight> '''Alle Befehle in Reihenfolge'''<syntaxhighlight lang="json">
// 1. Policy erstellen
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}

// 2. Template erstellen
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}

// 3. Initialen Index erstellen
PUT provisioning_v2-000001

// 4. Write-Alias hinzufügen
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}

// 5. Rollover-Alias am Index setzen
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}

// 6. Policy anhängen
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>

==Vorgang 2: Anwendung konfigurieren==
Konfiguration der Python-Anwendung zur Verwendung des Alias anstelle von datumsbasierten Indizes.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Logging-Konfiguration anpassen
|index_rotate auf NEVER setzen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Anwendung neu starten
|Änderungen aktivieren
|}

===Schritt-für-Schritt Anleitung===

#'''Passen''' Sie die '''settings.py''' an:
#:<syntaxhighlight lang="python">
'opensearch': {
"level": 'DEBUG',
"class": 'opensearch_logger.OpenSearchHandler',
"index_name": "provisioning_v2", # Schreibe zum Alias
"index_rotate": "NEVER", # Datums-Suffix deaktivieren
"hosts": [{"host": OPENSEARCH_LOGGING_SERVER, "port": 9200}],
"http_auth": ("admin", "admin"),
"http_compress": True,
"filters": ['correlation_id'],
},
</syntaxhighlight>
#'''Starten''' Sie die '''Anwendung neu'''

==Vorgang 3: Überprüfung und Fehlerbehebung==
Befehle zur Überprüfung des Status und zur Fehlerbehebung.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Indizes prüfen
|Alle provisioning Indizes anzeigen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Alias prüfen
|Alias-Konfiguration verifizieren
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Policy-Status prüfen
|ISM-Status aller Indizes anzeigen
|}

===Überprüfungs-Befehle===

#'''Alle Indizes anzeigen''':
#:<syntaxhighlight lang="json">
GET _cat/indices/provisioning_v2-*?v&h=index,docs.count,creation.date.string
</syntaxhighlight>
#'''Alias-Konfiguration prüfen''':
#:<syntaxhighlight lang="json">
GET _alias/provisioning_v2
</syntaxhighlight>
#'''Policy-Status prüfen''':
#:<syntaxhighlight lang="json">
GET _plugins/_ism/explain/provisioning_v2-*
</syntaxhighlight>

===Fehlerbehebungs-Befehle===

#'''Bei Rollover-Fehler manuell wiederholen''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/retry/provisioning_v2-000001
</syntaxhighlight>
#'''Policy an Index anhängen''' (falls nicht angehängt):
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Aktualisierte Policy auf bestehende Indizes anwenden''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/change_policy/provisioning_v2-*
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Manueller Rollover erzwingen''' (umgeht Bedingungen):
#:<syntaxhighlight lang="json">
POST provisioning_v2/_rollover
</syntaxhighlight>

=== Index Pattern erstellen ===
Dashboards Management -> Index pattern -> Create index pattern

[[Datei:Index_pattern_OpenSearch_Dashboards.png|alternativtext=Index Pattern erstellen|rahmenlos|1083x1083px]]

==Häufige Fehler==

{| class="wikitable" style="width:100%;"
!Fehler
!Ursache
!Lösung
|-
|<code>Missing rollover_alias index setting</code>
|Index weiss nicht welchen Alias verwenden
|<code>PUT index/_settings</code> mit rollover_alias
|-
|<code>duplicated alias in index template</code>
|Template hat <code>aliases</code> Abschnitt
|<code>aliases</code> aus Template entfernen
|-
|<code>Conditions not met</code>
|min_doc_count UND min_index_age nicht beide erfüllt
|Warten, oder Schwellwerte zum Testen senken
|-
|<code>alias name conflicts with index</code>
|Index und Alias haben gleichen Namen
|Index löschen oder anderen Alias-Namen verwenden
|}

==Lifecycle-Ablauf==

<pre>
1. App schreibt zum Alias "provisioning_v2"
↓
2. Alias zeigt auf aktuellen Index (z.B. -000001)
↓
3. Wenn ≥5 Dokumente UND ≥1h alt → ROLLOVER
↓
4. Neuer Index erstellt (-000002), Alias wird verschoben
↓
5. Alter Index wartet im "rollover" Zustand
↓
6. Nach 3h seit Rollover → ÜBERGANG zu delete
↓
7. Index wird GELÖSCHT
</pre>
[[Kategorie:Opensearch]]

Opensearch

2026-02-05T08:23:41Z

Andrew.willi:

Opensearch

2026-02-05T08:22:18Z

Andrew.willi:

<div class="databox">
<div class="tbl">
{|
|-
!Anwendung:
|OpenSearch
|}
</div>
<div class="tbl">
{|
|-
!Status:
|'''Entwurf'''/ freigegeben
|}
</div>
</div>

==Ziel==
Diese Anleitung richtet automatisches Index-Lifecycle-Management ein:

*'''Rollover''': Neuen Index erstellen wenn Bedingungen erfüllt sind (Alter + Dokumentenanzahl)
*'''Löschen''': Alte Indizes nach einer Aufbewahrungsfrist entfernen

<pre>
provisioning_v2-000001 → Rollover → provisioning_v2-000002 → Rollover → ...
↓ (3h später)
LÖSCHEN
</pre>

==Voraussetzungen und Vorbereitung==
*Zugang zu OpenSearch Cluster (Admin-Rechte)
*OpenSearch Dashboard oder API-Zugang (z.B. via curl oder Dev Tools)
*Python-Anwendung mit <code>opensearch-logger</code> Bibliothek

==Vorgang 1: Index-Lifecycle einrichten==
Erstellung der ISM-Policy, Index-Template und des initialen Index für automatisches Rollover und Löschen.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|ISM-Policy erstellen
|Definiert Rollover- und Lösch-Bedingungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Index-Template erstellen
|Stellt korrekte Einstellungen für neue Indizes sicher
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Initialen Index erstellen
|Erster Index mit korrekter Benennung
|-
| style="vertical-align:middle;text-align:center;width:80px;" |4
|Write-Alias hinzufügen
|Alias für Schreiboperationen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |5
|Rollover-Alias am Index setzen
|Index mit Alias verknüpfen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |6
|Policy an Index anhängen
|Lifecycle-Management aktivieren
|}

===Schritt-für-Schritt Anleitung===
'''Note: Unter Management/Dev tools kann man die Befehle einfügen und ausführen'''
#'''Erstellen''' Sie die '''ISM-Policy''' (JSON editor oder Visual editor):[[Datei:ISM-Policy Dashboard.png|none|1210x1210px]]
#:
#:<syntaxhighlight lang="json">
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}
</syntaxhighlight>
#:'''Bedingungen:'''
#:*<code>min_index_age: 1h</code> - Index muss ≥1 Stunde alt sein
#:*<code>min_rollover_age: 3h</code> - Löschen 3 Stunden nach Rollover
#:'''Hinweis:''' Rollover-Bedingungen sind '''keine''' UND Bedingung. Wenn man zum Beispiel <code>min''index''age</code> und <code>min_<u>''doc_''count</u></code> und eines davon die Bedingung erfüllt, wird das Rollover ausgeführt<br />
#'''Erstellen''' Sie das '''Index-Template''':[[Datei:Index-Template.png|none|976x976px]]
#:<syntaxhighlight lang="json">
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}
</syntaxhighlight>
#:
#'''Erstellen''' Sie den '''initialen Index (Visual editor wurde nicht mehr genutzt, weil es mühsam ist)''':
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001
</syntaxhighlight>
#:Der Index muss mit einer Nummer enden (z.B. -000001).
#'''Fügen''' Sie den '''Write-Alias''' hinzu:
#:<syntaxhighlight lang="json">
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}
</syntaxhighlight>
#'''Setzen''' Sie den '''Rollover-Alias''' am Index:
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
</syntaxhighlight>
#'''Hängen''' Sie die '''Policy''' an den Index an:
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight> '''Alle Befehle in Reihenfolge'''<syntaxhighlight lang="json">
// 1. Policy erstellen
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}

// 2. Template erstellen
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}

// 3. Initialen Index erstellen
PUT provisioning_v2-000001

// 4. Write-Alias hinzufügen
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}

// 5. Rollover-Alias am Index setzen
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}

// 6. Policy anhängen
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>

==Vorgang 2: Anwendung konfigurieren==
Konfiguration der Python-Anwendung zur Verwendung des Alias anstelle von datumsbasierten Indizes.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Logging-Konfiguration anpassen
|index_rotate auf NEVER setzen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Anwendung neu starten
|Änderungen aktivieren
|}

===Schritt-für-Schritt Anleitung===

#'''Passen''' Sie die '''settings.py''' an:
#:<syntaxhighlight lang="python">
'opensearch': {
"level": 'DEBUG',
"class": 'opensearch_logger.OpenSearchHandler',
"index_name": "provisioning_v2", # Schreibe zum Alias
"index_rotate": "NEVER", # Datums-Suffix deaktivieren
"hosts": [{"host": OPENSEARCH_LOGGING_SERVER, "port": 9200}],
"http_auth": ("admin", "admin"),
"http_compress": True,
"filters": ['correlation_id'],
},
</syntaxhighlight>
#'''Starten''' Sie die '''Anwendung neu'''

==Vorgang 3: Überprüfung und Fehlerbehebung==
Befehle zur Überprüfung des Status und zur Fehlerbehebung.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Indizes prüfen
|Alle provisioning Indizes anzeigen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Alias prüfen
|Alias-Konfiguration verifizieren
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Policy-Status prüfen
|ISM-Status aller Indizes anzeigen
|}

===Überprüfungs-Befehle===

#'''Alle Indizes anzeigen''':
#:<syntaxhighlight lang="json">
GET _cat/indices/provisioning_v2-*?v&h=index,docs.count,creation.date.string
</syntaxhighlight>
#'''Alias-Konfiguration prüfen''':
#:<syntaxhighlight lang="json">
GET _alias/provisioning_v2
</syntaxhighlight>
#'''Policy-Status prüfen''':
#:<syntaxhighlight lang="json">
GET _plugins/_ism/explain/provisioning_v2-*
</syntaxhighlight>

===Fehlerbehebungs-Befehle===

#'''Bei Rollover-Fehler manuell wiederholen''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/retry/provisioning_v2-000001
</syntaxhighlight>
#'''Policy an Index anhängen''' (falls nicht angehängt):
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Aktualisierte Policy auf bestehende Indizes anwenden''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/change_policy/provisioning_v2-*
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Manueller Rollover erzwingen''' (umgeht Bedingungen):
#:<syntaxhighlight lang="json">
POST provisioning_v2/_rollover
</syntaxhighlight>

=== Index Pattern erstellen ===
Dashboards Management -> Index pattern -> Create index pattern

[[Datei:Index pattern OpenSearch Dashboards.png|links|rahmenlos|1083x1083px|Index Pattern erstellen]]

==Häufige Fehler==

{| class="wikitable" style="width:100%;"
!Fehler
!Ursache
!Lösung
|-
|<code>Missing rollover_alias index setting</code>
|Index weiss nicht welchen Alias verwenden
|<code>PUT index/_settings</code> mit rollover_alias
|-
|<code>duplicated alias in index template</code>
|Template hat <code>aliases</code> Abschnitt
|<code>aliases</code> aus Template entfernen
|-
|<code>Conditions not met</code>
|min_doc_count UND min_index_age nicht beide erfüllt
|Warten, oder Schwellwerte zum Testen senken
|-
|<code>alias name conflicts with index</code>
|Index und Alias haben gleichen Namen
|Index löschen oder anderen Alias-Namen verwenden
|}

==Lifecycle-Ablauf==

<pre>
1. App schreibt zum Alias "provisioning_v2"
↓
2. Alias zeigt auf aktuellen Index (z.B. -000001)
↓
3. Wenn ≥5 Dokumente UND ≥1h alt → ROLLOVER
↓
4. Neuer Index erstellt (-000002), Alias wird verschoben
↓
5. Alter Index wartet im "rollover" Zustand
↓
6. Nach 3h seit Rollover → ÜBERGANG zu delete
↓
7. Index wird GELÖSCHT
</pre>

Datei:Index pattern OpenSearch Dashboards.png

2026-02-05T08:21:04Z

Andrew.willi:

Opensearch

2026-01-29T15:02:29Z

Andrew.willi:

<div class="databox">
<div class="tbl">
{|
|-
!Anwendung:
|OpenSearch
|}
</div>
<div class="tbl">
{|
|-
!Status:
|'''Entwurf'''/ freigegeben
|}
</div>
</div>

==Ziel==
Diese Anleitung richtet automatisches Index-Lifecycle-Management ein:

*'''Rollover''': Neuen Index erstellen wenn Bedingungen erfüllt sind (Alter + Dokumentenanzahl)
*'''Löschen''': Alte Indizes nach einer Aufbewahrungsfrist entfernen

<pre>
provisioning_v2-000001 → Rollover → provisioning_v2-000002 → Rollover → ...
↓ (3h später)
LÖSCHEN
</pre>

==Voraussetzungen und Vorbereitung==
*Zugang zu OpenSearch Cluster (Admin-Rechte)
*OpenSearch Dashboard oder API-Zugang (z.B. via curl oder Dev Tools)
*Python-Anwendung mit <code>opensearch-logger</code> Bibliothek

==Vorgang 1: Index-Lifecycle einrichten==
Erstellung der ISM-Policy, Index-Template und des initialen Index für automatisches Rollover und Löschen.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|ISM-Policy erstellen
|Definiert Rollover- und Lösch-Bedingungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Index-Template erstellen
|Stellt korrekte Einstellungen für neue Indizes sicher
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Initialen Index erstellen
|Erster Index mit korrekter Benennung
|-
| style="vertical-align:middle;text-align:center;width:80px;" |4
|Write-Alias hinzufügen
|Alias für Schreiboperationen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |5
|Rollover-Alias am Index setzen
|Index mit Alias verknüpfen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |6
|Policy an Index anhängen
|Lifecycle-Management aktivieren
|}

===Schritt-für-Schritt Anleitung===
'''Note: Unter Management/Dev tools kann man die Befehle einfügen und ausführen'''
#'''Erstellen''' Sie die '''ISM-Policy''' (JSON editor oder Visual editor):[[Datei:ISM-Policy Dashboard.png|none|1210x1210px]]
#:
#:<syntaxhighlight lang="json">
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}
</syntaxhighlight>
#:'''Bedingungen:'''
#:*<code>min_index_age: 1h</code> - Index muss ≥1 Stunde alt sein
#:*<code>min_rollover_age: 3h</code> - Löschen 3 Stunden nach Rollover
#:'''Hinweis:''' Rollover-Bedingungen sind '''keine''' UND Bedingung. Wenn man zum Beispiel <code>min''index''age</code> und <code>min_<u>''doc_''count</u></code> und eines davon die Bedingung erfüllt, wird das Rollover ausgeführt<br />
#'''Erstellen''' Sie das '''Index-Template''':[[Datei:Index-Template.png|none|976x976px]]
#:<syntaxhighlight lang="json">
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}
</syntaxhighlight>
#:
#'''Erstellen''' Sie den '''initialen Index (Visual editor wurde nicht mehr genutzt, weil es mühsam ist)''':
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001
</syntaxhighlight>
#:Der Index muss mit einer Nummer enden (z.B. -000001).
#'''Fügen''' Sie den '''Write-Alias''' hinzu:
#:<syntaxhighlight lang="json">
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}
</syntaxhighlight>
#'''Setzen''' Sie den '''Rollover-Alias''' am Index:
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
</syntaxhighlight>
#'''Hängen''' Sie die '''Policy''' an den Index an:
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight> '''Alle Befehle in Reihenfolge'''<syntaxhighlight lang="json">
// 1. Policy erstellen
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}

// 2. Template erstellen
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}

// 3. Initialen Index erstellen
PUT provisioning_v2-000001

// 4. Write-Alias hinzufügen
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}

// 5. Rollover-Alias am Index setzen
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}

// 6. Policy anhängen
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>

==Vorgang 2: Anwendung konfigurieren==
Konfiguration der Python-Anwendung zur Verwendung des Alias anstelle von datumsbasierten Indizes.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Logging-Konfiguration anpassen
|index_rotate auf NEVER setzen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Anwendung neu starten
|Änderungen aktivieren
|}

===Schritt-für-Schritt Anleitung===

#'''Passen''' Sie die '''settings.py''' an:
#:<syntaxhighlight lang="python">
'opensearch': {
"level": 'DEBUG',
"class": 'opensearch_logger.OpenSearchHandler',
"index_name": "provisioning_v2", # Schreibe zum Alias
"index_rotate": "NEVER", # Datums-Suffix deaktivieren
"hosts": [{"host": OPENSEARCH_LOGGING_SERVER, "port": 9200}],
"http_auth": ("admin", "admin"),
"http_compress": True,
"filters": ['correlation_id'],
},
</syntaxhighlight>
#'''Starten''' Sie die '''Anwendung neu'''

==Vorgang 3: Überprüfung und Fehlerbehebung==
Befehle zur Überprüfung des Status und zur Fehlerbehebung.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Indizes prüfen
|Alle provisioning Indizes anzeigen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Alias prüfen
|Alias-Konfiguration verifizieren
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Policy-Status prüfen
|ISM-Status aller Indizes anzeigen
|}

===Überprüfungs-Befehle===

#'''Alle Indizes anzeigen''':
#:<syntaxhighlight lang="json">
GET _cat/indices/provisioning_v2-*?v&h=index,docs.count,creation.date.string
</syntaxhighlight>
#'''Alias-Konfiguration prüfen''':
#:<syntaxhighlight lang="json">
GET _alias/provisioning_v2
</syntaxhighlight>
#'''Policy-Status prüfen''':
#:<syntaxhighlight lang="json">
GET _plugins/_ism/explain/provisioning_v2-*
</syntaxhighlight>

===Fehlerbehebungs-Befehle===

#'''Bei Rollover-Fehler manuell wiederholen''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/retry/provisioning_v2-000001
</syntaxhighlight>
#'''Policy an Index anhängen''' (falls nicht angehängt):
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Aktualisierte Policy auf bestehende Indizes anwenden''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/change_policy/provisioning_v2-*
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Manueller Rollover erzwingen''' (umgeht Bedingungen):
#:<syntaxhighlight lang="json">
POST provisioning_v2/_rollover
</syntaxhighlight>

==Häufige Fehler==

{| class="wikitable" style="width:100%;"
!Fehler
!Ursache
!Lösung
|-
|<code>Missing rollover_alias index setting</code>
|Index weiss nicht welchen Alias verwenden
|<code>PUT index/_settings</code> mit rollover_alias
|-
|<code>duplicated alias in index template</code>
|Template hat <code>aliases</code> Abschnitt
|<code>aliases</code> aus Template entfernen
|-
|<code>Conditions not met</code>
|min_doc_count UND min_index_age nicht beide erfüllt
|Warten, oder Schwellwerte zum Testen senken
|-
|<code>alias name conflicts with index</code>
|Index und Alias haben gleichen Namen
|Index löschen oder anderen Alias-Namen verwenden
|}

==Lifecycle-Ablauf==

<pre>
1. App schreibt zum Alias "provisioning_v2"
↓
2. Alias zeigt auf aktuellen Index (z.B. -000001)
↓
3. Wenn ≥5 Dokumente UND ≥1h alt → ROLLOVER
↓
4. Neuer Index erstellt (-000002), Alias wird verschoben
↓
5. Alter Index wartet im "rollover" Zustand
↓
6. Nach 3h seit Rollover → ÜBERGANG zu delete
↓
7. Index wird GELÖSCHT
</pre>

Opensearch

2026-01-28T13:44:59Z

Andrew.willi:

<div class="databox">
<div class="tbl">
{|
|-
!Anwendung:
|OpenSearch
|}
</div>
<div class="tbl">
{|
|-
!Status:
|'''Entwurf'''/ freigegeben
|}
</div>
</div>

==Ziel==
Diese Anleitung richtet automatisches Index-Lifecycle-Management ein:

*'''Rollover''': Neuen Index erstellen wenn Bedingungen erfüllt sind (Alter + Dokumentenanzahl)
*'''Löschen''': Alte Indizes nach einer Aufbewahrungsfrist entfernen

<pre>
provisioning_v2-000001 → Rollover → provisioning_v2-000002 → Rollover → ...
↓ (3h später)
LÖSCHEN
</pre>

==Voraussetzungen und Vorbereitung==
*Zugang zu OpenSearch Cluster (Admin-Rechte)
*OpenSearch Dashboard oder API-Zugang (z.B. via curl oder Dev Tools)
*Python-Anwendung mit <code>opensearch-logger</code> Bibliothek

==Vorgang 1: Index-Lifecycle einrichten==
Erstellung der ISM-Policy, Index-Template und des initialen Index für automatisches Rollover und Löschen.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|ISM-Policy erstellen
|Definiert Rollover- und Lösch-Bedingungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Index-Template erstellen
|Stellt korrekte Einstellungen für neue Indizes sicher
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Initialen Index erstellen
|Erster Index mit korrekter Benennung
|-
| style="vertical-align:middle;text-align:center;width:80px;" |4
|Write-Alias hinzufügen
|Alias für Schreiboperationen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |5
|Rollover-Alias am Index setzen
|Index mit Alias verknüpfen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |6
|Policy an Index anhängen
|Lifecycle-Management aktivieren
|}

===Schritt-für-Schritt Anleitung===
'''Note: Unter Management/Dev tools kann man die Befehle einfügen und ausführen'''
#'''Erstellen''' Sie die '''ISM-Policy''' (JSON editor oder Visual editor):[[Datei:ISM-Policy Dashboard.png|none|1210x1210px]]
#:
#:<syntaxhighlight lang="json">
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_doc_count": 5,
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}
</syntaxhighlight>
#:'''Bedingungen:'''
#:*<code>min_doc_count: 5</code> - Muss ≥5 Dokumente haben
#:*<code>min_index_age: 1h</code> - Index muss ≥1 Stunde alt sein
#:*<code>min_rollover_age: 3h</code> - Löschen 3 Stunden nach Rollover
#:'''Hinweis:''' Rollover-Bedingungen sind '''UND''' — beide müssen erfüllt sein. <br />
#'''Erstellen''' Sie das '''Index-Template''':[[Datei:Index-Template.png|none|976x976px]]
#:<syntaxhighlight lang="json">
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}
</syntaxhighlight>
#:
#'''Erstellen''' Sie den '''initialen Index (Visual editor wurde nicht mehr genutzt, weil es mühsam ist)''':
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001
</syntaxhighlight>
#:Der Index muss mit einer Nummer enden (z.B. -000001).
#'''Fügen''' Sie den '''Write-Alias''' hinzu:
#:<syntaxhighlight lang="json">
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}
</syntaxhighlight>
#'''Setzen''' Sie den '''Rollover-Alias''' am Index:
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
</syntaxhighlight>
#'''Hängen''' Sie die '''Policy''' an den Index an:
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight> '''Alle Befehle in Reihenfolge'''<syntaxhighlight lang="json">
// 1. Policy erstellen
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_doc_count": 5,
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}

// 2. Template erstellen
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}

// 3. Initialen Index erstellen
PUT provisioning_v2-000001

// 4. Write-Alias hinzufügen
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}

// 5. Rollover-Alias am Index setzen
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}

// 6. Policy anhängen
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>

==Vorgang 2: Anwendung konfigurieren==
Konfiguration der Python-Anwendung zur Verwendung des Alias anstelle von datumsbasierten Indizes.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Logging-Konfiguration anpassen
|index_rotate auf NEVER setzen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Anwendung neu starten
|Änderungen aktivieren
|}

===Schritt-für-Schritt Anleitung===

#'''Passen''' Sie die '''settings.py''' an:
#:<syntaxhighlight lang="python">
'opensearch': {
"level": 'DEBUG',
"class": 'opensearch_logger.OpenSearchHandler',
"index_name": "provisioning_v2", # Schreibe zum Alias
"index_rotate": "NEVER", # Datums-Suffix deaktivieren
"hosts": [{"host": OPENSEARCH_LOGGING_SERVER, "port": 9200}],
"http_auth": ("admin", "admin"),
"http_compress": True,
"filters": ['correlation_id'],
},
</syntaxhighlight>
#'''Starten''' Sie die '''Anwendung neu'''

==Vorgang 3: Überprüfung und Fehlerbehebung==
Befehle zur Überprüfung des Status und zur Fehlerbehebung.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Indizes prüfen
|Alle provisioning Indizes anzeigen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Alias prüfen
|Alias-Konfiguration verifizieren
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Policy-Status prüfen
|ISM-Status aller Indizes anzeigen
|}

===Überprüfungs-Befehle===

#'''Alle Indizes anzeigen''':
#:<syntaxhighlight lang="json">
GET _cat/indices/provisioning_v2-*?v&h=index,docs.count,creation.date.string
</syntaxhighlight>
#'''Alias-Konfiguration prüfen''':
#:<syntaxhighlight lang="json">
GET _alias/provisioning_v2
</syntaxhighlight>
#'''Policy-Status prüfen''':
#:<syntaxhighlight lang="json">
GET _plugins/_ism/explain/provisioning_v2-*
</syntaxhighlight>

===Fehlerbehebungs-Befehle===

#'''Bei Rollover-Fehler manuell wiederholen''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/retry/provisioning_v2-000001
</syntaxhighlight>
#'''Policy an Index anhängen''' (falls nicht angehängt):
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Aktualisierte Policy auf bestehende Indizes anwenden''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/change_policy/provisioning_v2-*
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Manueller Rollover erzwingen''' (umgeht Bedingungen):
#:<syntaxhighlight lang="json">
POST provisioning_v2/_rollover
</syntaxhighlight>

==Häufige Fehler==

{| class="wikitable" style="width:100%;"
!Fehler
!Ursache
!Lösung
|-
|<code>Missing rollover_alias index setting</code>
|Index weiss nicht welchen Alias verwenden
|<code>PUT index/_settings</code> mit rollover_alias
|-
|<code>duplicated alias in index template</code>
|Template hat <code>aliases</code> Abschnitt
|<code>aliases</code> aus Template entfernen
|-
|<code>Conditions not met</code>
|min_doc_count UND min_index_age nicht beide erfüllt
|Warten, oder Schwellwerte zum Testen senken
|-
|<code>alias name conflicts with index</code>
|Index und Alias haben gleichen Namen
|Index löschen oder anderen Alias-Namen verwenden
|}

==Lifecycle-Ablauf==

<pre>
1. App schreibt zum Alias "provisioning_v2"
↓
2. Alias zeigt auf aktuellen Index (z.B. -000001)
↓
3. Wenn ≥5 Dokumente UND ≥1h alt → ROLLOVER
↓
4. Neuer Index erstellt (-000002), Alias wird verschoben
↓
5. Alter Index wartet im "rollover" Zustand
↓
6. Nach 3h seit Rollover → ÜBERGANG zu delete
↓
7. Index wird GELÖSCHT
</pre>

Opensearch

2026-01-28T13:38:52Z

Andrew.willi:

<div class="databox">
<div class="tbl">
{|
|-
!Anwendung:
|OpenSearch
|}
</div>
<div class="tbl">
{|
|-
!Status:
|'''Entwurf'''/ freigegeben
|}
</div>
</div>

==Ziel==
Diese Anleitung richtet automatisches Index-Lifecycle-Management ein:

*'''Rollover''': Neuen Index erstellen wenn Bedingungen erfüllt sind (Alter + Dokumentenanzahl)
*'''Löschen''': Alte Indizes nach einer Aufbewahrungsfrist entfernen

<pre>
provisioning_v2-000001 → Rollover → provisioning_v2-000002 → Rollover → ...
↓ (3h später)
LÖSCHEN
</pre>

==Voraussetzungen und Vorbereitung==
*Zugang zu OpenSearch Cluster (Admin-Rechte)
*OpenSearch Dashboard oder API-Zugang (z.B. via curl oder Dev Tools)
*Python-Anwendung mit <code>opensearch-logger</code> Bibliothek

==Vorgang 1: Index-Lifecycle einrichten==
Erstellung der ISM-Policy, Index-Template und des initialen Index für automatisches Rollover und Löschen.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|ISM-Policy erstellen
|Definiert Rollover- und Lösch-Bedingungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Index-Template erstellen
|Stellt korrekte Einstellungen für neue Indizes sicher
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Initialen Index erstellen
|Erster Index mit korrekter Benennung
|-
| style="vertical-align:middle;text-align:center;width:80px;" |4
|Write-Alias hinzufügen
|Alias für Schreiboperationen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |5
|Rollover-Alias am Index setzen
|Index mit Alias verknüpfen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |6
|Policy an Index anhängen
|Lifecycle-Management aktivieren
|}

===Schritt-für-Schritt Anleitung===
'''Note: Unter Management/Dev tools kann man die Befehle einfügen und ausführen'''
#'''Erstellen''' Sie die '''ISM-Policy''' (JSON editor oder Visual editor):[[Datei:ISM-Policy Dashboard.png|mini|1210x1210px]]
#:
#:<syntaxhighlight lang="json">
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_doc_count": 5,
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}
</syntaxhighlight>
#:'''Bedingungen:'''
#:*<code>min_doc_count: 5</code> - Muss ≥5 Dokumente haben
#:*<code>min_index_age: 1h</code> - Index muss ≥1 Stunde alt sein
#:*<code>min_rollover_age: 3h</code> - Löschen 3 Stunden nach Rollover
#:'''Hinweis:''' Rollover-Bedingungen sind '''UND''' — beide müssen erfüllt sein. <br /> 
#'''Erstellen''' Sie das '''Index-Template''':[[Datei:Index-Template.png|mini|976x976px]]
#:<syntaxhighlight lang="json">
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}
</syntaxhighlight>
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#: 
#'''Erstellen''' Sie den '''initialen Index (Visual editor wurde nicht mehr genutzt, weil es mühsam ist)''':
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001
</syntaxhighlight>
#:Der Index muss mit einer Nummer enden (z.B. -000001).
#'''Fügen''' Sie den '''Write-Alias''' hinzu:
#:<syntaxhighlight lang="json">
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}
</syntaxhighlight>
#'''Setzen''' Sie den '''Rollover-Alias''' am Index:
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
</syntaxhighlight>
#'''Hängen''' Sie die '''Policy''' an den Index an:
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight> '''Alle Befehle in Reihenfolge'''<syntaxhighlight lang="json">
// 1. Policy erstellen
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_doc_count": 5,
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}

// 2. Template erstellen
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}

// 3. Initialen Index erstellen
PUT provisioning_v2-000001

// 4. Write-Alias hinzufügen
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}

// 5. Rollover-Alias am Index setzen
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}

// 6. Policy anhängen
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>

==Vorgang 2: Anwendung konfigurieren==
Konfiguration der Python-Anwendung zur Verwendung des Alias anstelle von datumsbasierten Indizes.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Logging-Konfiguration anpassen
|index_rotate auf NEVER setzen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Anwendung neu starten
|Änderungen aktivieren
|}

===Schritt-für-Schritt Anleitung===

#'''Passen''' Sie die '''settings.py''' an:
#:<syntaxhighlight lang="python">
'opensearch': {
"level": 'DEBUG',
"class": 'opensearch_logger.OpenSearchHandler',
"index_name": "provisioning_v2", # Schreibe zum Alias
"index_rotate": "NEVER", # Datums-Suffix deaktivieren
"hosts": [{"host": OPENSEARCH_LOGGING_SERVER, "port": 9200}],
"http_auth": ("admin", "admin"),
"http_compress": True,
"filters": ['correlation_id'],
},
</syntaxhighlight>
#'''Starten''' Sie die '''Anwendung neu'''

==Vorgang 3: Überprüfung und Fehlerbehebung==
Befehle zur Überprüfung des Status und zur Fehlerbehebung.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Indizes prüfen
|Alle provisioning Indizes anzeigen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Alias prüfen
|Alias-Konfiguration verifizieren
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Policy-Status prüfen
|ISM-Status aller Indizes anzeigen
|}

===Überprüfungs-Befehle===

#'''Alle Indizes anzeigen''':
#:<syntaxhighlight lang="json">
GET _cat/indices/provisioning_v2-*?v&h=index,docs.count,creation.date.string
</syntaxhighlight>
#'''Alias-Konfiguration prüfen''':
#:<syntaxhighlight lang="json">
GET _alias/provisioning_v2
</syntaxhighlight>
#'''Policy-Status prüfen''':
#:<syntaxhighlight lang="json">
GET _plugins/_ism/explain/provisioning_v2-*
</syntaxhighlight>

===Fehlerbehebungs-Befehle===

#'''Bei Rollover-Fehler manuell wiederholen''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/retry/provisioning_v2-000001
</syntaxhighlight>
#'''Policy an Index anhängen''' (falls nicht angehängt):
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Aktualisierte Policy auf bestehende Indizes anwenden''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/change_policy/provisioning_v2-*
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Manueller Rollover erzwingen''' (umgeht Bedingungen):
#:<syntaxhighlight lang="json">
POST provisioning_v2/_rollover
</syntaxhighlight>

==Häufige Fehler==

{| class="wikitable" style="width:100%;"
!Fehler
!Ursache
!Lösung
|-
|<code>Missing rollover_alias index setting</code>
|Index weiss nicht welchen Alias verwenden
|<code>PUT index/_settings</code> mit rollover_alias
|-
|<code>duplicated alias in index template</code>
|Template hat <code>aliases</code> Abschnitt
|<code>aliases</code> aus Template entfernen
|-
|<code>Conditions not met</code>
|min_doc_count UND min_index_age nicht beide erfüllt
|Warten, oder Schwellwerte zum Testen senken
|-
|<code>alias name conflicts with index</code>
|Index und Alias haben gleichen Namen
|Index löschen oder anderen Alias-Namen verwenden
|}

==Lifecycle-Ablauf==

<pre>
1. App schreibt zum Alias "provisioning_v2"
↓
2. Alias zeigt auf aktuellen Index (z.B. -000001)
↓
3. Wenn ≥5 Dokumente UND ≥1h alt → ROLLOVER
↓
4. Neuer Index erstellt (-000002), Alias wird verschoben
↓
5. Alter Index wartet im "rollover" Zustand
↓
6. Nach 3h seit Rollover → ÜBERGANG zu delete
↓
7. Index wird GELÖSCHT
</pre>

Opensearch

2026-01-28T13:37:42Z

Andrew.willi:

<div class="databox">
<div class="tbl">
{|
|-
!Anwendung:
|OpenSearch
|}
</div>
<div class="tbl">
{|
|-
!Status:
|'''Entwurf'''/ freigegeben
|}
</div>
</div>

==Ziel==
Diese Anleitung richtet automatisches Index-Lifecycle-Management ein:

*'''Rollover''': Neuen Index erstellen wenn Bedingungen erfüllt sind (Alter + Dokumentenanzahl)
*'''Löschen''': Alte Indizes nach einer Aufbewahrungsfrist entfernen

<pre>
provisioning_v2-000001 → Rollover → provisioning_v2-000002 → Rollover → ...
↓ (3h später)
LÖSCHEN
</pre>

==Voraussetzungen und Vorbereitung==
*Zugang zu OpenSearch Cluster (Admin-Rechte)
*OpenSearch Dashboard oder API-Zugang (z.B. via curl oder Dev Tools)
*Python-Anwendung mit <code>opensearch-logger</code> Bibliothek

==Vorgang 1: Index-Lifecycle einrichten==
Erstellung der ISM-Policy, Index-Template und des initialen Index für automatisches Rollover und Löschen.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|ISM-Policy erstellen
|Definiert Rollover- und Lösch-Bedingungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Index-Template erstellen
|Stellt korrekte Einstellungen für neue Indizes sicher
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Initialen Index erstellen
|Erster Index mit korrekter Benennung
|-
| style="vertical-align:middle;text-align:center;width:80px;" |4
|Write-Alias hinzufügen
|Alias für Schreiboperationen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |5
|Rollover-Alias am Index setzen
|Index mit Alias verknüpfen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |6
|Policy an Index anhängen
|Lifecycle-Management aktivieren
|}

===Schritt-für-Schritt Anleitung===
'''Note: Unter Management/Dev tools kann man die Befehle einfügen und ausführen'''
#'''Erstellen''' Sie die '''ISM-Policy''' (JSON editor oder Visual editor):[[Datei:ISM-Policy Dashboard.png|mini|1210x1210px]]
#:
#:<syntaxhighlight lang="json">
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_doc_count": 5,
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}
</syntaxhighlight>
#:'''Bedingungen:'''
#:*<code>min_doc_count: 5</code> - Muss ≥5 Dokumente haben
#:*<code>min_index_age: 1h</code> - Index muss ≥1 Stunde alt sein
#:*<code>min_rollover_age: 3h</code> - Löschen 3 Stunden nach Rollover
#:'''Hinweis:''' Rollover-Bedingungen sind '''UND''' — beide müssen erfüllt sein. <br /> 
#'''Erstellen''' Sie das '''Index-Template''':[[Datei:Index-Template.png|mini|976x976px]]
#:<syntaxhighlight lang="json">
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}
</syntaxhighlight>
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#'''Erstellen''' Sie den '''initialen Index (Visual editor wurde nicht mehr genutzt, weil es mühsam ist)''':
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001
</syntaxhighlight>
#:Der Index muss mit einer Nummer enden (z.B. -000001).
#'''Fügen''' Sie den '''Write-Alias''' hinzu:
#:<syntaxhighlight lang="json">
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}
</syntaxhighlight>
#'''Setzen''' Sie den '''Rollover-Alias''' am Index:
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
</syntaxhighlight>
#'''Hängen''' Sie die '''Policy''' an den Index an:
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight> '''Alle Befehle in Reihenfolge'''<syntaxhighlight lang="json">
// 1. Policy erstellen
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_doc_count": 5,
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}

// 2. Template erstellen
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}

// 3. Initialen Index erstellen
PUT provisioning_v2-000001

// 4. Write-Alias hinzufügen
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}

// 5. Rollover-Alias am Index setzen
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}

// 6. Policy anhängen
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>

==Vorgang 2: Anwendung konfigurieren==
Konfiguration der Python-Anwendung zur Verwendung des Alias anstelle von datumsbasierten Indizes.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Logging-Konfiguration anpassen
|index_rotate auf NEVER setzen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Anwendung neu starten
|Änderungen aktivieren
|}

===Schritt-für-Schritt Anleitung===

#'''Passen''' Sie die '''settings.py''' an:
#:<syntaxhighlight lang="python">
'opensearch': {
"level": 'DEBUG',
"class": 'opensearch_logger.OpenSearchHandler',
"index_name": "provisioning_v2", # Schreibe zum Alias
"index_rotate": "NEVER", # Datums-Suffix deaktivieren
"hosts": [{"host": OPENSEARCH_LOGGING_SERVER, "port": 9200}],
"http_auth": ("admin", "admin"),
"http_compress": True,
"filters": ['correlation_id'],
},
</syntaxhighlight>
#'''Starten''' Sie die '''Anwendung neu'''

==Vorgang 3: Überprüfung und Fehlerbehebung==
Befehle zur Überprüfung des Status und zur Fehlerbehebung.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Indizes prüfen
|Alle provisioning Indizes anzeigen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Alias prüfen
|Alias-Konfiguration verifizieren
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Policy-Status prüfen
|ISM-Status aller Indizes anzeigen
|}

===Überprüfungs-Befehle===

#'''Alle Indizes anzeigen''':
#:<syntaxhighlight lang="json">
GET _cat/indices/provisioning_v2-*?v&h=index,docs.count,creation.date.string
</syntaxhighlight>
#'''Alias-Konfiguration prüfen''':
#:<syntaxhighlight lang="json">
GET _alias/provisioning_v2
</syntaxhighlight>
#'''Policy-Status prüfen''':
#:<syntaxhighlight lang="json">
GET _plugins/_ism/explain/provisioning_v2-*
</syntaxhighlight>

===Fehlerbehebungs-Befehle===

#'''Bei Rollover-Fehler manuell wiederholen''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/retry/provisioning_v2-000001
</syntaxhighlight>
#'''Policy an Index anhängen''' (falls nicht angehängt):
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Aktualisierte Policy auf bestehende Indizes anwenden''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/change_policy/provisioning_v2-*
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Manueller Rollover erzwingen''' (umgeht Bedingungen):
#:<syntaxhighlight lang="json">
POST provisioning_v2/_rollover
</syntaxhighlight>

==Häufige Fehler==

{| class="wikitable" style="width:100%;"
!Fehler
!Ursache
!Lösung
|-
|<code>Missing rollover_alias index setting</code>
|Index weiss nicht welchen Alias verwenden
|<code>PUT index/_settings</code> mit rollover_alias
|-
|<code>duplicated alias in index template</code>
|Template hat <code>aliases</code> Abschnitt
|<code>aliases</code> aus Template entfernen
|-
|<code>Conditions not met</code>
|min_doc_count UND min_index_age nicht beide erfüllt
|Warten, oder Schwellwerte zum Testen senken
|-
|<code>alias name conflicts with index</code>
|Index und Alias haben gleichen Namen
|Index löschen oder anderen Alias-Namen verwenden
|}

==Lifecycle-Ablauf==

<pre>
1. App schreibt zum Alias "provisioning_v2"
↓
2. Alias zeigt auf aktuellen Index (z.B. -000001)
↓
3. Wenn ≥5 Dokumente UND ≥1h alt → ROLLOVER
↓
4. Neuer Index erstellt (-000002), Alias wird verschoben
↓
5. Alter Index wartet im "rollover" Zustand
↓
6. Nach 3h seit Rollover → ÜBERGANG zu delete
↓
7. Index wird GELÖSCHT
</pre>

Opensearch

2026-01-28T13:33:32Z

Andrew.willi: automatisches Index-Lifecycle-Management für OpenSearch

<div class="databox">
<div class="tbl">
{|
|-
!Anwendung:
|OpenSearch
|}
</div>
<div class="tbl">
{|
|-
!Status:
|'''Entwurf'''/ freigegeben
|}
</div>
</div>

==Ziel==
Diese Anleitung richtet automatisches Index-Lifecycle-Management ein:

*'''Rollover''': Neuen Index erstellen wenn Bedingungen erfüllt sind (Alter + Dokumentenanzahl)
*'''Löschen''': Alte Indizes nach einer Aufbewahrungsfrist entfernen

<pre>
provisioning_v2-000001 → Rollover → provisioning_v2-000002 → Rollover → ...
↓ (3h später)
LÖSCHEN
</pre>

==Voraussetzungen und Vorbereitung==
*Zugang zu OpenSearch Cluster (Admin-Rechte)
*OpenSearch Dashboard oder API-Zugang (z.B. via curl oder Dev Tools)
*Python-Anwendung mit <code>opensearch-logger</code> Bibliothek

==Vorgang 1: Index-Lifecycle einrichten==
Erstellung der ISM-Policy, Index-Template und des initialen Index für automatisches Rollover und Löschen.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|ISM-Policy erstellen
|Definiert Rollover- und Lösch-Bedingungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Index-Template erstellen
|Stellt korrekte Einstellungen für neue Indizes sicher
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Initialen Index erstellen
|Erster Index mit korrekter Benennung
|-
| style="vertical-align:middle;text-align:center;width:80px;" |4
|Write-Alias hinzufügen
|Alias für Schreiboperationen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |5
|Rollover-Alias am Index setzen
|Index mit Alias verknüpfen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |6
|Policy an Index anhängen
|Lifecycle-Management aktivieren
|}

===Schritt-für-Schritt Anleitung===
'''Note: Unter Management/Dev tools kann man die Befehle einfügen und ausführen'''
#'''Erstellen''' Sie die '''ISM-Policy''' (JSON editor oder Visual editor):
#:
#:[[Datei:ISM-Policy Dashboard.png|mini|1210x1210px]]<syntaxhighlight lang="json">
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_doc_count": 5,
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}
</syntaxhighlight>
#:'''Bedingungen:'''
#:*<code>min_doc_count: 5</code> - Muss ≥5 Dokumente haben
#:*<code>min_index_age: 1h</code> - Index muss ≥1 Stunde alt sein
#:*<code>min_rollover_age: 3h</code> - Löschen 3 Stunden nach Rollover
#:'''Hinweis:''' Rollover-Bedingungen sind '''UND''' — beide müssen erfüllt sein. <br />
#'''Erstellen''' Sie das '''Index-Template''':[[Datei:Index-Template.png|mini|976x976px]]
#:<syntaxhighlight lang="json">
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}
</syntaxhighlight>
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#:
#'''Erstellen''' Sie den '''initialen Index (Visual editor wurde nicht mehr genutzt, weil es mühsam ist)''':
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001
</syntaxhighlight>
#:Der Index muss mit einer Nummer enden (z.B. -000001).
#'''Fügen''' Sie den '''Write-Alias''' hinzu:
#:<syntaxhighlight lang="json">
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}
</syntaxhighlight>
#'''Setzen''' Sie den '''Rollover-Alias''' am Index:
#:<syntaxhighlight lang="json">
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
</syntaxhighlight>
#'''Hängen''' Sie die '''Policy''' an den Index an:
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight> '''Alle Befehle in Reihenfolge'''<syntaxhighlight lang="json">
// 1. Policy erstellen
PUT _plugins/_ism/policies/provisioning_rollover
{
"policy": {
"policy_id": "provisioning_rollover",
"description": "Rollover und Löschen von Provisioning-Logs",
"default_state": "rollover",
"states": [
{
"name": "rollover",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"rollover": {
"min_doc_count": 5,
"min_index_age": "1h",
"copy_alias": false
}
}
],
"transitions": [
{
"state_name": "delete",
"conditions": {
"min_rollover_age": "3h"
}
}
]
},
{
"name": "delete",
"actions": [
{
"retry": {
"count": 3,
"backoff": "exponential",
"delay": "1m"
},
"delete": {}
}
],
"transitions": []
}
],
"ism_template": [
{
"index_patterns": ["provisioning_v2*"],
"priority": 1
}
]
}
}

// 2. Template erstellen
PUT _index_template/provisioning_v2_template
{
"index_patterns": ["provisioning_v2-*"],
"template": {
"settings": {
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}
},
"priority": 100
}

// 3. Initialen Index erstellen
PUT provisioning_v2-000001

// 4. Write-Alias hinzufügen
POST _aliases
{
"actions": [
{
"add": {
"index": "provisioning_v2-000001",
"alias": "provisioning_v2",
"is_write_index": true
}
}
]
}

// 5. Rollover-Alias am Index setzen
PUT provisioning_v2-000001/_settings
{
"index.plugins.index_state_management.rollover_alias": "provisioning_v2"
}

// 6. Policy anhängen
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>

==Vorgang 2: Anwendung konfigurieren==
Konfiguration der Python-Anwendung zur Verwendung des Alias anstelle von datumsbasierten Indizes.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Logging-Konfiguration anpassen
|index_rotate auf NEVER setzen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Anwendung neu starten
|Änderungen aktivieren
|}

===Schritt-für-Schritt Anleitung===

#'''Passen''' Sie die '''settings.py''' an:
#:<syntaxhighlight lang="python">
'opensearch': {
"level": 'DEBUG',
"class": 'opensearch_logger.OpenSearchHandler',
"index_name": "provisioning_v2", # Schreibe zum Alias
"index_rotate": "NEVER", # Datums-Suffix deaktivieren
"hosts": [{"host": OPENSEARCH_LOGGING_SERVER, "port": 9200}],
"http_auth": ("admin", "admin"),
"http_compress": True,
"filters": ['correlation_id'],
},
</syntaxhighlight>
#'''Starten''' Sie die '''Anwendung neu'''

==Vorgang 3: Überprüfung und Fehlerbehebung==
Befehle zur Überprüfung des Status und zur Fehlerbehebung.

{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Schritt
!Was ist zu tun?
!Bemerkungen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
|Indizes prüfen
|Alle provisioning Indizes anzeigen
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
|Alias prüfen
|Alias-Konfiguration verifizieren
|-
| style="vertical-align:middle;text-align:center;width:80px;" |3
|Policy-Status prüfen
|ISM-Status aller Indizes anzeigen
|}

===Überprüfungs-Befehle===

#'''Alle Indizes anzeigen''':
#:<syntaxhighlight lang="json">
GET _cat/indices/provisioning_v2-*?v&h=index,docs.count,creation.date.string
</syntaxhighlight>
#'''Alias-Konfiguration prüfen''':
#:<syntaxhighlight lang="json">
GET _alias/provisioning_v2
</syntaxhighlight>
#'''Policy-Status prüfen''':
#:<syntaxhighlight lang="json">
GET _plugins/_ism/explain/provisioning_v2-*
</syntaxhighlight>

===Fehlerbehebungs-Befehle===

#'''Bei Rollover-Fehler manuell wiederholen''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/retry/provisioning_v2-000001
</syntaxhighlight>
#'''Policy an Index anhängen''' (falls nicht angehängt):
#:<syntaxhighlight lang="json">
POST _plugins/_ism/add/provisioning_v2-000001
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Aktualisierte Policy auf bestehende Indizes anwenden''':
#:<syntaxhighlight lang="json">
POST _plugins/_ism/change_policy/provisioning_v2-*
{
"policy_id": "provisioning_rollover"
}
</syntaxhighlight>
#'''Manueller Rollover erzwingen''' (umgeht Bedingungen):
#:<syntaxhighlight lang="json">
POST provisioning_v2/_rollover
</syntaxhighlight>

==Häufige Fehler==

{| class="wikitable" style="width:100%;"
!Fehler
!Ursache
!Lösung
|-
|<code>Missing rollover_alias index setting</code>
|Index weiss nicht welchen Alias verwenden
|<code>PUT index/_settings</code> mit rollover_alias
|-
|<code>duplicated alias in index template</code>
|Template hat <code>aliases</code> Abschnitt
|<code>aliases</code> aus Template entfernen
|-
|<code>Conditions not met</code>
|min_doc_count UND min_index_age nicht beide erfüllt
|Warten, oder Schwellwerte zum Testen senken
|-
|<code>alias name conflicts with index</code>
|Index und Alias haben gleichen Namen
|Index löschen oder anderen Alias-Namen verwenden
|}

==Lifecycle-Ablauf==

<pre>
1. App schreibt zum Alias "provisioning_v2"
↓
2. Alias zeigt auf aktuellen Index (z.B. -000001)
↓
3. Wenn ≥5 Dokumente UND ≥1h alt → ROLLOVER
↓
4. Neuer Index erstellt (-000002), Alias wird verschoben
↓
5. Alter Index wartet im "rollover" Zustand
↓
6. Nach 3h seit Rollover → ÜBERGANG zu delete
↓
7. Index wird GELÖSCHT
</pre>

Datei:Index-Template.png

2026-01-28T13:17:18Z

Andrew.willi:

Datei:ISM-Policy Dashboard.png

2026-01-28T13:03:58Z

Andrew.willi:

Benutzer:Andrew.willi

2026-01-28T12:33:02Z

Andrew.willi: create user page