Chiamare un webhook con un avviso di metrica classico in Monitoraggio di Azure

  • Articolo

Avviso

Questo articolo descrive come usare gli avvisi delle metriche classici meno recenti. Monitoraggio di Azure supporta ora avvisi delle metriche quasi in tempo reale e una nuova esperienza di avvisi. Gli avvisi classici vengono ritirati per gli utenti del cloud pubblico. Gli avvisi classici per Azure per enti pubblici cloud e Microsoft Azure gestiti da 21Vianet verranno ritirati il 29 febbraio 2024.

È possibile usare i webhook per instradare le notifiche di avviso di Azure ad altri sistemi per la post-elaborazione o le azioni personalizzate. È possibile usare un webhook in un avviso per instradarlo a servizi che inviano SMS, registrano bug, inviano notifiche a un team tramite chat o servizi di messaggistica oppure per varie altre azioni.

Questo articolo descrive come impostare un webhook per un avviso di metrica di Azure. L'articolo illustra anche le caratteristiche del payload per un'operazione HTTP POST a un webhook. Per informazioni sulla configurazione e lo schema per un avviso del log attività di Azure (avviso per eventi), vedere Chiamare un webhook negli avvisi dei log attività di Azure.

Gli avvisi di Azure usano HTTP POST per inviare il contenuto degli avvisi in formato JSON a un URI webhook specificato durante la creazione dell'avviso. Lo schema è definito più avanti in questo articolo. L'URI deve essere un endpoint HTTP o HTTPS valido. Azure inserisce una voce per ogni richiesta quando viene attivato un avviso.

Configurare webhook tramite il portale di Azure

Per aggiungere o aggiornare l'URI del webhook, nel portale di Azure passare alla schermata di creazione/aggiornamento degli avvisi.

Riquadro Aggiungi una regola di avviso

È anche possibile configurare un avviso da inserire nell'URI di un webhook usando i cmdlet di Azure PowerShell, l'interfaccia della riga di comando multipiattaforma o l'API REST di Monitoraggio di Azure.

Autenticazione del webhook

È possibile autenticare il webhook usando l'autorizzazione basata su token. L'URI del webhook viene salvato con un ID token. Ad esempio: https://mysamplealert/webcallback?tokenid=sometokenid&someparameter=somevalue

Schema del payload

L'operazione POST contiene il payload e lo schema JSON seguenti per tutti gli avvisi basati su metriche:

{
    "status": "Activated",
    "context": {
        "timestamp": "2015-08-14T22:26:41.9975398Z",
        "id": "/subscriptions/s1/resourceGroups/useast/providers/microsoft.insights/alertrules/ruleName1",
        "name": "ruleName1",
        "description": "some description",
        "conditionType": "Metric",
        "condition": {
            "metricName": "Requests",
            "metricUnit": "Count",
            "metricValue": "10",
            "threshold": "10",
            "windowSize": "15",
            "timeAggregation": "Average",
            "operator": "GreaterThanOrEqual"
        },
        "subscriptionId": "s1",
        "resourceGroupName": "useast",
        "resourceName": "mysite1",
        "resourceType": "microsoft.foo/sites",
        "resourceId": "/subscriptions/s1/resourceGroups/useast/providers/microsoft.foo/sites/mysite1",
        "resourceRegion": "centralus",
        "portalLink": "https://portal.azure.com/#resource/subscriptions/s1/resourceGroups/useast/providers/microsoft.foo/sites/mysite1"
    },
    "properties": {
        "key1": "value1",
        "key2": "value2"
    }
}
Campo Obbligatorio Set di valori fisso Note
status S Activated, Resolved Stato dell'avviso in base alle condizioni impostate.
contesto S Contesto dell'avviso.
timestamp S Ora in cui è stato attivato l'avviso.
id S Ogni regola di avviso ha un ID univoco.
name S Nome dell'avviso.
description S Descrizione dell'avviso.
conditionType S Metric, Event Sono supportati due tipi di avviso: metrica ed evento. Gli avvisi di metrica sono basati su una condizione di metrica. Gli avvisi di eventi sono basati su un evento nel log attività. Usare questo valore per controllare se l'avviso è basato su una metrica o su un evento.
condizione S Campi specifici da controllare in base al valore di conditionType.
metricName Per avvisi di metrica Nome della metrica che definisce l'oggetto monitorato dalla regola.
metricUnit Per avvisi di metrica Bytes, BytesPerSecond, Count, CountPerSecond, Percent, Seconds Unità consentita nella metrica. Vedere i valori consentiti.
metricValue Per avvisi di metrica Valore effettivo della metrica che ha generato l'avviso.
threshold Per avvisi di metrica Valore soglia al quale viene attivato l'avviso.
windowSize Per avvisi di metrica Periodo di tempo usato per monitorare l'attività degli avvisi in base alla soglia. Il valore deve essere compreso tra 5 minuti e 1 giorno. Il valore deve essere nel formato di durata ISO 8601.
timeAggregation Per avvisi di metrica Average, Last, Maximum, Minimum, None, Total Definisce come i dati raccolti devono essere combinati nel tempo. Il valore predefinito è "Average". Vedere i valori consentiti.
operator Per avvisi di metrica Operatore usato per confrontare i dati di metrica attuali con la soglia impostata.
subscriptionId S ID sottoscrizione di Azure.
resourceGroupName S Nome del gruppo di risorse per la risorsa interessata.
resourceName S Nome della risorsa interessata.
resourceType S Tipo della risorsa interessata.
resourceId S ID della risorsa interessata.
resourceRegion S Area o posizione della risorsa interessata.
portalLink S Collegamento diretto alla pagina di riepilogo delle risorse del portale.
properties N Facoltativo Set di coppie chiave/valore contenente i dettagli sull'evento. Ad esempio: Dictionary<String, String>. Il campo properties è facoltativo. In un flusso di lavoro basato su un'interfaccia utente personalizzata o un'app per la logica, gli utenti possono immettere una coppia chiave/valore che può essere passata tramite il payload. Un metodo alternativo per passare le proprietà personalizzate al webhook è rappresentato dall'URI del webhook stesso (sotto forma di parametri di query).

Nota

È possibile impostare il campo delle proprietà solo tramite le API REST di Monitoraggio di Azure.

Passaggi successivi