View a markdown version of this page

Configurazione degli avvisi per Amazon Serverless OpenSearch - OpenSearch Servizio Amazon

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Configurazione degli avvisi per Amazon Serverless OpenSearch

Gli avvisi monitorano automaticamente i OpenSearch dati secondo una pianificazione definita e ti avvisa quando vengono soddisfatte le condizioni di attivazione. Un monitor è un processo che esegue una query sui dati, valuta le condizioni di attivazione e genera avvisi. Quando si attiva un trigger, il monitor esegue azioni che inviano notifiche tramite canali configurati. Per una panoramica concettuale dei monitor, dei trigger e delle azioni, vedi Avvisi sul sito Web. OpenSearch

Gli avvisi serverless utilizzano una raccolta Amazon OpenSearch Serverless come origine dati del monitor. Puoi creare e gestire i monitor dall'interfaccia utente. OpenSearch Ogni monitor è una risorsa dell'area di lavoro dell' OpenSearch interfaccia utente in cui lo crei. Questa pagina descrive i prerequisiti, le autorizzazioni e le considerazioni specifiche delle raccolte serverless. Documenta inoltre le operazioni API nell'ambito dell'area di lavoro utilizzate per gestire i monitor a livello di codice.

Importante

OpenSearch I monitor sono risorse dell'area di lavoro dell'interfaccia utente. Di conseguenza, le operazioni dell'API di avviso per le raccolte serverless differiscono dalle operazioni API di avviso open source previste. _plugins/_alerting Utilizza le operazioni relative all'area di lavoro in. Avviso delle operazioni dell'API per le raccolte serverless

Prerequisiti

Scelta di un tipo di raccolta per gli avvisi

Ti consigliamo di utilizzare gli avvisi insieme a una raccolta di serie temporali. Un monitor su una raccolta serverless deve fare riferimento a nomi di indice concreti: i modelli di indice, gli alias e le espressioni jolly non sono supportati. Una raccolta di serie temporali gestisce automaticamente la conservazione dei dati per gli indici monitorati, quindi non è necessario creare un processo di conservazione personalizzato.

Tieni a mente le seguenti considerazioni:

  • Solo nomi di indici concreti: un monitor deve fare riferimento a nomi di indici concreti. I modelli di indice (ad esempio,logs-*), gli alias e gli elenchi separati da virgole di più indici non sono supportati.

  • Conservazione automatica dei dati: le raccolte di serie temporali gestiscono automaticamente il ciclo di vita dei dati negli indici monitorati. Ciò si abbina bene agli avvisi, poiché gli indici monitorati che crescono senza limiti richiederebbero altrimenti la gestione della fidelizzazione da parte dell'utente.

  • Raccolte di ricerca: le raccolte di ricerca sono accettate anche come fonte di dati di monitoraggio, ma non gestiscono la conservazione dei dati al posto tuo.

Per ulteriori informazioni sui tipi di raccolta, consultaScelta di un tipo di raccolta.

Configurazione delle autorizzazioni per gli avvisi

I monitor vengono eseguiti come processi in background sulla tua raccolta. La seguente politica di accesso ai dati di raccolta concede le autorizzazioni richieste dagli avvisi. Sostituiscili placeholder values con le tue informazioni specifiche. Per ulteriori informazioni, consulta Autorizzazioni delle policy supportate.

{ "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" }
  • Autorizzazioni di raccolta (aoss:CreateCollectionItemsaoss:DeleteCollectionItems,aoss:UpdateCollectionItems,,aoss:DescribeCollectionItems): consentono al processo di notifica di risolvere e gestire la raccolta.

  • Autorizzazioni di indicizzazione (aoss:CreateIndexaoss:DeleteIndex,,aoss:UpdateIndex,aoss:DescribeIndex,aoss:ReadDocument,aoss:WriteDocument): consentono al monitor di leggere gli indici monitorati. Consentono inoltre al monitor di creare e scrivere negli indici interni della cronologia degli avvisi gestiti dal plug-in di avviso.

  • aoss:DelegateAccess— Consente al processo di notifica in background di accedere alla raccolta per conto dell'utente.

Importante

aoss:DelegateAccessconsente l'esecuzione del processo di avviso in background sulla raccolta e aoss:ReadDocument consente di monitorare le esecuzioni di interrogare gli indici monitorati. È possibile assegnare la risorsa dell'indice a indici specifici anziché a. index/collection_name/* In tal caso, coprite tutti gli indici a cui fa riferimento un monitor e gli indici interni della cronologia degli avvisi su cui scrive il plug-in di avviso.

All'interno di un'area di lavoro OpenSearch dell'interfaccia utente, l'accesso alle funzionalità di avviso avviene in base alle autorizzazioni del collaboratore dell'area di lavoro (di sola lettura o amministratore). read/write Read-onlyi collaboratori possono visualizzare monitor, avvisi e canali di notifica. Read/write e i collaboratori amministratori possono creare, aggiornare, abilitare, disabilitare ed eliminare i monitor e possono riconoscere e disattivare gli avvisi.

Tipi di monitor supportati

Le raccolte serverless supportano i seguenti tipi di monitor:

  • Per-query monitor: esegui una singola query e valuta le condizioni di attivazione rispetto al risultato aggregato. Utilizza un monitor per query quando desideri inviare avvisi in base a una singola metrica aggregata, ad esempio la latenza media di risposta che supera una soglia.

  • Per-bucket monitor: esegui una query con un'aggregazione composita e valuta le condizioni di attivazione per ciascun bucket. Utilizza un monitor per bucket quando desideri avvisare i singoli gruppi all'interno dei tuoi dati, ad esempio quando ogni host supera il tasso di errore.

  • Monitor PPL: esegui una query PPL (Piped Processing Language) e valuta le condizioni di attivazione rispetto al risultato. Utilizzate un monitor PPL quando desiderate esprimere una logica di filtraggio, trasformazione o statistica complessa in un linguaggio di query piped. Per la sintassi PPL, consultate PPL sul sito Web. OpenSearch

Altri tipi di monitor, inclusi monitor per documento, monitor compositi e monitor con metriche per cluster, non sono disponibili per le raccolte serverless.

Utilizzo del rilevamento delle anomalie con avvisi

Per ricevere una notifica quando un rilevatore di anomalie rileva un'anomalia, crea un monitor che richieda l'indice dei risultati personalizzato del rilevatore. I rilevatori di anomalie nelle raccolte serverless scrivono i risultati in un indice di risultati personalizzato all'interno della stessa raccolta, il che significa che puoi utilizzare un monitor standard per query o per bucket con un trigger attivato e. anomaly_grade confidence

Completa questa procedura:

  1. Imposta il rilevamento delle anomalie e crea un rilevatore con un indice dei risultati personalizzato. Per ulteriori informazioni, consulta Configurazione del rilevamento delle anomalie su Amazon Serverless OpenSearch.

  2. Crea un monitor nell' OpenSearch interfaccia utente in base all'indice dei risultati personalizzato del rilevatore (ad esempio,). opensearch-ad-plugin-result-my-detector Per indicazioni sulle condizioni di attivazione da utilizzare per i risultati delle anomalie, consulta Rilevamento delle anomalie sul sito Web. OpenSearch

  3. Aggiungi un canale di notifica al trigger in modo che l'avviso raggiunga la destinazione prescelta.

Nota

Il tipo di monitoraggio del rilevatore di anomalie del plug-in di avviso open source non è disponibile nelle raccolte serverless, perché legge dall'indice dei risultati di anomalia predefinito. Effettua invece una query sull'indice dei risultati personalizzato con un monitor per query o per bucket.

Considerazioni e limitazioni

L'invio di avvisi su OpenSearch Serverless presenta le seguenti considerazioni e limitazioni:

  • Gli alias non sono supportati. I monitor devono fare riferimento a nomi di indice concreti.

  • I modelli di indice Wildcard non sono supportati. I monitor devono fare riferimento a nomi di indice concreti (ad esempio, logs-* non è consentito).

  • Per-bucket i monitor supportano un solo trigger.

  • Per-document i monitor, i monitor compositi e i monitor con metriche per cluster non sono disponibili per le raccolte serverless.

  • Le impostazioni degli avvisi, come la conservazione della cronologia degli avvisi, sono gestite dal servizio e non possono essere modificate.

  • È necessario disattivare un monitor prima di aggiornarlo o eliminarlo.

Avviso delle operazioni dell'API per le raccolte serverless

Le raccolte serverless supportano tutte le operazioni di monitoraggio e avviso dell'API open source Alerting del sito Web. OpenSearch Tuttavia, le chiamate con percorsi in stile workspace. I monitor sono risorse dell'area di lavoro OpenSearch dell'interfaccia utente, quindi è possibile inviare le richieste all'endpoint dell'applicazione OpenSearch UI anziché all'endpoint di raccolta. Ogni percorso include un'area di lavoro e identifica la fonte di dati che rappresenta la raccolta.

Utilizzate un client SigV4-signing HTTP, ad esempio awscurlsul GitHub sito Web, per richiamare le operazioni. Le sezioni seguenti descrivono il formato della richiesta, elencano i percorsi operativi e mostrano esempi rappresentativi.

Formato della richiesta

Le richieste utilizzano il seguente formato:

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

La tabella seguente descrive ogni parte della richiesta.

Componente Description
application_endpoint L'endpoint dell'applicazione OpenSearch UI, nel formatoapplication-application_name-application_id.region.opensearch.amazonaws.com.
workspace_id L'ID dell'area di lavoro dell' OpenSearch interfaccia utente che contiene il monitor. Puoi trovarlo nel /w/ segmento dell'URL dell'area di lavoro nella console dell' OpenSearch interfaccia utente.
data_source_id L'ID dell'origine dati nell'area di lavoro che rappresenta la tua raccolta. A seconda dell'operazione, passate questo valore come ultimo segmento del percorso o come parametro di dataSourceId interrogazione.
monitor_id L'ID di un monitor, restituito nel id campo quando si creano o si cercano monitor.

Firma ogni richiesta con Signature Version 4 (SigV4), utilizzandola opensearch come nome del servizio. Includi le seguenti intestazioni in ogni richiesta:

  • Content-Type: application/json— Obbligatorio per le richieste che prevedono l'invio di un corpo.

  • osd-xsrf: osd-fetch— Intestazione obbligatoria per la contraffazione della richiesta tra siti.

  • osd-version: 3.6.0— La OpenSearch versione dell'applicazione UI. OpenSearch

Ogni risposta utilizza una busta. Viene restituita una risposta riuscita e viene {"ok": true, "response": {...}} restituita una risposta non riuscita. {"ok": false, "error": "message"}

Percorsi operativi

La tabella seguente elenca le operazioni di avviso e i relativi percorsi in stile workspace. Tutti i percorsi sono relativi a. https://application_endpoint/w/workspace_id/api/alerting

Operation Metodo Path
Creazione di un monitor POST monitors?dataSourceId=data_source_id
Procurati un monitor GET monitors/monitor_id?dataSourceId=data_source_id
Aggiorna un monitor PUT monitors/monitor_id?dataSourceId=data_source_id
Eliminazione di un monitor DELETE monitors/monitor_id?dataSourceId=data_source_id
Monitor di ricerca POST monitors/_search?dataSourceId=data_source_id
Esegui un monitor POST monitors/monitor_id/_execute?dataSourceId=data_source_id
Ricevi avvisi GET monitors/alerts?dataSourceId=data_source_id
Riconosci gli avvisi POST monitors/monitor_id/_acknowledge/alerts?dataSourceId=data_source_id
Nota

È necessario disattivare un monitor prima di aggiornarlo o eliminarlo. La visualizzazione degli avvisi può richiedere alcuni minuti dopo l'attivazione di un monitor.

Esempio: creare un monitor

L'esempio seguente crea un monitor per query che verifica la presenza di picchi di errore nei log del server ogni 5 minuti.

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": [] } }] }'

La risposta restituisce l'ID del monitor nel campo. id

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

Tieni presente i seguenti requisiti specifici per i sistemi serverless:

  • indicesdeve contenere nomi di indice concreti. I wildcard e gli alias non sono supportati. Per ulteriori informazioni, consulta Scelta di un tipo di raccolta per gli avvisi.

  • L'operazione crea il monitor in uno stato disabilitato. Abilitalo con l'operazione di aggiornamento impostando"enabled": true.

Esempio: Esegui un monitor

L'operazione di esecuzione esegue immediatamente la query del monitor e restituisce i risultati senza attendere il successivo intervallo pianificato. Utilizzatela per testare la query e i trigger di un monitor prima di abilitarlo.

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": {} } } } }

L'operazione di ricerca esegue un'interrogazione sulle configurazioni dei monitor nell'area di lavoro.

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" }] } }

L'operazione get alerts restituisce tutti gli avvisi attivi sui monitor del workspace.

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 } }

Esempio: Riconoscere gli avvisi

La conferma di un avviso lo sposta da ACTIVE uno stato all'altro, il che impedisce l'attivazione di ulteriori azioni di notifica per quell'avviso fino al ripristino della ACKNOWLEDGED condizione di attivazione.

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": []}}

Esempio: eliminare un monitor

Disattiva il monitor prima di eliminarlo. L'eliminazione di un monitor non elimina gli avvisi generati in precedenza.

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": {}}