View a markdown version of this page

Konfiguration von Warnmeldungen für Amazon Serverless OpenSearch - OpenSearch Amazon-Dienst

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Konfiguration von Warnmeldungen für Amazon Serverless OpenSearch

Alerting überwacht Ihre OpenSearch Daten automatisch nach einem festgelegten Zeitplan und benachrichtigt Sie, wenn die Triggerbedingungen erfüllt sind. Ein Monitor ist ein Job, der eine Abfrage Ihrer Daten ausführt, Triggerbedingungen auswertet und Warnmeldungen generiert. Wenn ein Trigger ausgelöst wird, führt der Monitor Aktionen aus, die Benachrichtigungen über konfigurierte Kanäle senden. Einen konzeptionellen Überblick über Monitore, Auslöser und Aktionen finden Sie auf der OpenSearch Website unter Warnmeldungen.

Serverlose Warnmeldungen verwenden eine Amazon OpenSearch Serverless-Sammlung als Datenquelle für den Monitor. Sie erstellen und verwalten Monitore über die Benutzeroberfläche. OpenSearch Jeder Monitor ist eine Ressource des OpenSearch UI-Workspace, in dem Sie ihn erstellen. Auf dieser Seite werden die Voraussetzungen, Berechtigungen und Überlegungen beschrieben, die für serverlose Sammlungen spezifisch sind. Außerdem werden die API-Operationen im Workspace-Bereich dokumentiert, die Sie zur programmgesteuerten Verwaltung von Monitoren verwenden.

Wichtig

Monitore sind UI-Workspace-Ressourcen. OpenSearch Aus diesem Grund unterscheiden sich die API-Alert-Operationen für serverlose Sammlungen von den API-Vorgängen unter Open-Source-Warnmeldungen. _plugins/_alerting Verwenden Sie die Workspace-bezogenen Operationen in. API-Benachrichtigungen für serverlose Sammlungen

Voraussetzungen

Auswahl eines Sammlungstyps für Warnmeldungen

Wir empfehlen, Warnmeldungen zusammen mit einer Zeitreihenerfassung zu verwenden. Ein Monitor in einer serverlosen Sammlung muss auf konkrete Indexnamen verweisen — Indexmuster, Aliase und Platzhalterausdrücke werden nicht unterstützt. Bei einer Zeitreihenerfassung wird die Datenspeicherung für die überwachten Indizes automatisch verwaltet, sodass Sie keinen benutzerdefinierten Aufbewahrungsprozess erstellen müssen.

Beachten Sie folgende Überlegungen:

  • Nur konkrete Indexnamen — Ein Monitor muss auf konkrete Indexnamen verweisen. Indexmuster (z. B.logs-*), Aliase und durch Kommas getrennte Listen mit mehreren Indizes werden nicht unterstützt.

  • Automatische Datenspeicherung — Zeitreihenerfassungen verwalten den Lebenszyklus der Daten in den überwachten Indizes für Sie. Dies passt gut zu Warnmeldungen, da überwachte Indizes, die unbegrenzt wachsen, andernfalls erfordern würden, dass Sie die Aufbewahrung selbst verwalten müssten.

  • Suchsammlungen — Suchsammlungen werden auch als Monitordatenquelle akzeptiert, sie übernehmen jedoch nicht die Datenspeicherung für Sie.

Weitere Informationen zu Sammlungstypen finden Sie unterAuswahl eines Sammlungstyps.

Berechtigungen für Warnmeldungen konfigurieren

Monitore werden als Hintergrundjobs für Ihre Sammlung ausgeführt. Die folgende Richtlinie für den Zugriff auf Sammlungsdaten gewährt die Berechtigungen, die für Warnmeldungen erforderlich sind. Ersetzen Sie die placeholder values durch Ihre spezifischen Informationen. Weitere Informationen finden Sie unter Unterstützte Richtlinienberechtigungen.

{ "Rules": [ { "Resource": [ "collection/collection_name" ], "Permission": [ "aoss:CreateCollectionItems", "aoss:DeleteCollectionItems", "aoss:UpdateCollectionItems", "aoss:DescribeCollectionItems" ], "ResourceType": "collection" }, { "Resource": [ "index/collection_name/*" ], "Permission": [ "aoss:CreateIndex", "aoss:DeleteIndex", "aoss:UpdateIndex", "aoss:DescribeIndex", "aoss:ReadDocument", "aoss:WriteDocument", "aoss:DelegateAccess" ], "ResourceType": "index" } ], "Principal": [ "arn:aws:iam::account_id:role/role_name" ], "Description": "Alerting access policy for collection_name" }
  • Erfassungsberechtigungen (aoss:CreateCollectionItems,aoss:DeleteCollectionItems,aoss:UpdateCollectionItems,aoss:DescribeCollectionItems) — Erlauben Sie dem Alert-Job, die Erfassung zu lösen und zu bearbeiten.

  • Indexberechtigungen (aoss:CreateIndex,,aoss:DeleteIndex,aoss:UpdateIndex, aoss:DescribeIndexaoss:ReadDocument,aoss:WriteDocument) — Erlauben dem Monitor, die überwachten Indizes zu lesen. Sie ermöglichen es dem Monitor auch, Indizes für den internen Warnungsverlauf zu erstellen und in die internen Warnungsverläufe zu schreiben, die das Warn-Plugin verwaltet.

  • aoss:DelegateAccess— Ermöglicht dem Hintergrundjob für Warnmeldungen, in Ihrem Namen auf die Sammlung zuzugreifen.

Wichtig

aoss:DelegateAccesslässt den Hintergrundjob für Warnmeldungen für die Sammlung ausführen und aoss:ReadDocument ermöglicht es Monitorausführungen, die überwachten Indizes abzufragen. Sie können die Indexressource stattdessen auf bestimmte Indizes beschränken. index/collection_name/* In diesem Fall sollten Sie jeden Index abdecken, auf den ein Monitor verweist, sowie die internen Alert-Historienindizes, in die das Warn-Plugin schreibt.

Innerhalb eines OpenSearch UI-Workspace richtet sich der Zugriff auf Warnfunktionen nach den Berechtigungen der Workspace-Mitarbeiter (schreibgeschützt oder Administrator). read/write Read-onlyMitwirkende können Monitore, Benachrichtigungen und Benachrichtigungskanäle einsehen. Read/write und Mitarbeiter mit Administratorrechten können Monitore erstellen, aktualisieren, aktivieren, deaktivieren und löschen sowie Benachrichtigungen bestätigen und stummschalten.

Unterstützte Monitortypen

Serverlose Sammlungen unterstützen die folgenden Monitortypen:

  • Per-query Monitore — Führen Sie eine einzelne Abfrage aus und bewerten Sie die Triggerbedingungen anhand des aggregierten Ergebnisses. Verwenden Sie einen Monitor pro Abfrage, wenn Sie eine Warnung für eine einzelne aggregierte Metrik ausgeben möchten, z. B. wenn die durchschnittliche Antwortlatenz einen Schwellenwert überschreitet.

  • Per-bucket Monitore — Führen Sie eine Abfrage mit einer zusammengesetzten Aggregation aus und bewerten Sie die Triggerbedingungen für jeden Bucket. Verwenden Sie einen Monitor pro Bucket, wenn Sie Warnmeldungen für einzelne Gruppen innerhalb Ihrer Daten ausgeben möchten, z. B. wenn jeder Host eine Fehlerrate überschreitet.

  • PPL-Monitore — Führen Sie eine PPL-Abfrage (Piped Processing Language) aus und bewerten Sie die Triggerbedingungen anhand des Ergebnisses. Verwenden Sie einen PPL-Monitor, wenn Sie komplexe Filter-, Transformations- oder statistische Logik in einer Piped-Abfragesprache ausdrücken möchten. Informationen zur PPL-Syntax finden Sie unter PPL auf der Website. OpenSearch

Andere Monitortypen — darunter Monitore pro Dokument, kombinierte Monitore und Monitore pro Cluster-Metrik — sind für serverlose Sammlungen nicht verfügbar.

Verwendung von Anomalieerkennung mit Warnmeldungen

Um eine Benachrichtigung zu erhalten, wenn ein Anomaliedetektor eine Anomalie entdeckt, erstellen Sie einen Monitor, der den benutzerdefinierten Ergebnisindex des Melders abfragt. Anomaliedetektoren in serverlosen Sammlungen schreiben Ergebnisse in einen benutzerdefinierten Ergebnisindex in derselben Sammlung, was bedeutet, dass Sie einen Standardmonitor pro Abfrage oder pro Bucket mit aktiviertem Trigger verwenden können. anomaly_grade confidence

Führen Sie folgende Schritte aus:

  1. Richten Sie die Anomalieerkennung ein und erstellen Sie einen Detektor mit einem benutzerdefinierten Ergebnisindex. Weitere Informationen finden Sie unter Konfiguration der Anomalieerkennung auf Amazon Serverless OpenSearch.

  2. Erstellen Sie in der OpenSearch Benutzeroberfläche einen Monitor anhand des benutzerdefinierten Ergebnisindex des Detektors (z. B.opensearch-ad-plugin-result-my-detector). Hinweise zu den Triggerbedingungen, die für Anomalieergebnisse zu verwenden sind, finden Sie auf der OpenSearch Website unter Anomalieerkennung.

  3. Fügen Sie dem Auslöser einen Benachrichtigungskanal hinzu, damit die Warnung das Ziel Ihrer Wahl erreicht.

Anmerkung

Der Monitortyp „Anomalieerkennung“ aus dem Open-Source-Warn-Plugin ist in serverlosen Sammlungen nicht verfügbar, da er aus dem standardmäßigen Anomalie-Ergebnisindex liest. Fragen Sie den benutzerdefinierten Ergebnisindex stattdessen mit einem Monitor pro Abfrage oder pro Bucket ab.

Überlegungen und Einschränkungen

Bei der Alarmierung auf OpenSearch Serverless gelten die folgenden Überlegungen und Einschränkungen:

  • Aliase werden nicht unterstützt. Monitore müssen auf konkrete Indexnamen verweisen.

  • Indexmuster mit Platzhaltern werden nicht unterstützt. Monitore müssen auf konkrete Indexnamen verweisen (logs-*ist beispielsweise nicht zulässig).

  • Per-bucket Monitore unterstützen einen einzelnen Trigger.

  • Per-document Monitore, Composite-Monitore und Monitore für einzelne Cluster-Metriken sind für serverlose Sammlungen nicht verfügbar.

  • Einstellungen für Benachrichtigungen, wie z. B. die Aufbewahrung des Warnungsverlaufs, werden vom Dienst verwaltet und können nicht geändert werden.

  • Sie müssen einen Monitor deaktivieren, bevor Sie ihn aktualisieren oder löschen können.

API-Benachrichtigungen für serverlose Sammlungen

Serverlose Sammlungen unterstützen alle Überwachungs- und Warnvorgänge in der Open-Source-Alerting API auf der Website. OpenSearch Sie rufen sie jedoch mit Pfaden im Workspace-Stil auf. Monitore sind OpenSearch UI-Workspace-Ressourcen, sodass Sie Anfragen an Ihren OpenSearch UI-Anwendungsendpunkt und nicht an den Sammlungsendpunkt senden. Jeder Pfad umfasst einen Arbeitsbereich und identifiziert die Datenquelle, die Ihre Sammlung darstellt.

Verwenden Sie einen SigV4-signing HTTP-Client, z. B. awscurlauf der GitHub Website, um die Operationen aufzurufen. In den folgenden Abschnitten wird das Anforderungsformat beschrieben, die Operationspfade aufgeführt und repräsentative Beispiele gezeigt.

Anforderungsformat

Anfragen verwenden das folgende Format:

https://application_endpoint/w/workspace_id/api/alerting/operation_path

In der folgenden Tabelle werden die einzelnen Teile der Anfrage beschrieben.

Komponente Description
application_endpoint Der Endpunkt Ihrer OpenSearch UI-Anwendung im Formatapplication-application_name-application_id.region.opensearch.amazonaws.com.
workspace_id Die ID des OpenSearch UI-Workspace, der den Monitor enthält. Sie finden sie im /w/ Segment der Workspace-URL in der OpenSearch UI-Konsole.
data_source_id Die ID der Datenquelle im Workspace, die Ihre Sammlung darstellt. Je nach Vorgang übergeben Sie diesen Wert entweder als letztes Segment des Pfads oder als dataSourceId Abfrageparameter.
monitor_id Die ID eines Monitors, die in dem id Feld zurückgegeben wird, wenn Sie Monitore erstellen oder nach Monitoren suchen.

Signieren Sie jede Anfrage mit Signature Version 4 (Sigv4) und verwenden Sie opensearch dabei den Dienstnamen. Fügen Sie jeder Anfrage die folgenden Header hinzu:

  • Content-Type: application/json— Erforderlich für Anfragen, die einen Text senden.

  • osd-xsrf: osd-fetch— Site-übergreifender Forgery-Header für Anfragen erforderlich.

  • osd-version: 3.6.0— Die OpenSearch Version Ihrer OpenSearch UI-Anwendung.

Jede Antwort verwendet einen Umschlag. Eine erfolgreiche Antwort wird zurückgegeben{"ok": true, "response": {...}}, und eine fehlgeschlagene Antwort kehrt zurück{"ok": false, "error": "message"}.

Operationspfade

In der folgenden Tabelle sind die Warnvorgänge und ihre Pfade im Workspace-Stil aufgeführt. Alle Pfade beziehen sich auf. https://application_endpoint/w/workspace_id/api/alerting

Operation Methode Pfad
Einen Monitor erstellen POST monitors?dataSourceId=data_source_id
Besorgen Sie sich einen Monitor GET monitors/monitor_id?dataSourceId=data_source_id
Aktualisiere einen Monitor PUT monitors/monitor_id?dataSourceId=data_source_id
Einen Monitor löschen DELETE monitors/monitor_id?dataSourceId=data_source_id
Monitore durchsuchen POST monitors/_search?dataSourceId=data_source_id
Führen Sie einen Monitor aus POST monitors/monitor_id/_execute?dataSourceId=data_source_id
Erhalten Sie Benachrichtigungen GET monitors/alerts?dataSourceId=data_source_id
Bestätigen Sie Benachrichtigungen POST monitors/monitor_id/_acknowledge/alerts?dataSourceId=data_source_id
Anmerkung

Sie müssen einen Monitor deaktivieren, bevor Sie ihn aktualisieren oder löschen können. Es kann einige Minuten dauern, bis Warnmeldungen angezeigt werden, nachdem Sie einen Monitor aktiviert haben.

Beispiel: Erstellen Sie einen Monitor

Im folgenden Beispiel wird ein Monitor pro Abfrage erstellt, der alle 5 Minuten nach Fehlerspitzen in den Serverprotokollen sucht.

awscurl --service opensearch --region us-west-2 \ -X POST \ 'https://application_endpoint/w/workspace_id/api/alerting/monitors?dataSourceId=data_source_id' \ -H "Content-Type: application/json" \ -H "osd-xsrf: osd-fetch" \ -H "osd-version: 3.6.0" \ -d '{ "type": "monitor", "name": "error-spike-monitor", "monitor_type": "query_level_monitor", "enabled": false, "schedule": { "period": { "interval": 5, "unit": "MINUTES" } }, "inputs": [{ "search": { "indices": ["server-logs"], "query": { "size": 0, "query": { "bool": { "filter": [ {"range": {"@timestamp": {"gte": "{{period_end}}||-5m", "lte": "{{period_end}}", "format": "epoch_millis"}}}, {"term": {"level": "ERROR"}} ] } }, "aggregations": { "error_count": {"value_count": {"field": "_id"}} } } } }], "triggers": [{ "query_level_trigger": { "name": "High error count", "severity": "1", "condition": { "script": { "source": "ctx.results[0].aggregations.error_count.value > 100", "lang": "painless" } }, "actions": [] } }] }'

Die Antwort gibt die Monitor-ID im id Feld zurück.

{"ok": true, "response": {"id": "a3f8c214-7b62-4e91-9d05-1c3b6f4e8a92", "name": "error-spike-monitor"}}

Beachten Sie die folgenden serverlosen Anforderungen:

  • indicesmuss konkrete Indexnamen enthalten. Platzhalter und Aliase werden nicht unterstützt. Weitere Informationen finden Sie unter Auswahl eines Sammlungstyps für Warnmeldungen.

  • Durch den Vorgang wird der Monitor in einem deaktivierten Zustand erstellt. Aktivieren Sie ihn mit dem Aktualisierungsvorgang durch Einstellung"enabled": true.

Beispiel: Führen Sie einen Monitor aus

Der Ausführungsvorgang führt die Abfrage des Monitors sofort aus und gibt die Ergebnisse zurück, ohne auf das nächste geplante Intervall zu warten. Verwenden Sie diese Option, um die Abfrage und die Trigger eines Monitors zu testen, bevor Sie ihn aktivieren.

awscurl --service opensearch --region us-west-2 \ -X POST \ 'https://application_endpoint/w/workspace_id/api/alerting/monitors/monitor_id/_execute?dataSourceId=data_source_id' \ -H "Content-Type: application/json" \ -H "osd-xsrf: osd-fetch" \ -H "osd-version: 3.6.0"
{ "ok": true, "response": { "monitor_name": "error-spike-monitor", "period_start": 1781041644000, "period_end": 1781041944000, "error": null, "input_results": { "results": [{"aggregations": {"error_count": {"value": 42}}}] }, "trigger_results": { "trigger-id": { "name": "High error count", "triggered": false, "action_results": {} } } } }

Der Suchvorgang führt eine Abfrage anhand der Monitorkonfigurationen im Workspace durch.

awscurl --service opensearch --region us-west-2 \ -X POST \ 'https://application_endpoint/w/workspace_id/api/alerting/monitors/_search?dataSourceId=data_source_id' \ -H "Content-Type: application/json" \ -H "osd-xsrf: osd-fetch" \ -H "osd-version: 3.6.0" \ -d '{"query": {"match_all": {}}, "size": 1}'
{ "ok": true, "response": { "totalMonitors": 8, "monitors": [{ "id": "a3f8c214-7b62-4e91-9d05-1c3b6f4e8a92", "name": "error-spike-monitor", "monitor_type": "query_level_monitor", "enabled": true, "schedule": {"period": {"interval": 5, "unit": "MINUTES"}}, "inputs": [{"search": {"indices": ["server-logs"], "query": {}}}], "triggers": [{"query_level_trigger": {"name": "High error count", "severity": "1"}}], "last_update_time": 1781030925933, "dataSourceId": "ef581a74-e4e6-3fab-a5b4-9bffd8d4af64" }] } }

Der Vorgang „Benachrichtigungen abrufen“ gibt alle aktiven Benachrichtigungen auf allen Monitoren im Workspace zurück.

awscurl --service opensearch --region us-west-2 \ -X GET \ 'https://application_endpoint/w/workspace_id/api/alerting/monitors/alerts?dataSourceId=data_source_id' \ -H "Content-Type: application/json" \ -H "osd-xsrf: osd-fetch" \ -H "osd-version: 3.6.0"
{ "ok": true, "response": { "alerts": [{ "id": "d7e5b324-1f93-4a2d-bc89-6e4f1d2c3a56", "monitor_id": "a3f8c214-7b62-4e91-9d05-1c3b6f4e8a92", "monitor_name": "error-spike-monitor", "trigger_name": "High error count", "state": "ACTIVE", "severity": "1", "start_time": 1781041944000, "last_notification_time": 1781041944000 }], "totalAlerts": 1 } }

Beispiel: Benachrichtigungen bestätigen

Durch das Bestätigen einer Warnung wird sie vom Status in den ACTIVE Status versetzt, wodurch verhindert wird, dass weitere Benachrichtigungsaktionen für diese Warnung ausgelöst werden, bis die Auslösebedingung zurückgesetzt wird. ACKNOWLEDGED

awscurl --service opensearch --region us-west-2 \ -X POST \ 'https://application_endpoint/w/workspace_id/api/alerting/monitors/monitor_id/_acknowledge/alerts?dataSourceId=data_source_id' \ -H "Content-Type: application/json" \ -H "osd-xsrf: osd-fetch" \ -H "osd-version: 3.6.0" \ -d '{"alerts": ["d7e5b324-1f93-4a2d-bc89-6e4f1d2c3a56"]}'
{"ok": true, "response": {"success": ["d7e5b324-1f93-4a2d-bc89-6e4f1d2c3a56"], "failed": []}}

Beispiel: Löschen Sie einen Monitor

Deaktivieren Sie den Monitor, bevor Sie ihn löschen. Durch das Löschen eines Monitors werden die zuvor generierten Warnungen nicht gelöscht.

awscurl --service opensearch --region us-west-2 \ -X DELETE \ 'https://application_endpoint/w/workspace_id/api/alerting/monitors/monitor_id?dataSourceId=data_source_id' \ -H "Content-Type: application/json" \ -H "osd-xsrf: osd-fetch" \ -H "osd-version: 3.6.0"
{"ok": true, "response": {}}