Creazione di un'attività di notifica
È possibile utilizzare Engagement su API Manager per ricevere notifiche in base ai criteri definiti.
Prima di iniziare
Per utilizzare Engagement in API Manager è necessario avere almeno un servizio Analytics attivo. Quando si crea un'attività di notifica, è necessario soddisfare i seguenti criteri:
- Ogni regola può avere solo fino a 7 criteri di filtro e 5 trigger.
- Ogni innesco può avere solo fino a 3 azioni.
Informazioni su questa attività
La funzione Engagement di API Manager aiuta l'utente a creare flussi di lavoro complessi che automatizzano le attività e migliorano l'esperienza complessiva di gestione delle API. In base ai criteri definiti durante la creazione delle attività di notifica, ogni utente riceve le notifiche.
Creare un'attività di notifica
Per utilizzare Engagement, clicca
sull'API Manager e specifica i criteri richiesti.
- Configurare un
destination, che è la definizione dell'endpoint HTTP (S) che riceverà le attività di notifica. Per ulteriori informazioni, vedere Creazione di una destinazione. - Configurare un '
rule, che è il lavoro che viene eseguito in base a una pianificazione definita e che invia query all'origine dati. Per ulteriori informazioni, vedere Creazione di una regola. - Configurare un '
trigger, che definisce le condizioni che generano gli eventi. Per ulteriori informazioni, vedere Aggiunta di trigger. - Configurare un '
action, che definisce cosa succede dopo l'attivazione di un'attività di notifica. Per ulteriori informazioni, vedere Aggiunta di azioni.
Creare una destinazione
- Fare clic sulla scheda Crea destinazioni.
- Fare clic su Destinazione.
- Fare clic su Crea e fornire i seguenti dettagli:
- Nel titolo, indicare un titolo per la destinazione.
- Nella casella Descrizione, fornire una descrizione.
- Per configurare Webhook, completare i seguenti passaggi:
- Selezionare Webhook come
type. - Selezionare un'opzione dall'elenco
Methodper specificare il metodo HTTP per la destinazione. Le opzioni disponibili sonoPOST,PUTePATCH. - Nel campo
Webhook URL, inserire l'endpoint di destinazione HTTP (S). - Opzionale: Fare clic su Aggiungi + per includere intestazioni aggiuntive di HTTP.
- Selezionare Webhook come
- Per configurare PagerDuty,, procedere come segue:
- Selezionare PagerDuty come tipo.
- Inserite il vostro pagerduty integration routing key nel campo
Routing key. Per ulteriori informazioni supagerduty integration, consultare la sezione Servizi e integrazioni.Nota: per l'integrazione con PagerDuty,, selezionare Events API v2 come tipo di integrazione.
- Per configurare Slack, completare i seguenti passaggi:
- Selezionare Slack come tipo.
- Nel campo
Token, inserire il token API di Slack. - Nel campo
Channel ID, inserite il vostro Channel ID. Per ulteriori informazioni su questo argomentoToken and Channel ID, consulta la guida "Come ottenere e utilizzare rapidamente un token per un bot API di Slack ".Nota: utilizzare l'ID del canale, non il nome del canale. Ad esempio:C1234567890.
- Per configurare Amazon Simple Notification Service, completare i seguenti passaggi:Nota: Per abilitare Amazon SNS for Engagement, è necessario creare il segreto del client AWS e fare riferimento al segreto nel file YAML della risorsa personalizzata di analisi. Per ulteriori informazioni, vedere Attivazione di Amazon SNS.
- Selezionare Amazon SNS come tipo.
- Nel campo ARN argomento, inserire l'ARN dell'argomento Amazon SNS.
- Nel campo ARN ruolo, immettere l'ARN del ruolo Amazon SNS.
- Per configurare il bridge Kafka HTTP, completare i passaggi seguenti:
- Selezionare Webhook come
type. - Selezionare un'opzione dall'elenco
Methodper specificare il metodo HTTP per la destinazione. Le opzioni disponibili sonoPOST,PUTePATCH. - Nel campo
Webhook URL, inserire l'endpoint di destinazione HTTP (S).
Per ulteriori informazioni sullahttp://<route-name>.apps.<cluster-name>.<namespace>.com/topics/<topic-name>Kafka HTTP Bridgeconfigurazione, consultare la sezione "Connessione tramite HTTP con un bridge Kafka ". - Fare clic su Aggiungi + per aggiungere un'intestazione a HTTP.
- Nel file
Name, inserire content-type. - Nel campo
Value, inserire application/vnd.kafka.json.v2+json. - Definire il payload JSON da inviare all'argomento Kafka nell'azione di attivazione della regola.
Nota: verificare l'impostazione di Kafka e regolare il formato del payload, se necessario. L'esempio seguente mostra un formato di messaggio JSON richiesto da alcune implementazioni di Kafka :{ "records": [ { "key": "my-key", "value": "my-value" } ] } - Selezionare Webhook come
- Per configurare IBM MQ, procedere come segue:
- Selezionare Webhook come
type. - Selezionare un'opzione dall'elenco
Methodper specificare il metodo HTTP per la destinazione. Le opzioni disponibili sonoPOST,PUTePATCH. - Nel campo
Webhook URL, inserire l'endpoint di destinazione HTTP (S).
Per ulteriori informazioni suhttps://<host>:<port>/ibmmq/rest/v3/messaging/qmgr/<your_qm_name>/queue/<your_queue_name>/messageIBM MQ messaging REST API, consultare l'API REST di messaggistica di IBM MQ. - Fare clic su Aggiungi + per aggiungere un'intestazione a HTTP.
- Nel file
Name, inserire content-type. - Nel campo
Value, inserire il valore del tipo di contenuto utilizzato, ad esempio:text/plain;charset=utf-8. - Fare clic su Aggiungi + per aggiungere una seconda intestazione HTTP.
- Nel file
Name, inserire authorization. - Nel campo
Value, inserire Basic <base64encodedstring>.dove:
base64encodedstringè la codifica in base 64 diusername:password.
- Fare clic su Aggiungi + per aggiungere una terza intestazione HTTP.
- Nel file
Name, inserire ibm-mq-rest-csrf-token. - Il campo del valore può essere lasciato vuoto.Nota: assicurarsi che questa intestazione sia inclusa, anche se il campo del valore è vuoto, poiché il Queue Manager di IBM MQ rifiuta il payload in sua assenza.
- Selezionare Webhook come
- Per configurare IBM Cloud Event Notification Service, completare i seguenti passaggi:Nota: Le destinazioni di IBM Cloud Event Notification Service non sono collegate alle destinazioni di API Connect. È necessario configurare la destinazione in IBM Cloud Event Notification Service prima di configurare Engagement in API Connect.
- Selezionare Webhook come
type. - Selezionare
POSTdall'elencoMethodper specificare il metodo HTTP per la destinazione. - Nel campo
Webhook URL, inserire l'endpoint di destinazione HTTP (S).
dove:{base_url}/v1/instances/{instance_id}/notifications- url_base
- Inserire il percorso di base URL
- instance_id
- Inserire l'identificatore corrispondente all'istanza
IBM Cloud Event Notification Service, consultare l'API delle notifiche degli eventi. - Fare clic su Aggiungi + per aggiungere un'intestazione a HTTP.
- Nel file
Name, inserire content-type. - Nel campo
Value, inserire application/json. - Fare clic su Aggiungi + per aggiungere una seconda intestazione HTTP.
- Nel file
Name, inserire Authorization. - Nel campo
Value, inserire il token IAM. - Definire il payload JSON da inviare al servizio di notifica nell'azione di attivazione della regola. Per ulteriori informazioni, consulta l'API delle notifiche degli eventi.
- Selezionare Webhook come
- Fare clic su Crea.
Creazione di una regola
- Fare clic su Regole.
- Fare clic su Crea e fornire i seguenti dettagli:
- Nel campo Titolo, indicare il nome Title per la regola.
- Nella sezione Pianificazione, specificare una pianificazione per l'esecuzione di questa regola. È possibile specificare una pianificazione definendo un intervallo di tempo o una stringa cron.
- Fare clic su Avanti per selezionare i dati e definire la query.
- Nella sezione Seleziona dati, selezionare un'opzione dall'elenco Origine dati in base ai dati su cui si desidera eseguire la regola.
- Nella sezione Query, definire la metrica di aggregazione che si desidera utilizzare per la query. L'impostazione predefinita è un conteggio dei record corrispondenti. È inoltre possibile utilizzare aggregazioni matematiche per i campi numerici, come il valore massimo o la media su un periodo di tempo.
- Nei campi Intervallo di tempo dei dati per l'ultimo, inserire l'intervallo di tempo in base all'intervallo di tempo in cui si desidera eseguire la ricerca degli elementi di dati corrispondenti.
- Fare clic su Aggiungi filtro + per selezionare fino a 7 filtri di dati in base ai dati che si desidera includere durante l'esecuzione della query. È possibile utilizzare uno qualsiasi dei campi del record dell'evento di analisi.
- Fare clic su Aggiungi gruppo per + per selezionare un gruppo in base a come si desidera raggruppare i dati selezionati e ottimizzare i criteri di destinazione. Ad esempio, una regola che corrisponde a 10 eventi API con un codice di stato 500 in un periodo di 24 ore può utilizzare "
Group bysu "api_nameper richiamare 10 eventi corrispondenti per una singola API, anziché un totale di tutti gli eventi per tutte le API. - Fare clic su Avanti per configurare i trigger.
Aggiungere i trigger + :
- Fare clic su Aggiungi trigger +. È possibile aggiungere fino a 5 trigger.
- Nella sezione Dettagli trigger, fornire un 'Title per il trigger e quindi selezionare il livello di gravità e la condizione di trigger dagli elenchi corrispondenti.
- Dall'elenco a discesa Gravità, selezionare un'opzione.
- Nella sezione Condizione di attivazione, impostare una condizione come necessario.
Definire il target numerico, che consente a una singola regola di avere più trigger con gravità e condizioni di attivazione diverse. Quando i criteri specificati sono soddisfatti, ogni trigger può attivare fino a 3 azioni, che poi invocano endpoint diversi o con payload diversi.
Aggiungere azioni:
- Fare clic su Aggiungi azione + per configurare l'azione da eseguire quando i criteri di attivazione sono soddisfatti.
- Nella sezione Azione scatenante, fornire un title per l'azione,
- Dall'elenco Destinazione, selezionare la destinazione da richiamare quando i criteri sono soddisfatti.
- Abilitare il throttling e definire la finestra di throttling per evitare che vengano invocati più trigger per la stessa regola nello stesso periodo di tempo.
- Nella sezione Payload (Carico utile), fornire un oggetto del messaggio e un valore del carico utile. È possibile aggiungere variabili di contesto nel campo Payload in base alle informazioni sul carico utile dell'attività che si desidera visualizzare nella destinazione. Per ulteriori informazioni, consultare la sezione "Variabili di contesto nel payload dell'attività".Nota: L'oggetto del messaggio non viene inviato all'endpoint HTTP. Il valore del payload funge da corpo HTTP dell'attività di notifica inviata all'endpoint di destinazione
- Fare clic su Salva.
- Fare clic su Fine.
Cosa avete fatto in questa attività
Nel vostro API Manager, avete usato Engagement per automatizzare le attività di notifica in base ai criteri specificati. La scheda Stato attività visualizza le ultime attività di notifica per ciascun trigger.