Esplora uno scenario di esempio

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Esamina uno scenario di esempio che mostra come risolvere i problemi 5xx con le API.

# Passaggio Descrizione
1 Monitorare il traffico API recente Visualizza i dati recenti di monitoraggio delle API per tutti i proxy e le destinazioni API che hanno ricevuto traffico nell'ultima ora. Visualizza in dettaglio i proxy o i target API con una percentuale di errori elevata.
2 Identificare le tendenze nei dati di monitoraggio delle API Accedi a una visualizzazione storica dei dati di monitoraggio delle API fino agli ultimi 3 mesi per ottenere una prospettiva più ampia.
3 Esaminare i problemi 5xx Visualizza i codici di errore che riscontrano i volumi relativi più elevati nel tempo per analizzare ulteriormente l'origine dei problemi 5xx. In genere, i codici di stato 5xx possono essere classificati utilizzando uno o più codici di errore.
4 Configurare un avviso 5xx Imposta un avviso per ricevere una notifica quando il numero di codici di stato 5xx supera una determinata soglia.
5 Generare un report personalizzato con i dettagli del cliente (facoltativo) Se vuoi, genera un report personalizzato per identificare i dettagli del client che attiva gli errori 5xx.

Nota: per generare un report personalizzato, devi essere un amministratore dell'organizzazione.
6 Raggruppare i proxy API in una raccolta Crea una raccolta per raggruppare i proxy API e imposta valori di soglia di avviso appropriati per tutti i membri del gruppo, in modo da diagnosticare i problemi più velocemente.
7 Risolvi i problemi 5xx In base alla tua indagine e alla tua diagnosi, adotta le misure appropriate per risolvere i problemi 5xx.

Passaggio 1: monitora il traffico recente dell'API

Per visualizzare i dati di monitoraggio delle API per i proxy e le destinazioni API che hanno registrato traffico nell'ultima ora:

  1. Seleziona Analizza > Monitoraggio API > Recenti nell'interfaccia utente Edge per accedere alla dashboard Recenti.

  2. Osserva i proxy e le destinazioni API che hanno registrato una percentuale di errori elevata nell'ultima ora.

  3. Fai clic sul proxy o sul target API con una percentuale di errori elevata per visualizzare i dettagli nel riquadro a destra. Osserva l'elevata percentuale di errori 5xx in questo esempio.

Per ulteriori informazioni su questo passaggio, vedi Monitorare il traffico API recente.

Passaggio 2: identifica le tendenze nei dati di monitoraggio delle API

Per accedere a una visualizzazione storica dei dati di monitoraggio delle API per i proxy e le destinazioni API che hanno ricevuto traffico negli ultimi tre mesi:

  1. Nel riquadro a destra della dashboard Recenti, seleziona Menu Altro > Visualizza in Spostamenti per accedere alla dashboard Spostamenti. In alternativa, puoi fare clic su Analizza > Monitoraggio API > Sequenza temporale nell'interfaccia utente perimetrale.
  2. Visualizza la tendenza del proxy o del target API nel tempo. Tieni presente che la tendenza è stata costante negli ultimi 7 giorni.

Per saperne di più su questo passaggio, consulta Identificare le tendenze nei dati di monitoraggio delle API.

Passaggio 3: esamina i problemi 5xx

Apigee fornisce una serie di codici di errore che consentono di diagnosticare i problemi. In genere, i codici di stato 5xx possono essere classificati utilizzando uno o più codici di errore.

Per esaminare i problemi di tipo 5xx:

  1. Nel riquadro a destra della dashboard Spostamenti, seleziona Menu Altro > Visualizza in Esamina per accedere alla dashboard di indagine. In alternativa, puoi fare clic su Analizza > Monitoraggio API > Esamina nell'interfaccia utente Edge.

    La dashboard Esamina consente di confrontare l'attività relazionale tra le metriche, come il codice di errore e il tempo.

  2. Visualizza la matrice temporale del codice di guasto per vedere l'attività del codice di errore nell'ultima ora. Nota i codici di errore che riscontrano i volumi relativi più elevati in base all'ombreggiatura dei colori di un blocco. Più scuro è il blocco, più alto è il volume relativo.

    Ad esempio, i codici di errore policies.ratelimit.SpikeArrestViolation e policies.ratelimit.QuotaViolation mostrano un volume relativo più elevato nella seguente matrice: Codici di errore

  3. Fai clic sul blocco più scuro (primo blocco) nella riga policies.ratelimit.SpikeArrestViolation per visualizzare ulteriori dettagli nel riquadro a destra.

  4. Tieni presente che l'origine dell'errore è il proxy API perfBenchmark_invalid_v1 e che il codice di stato HTTP è 500. Un codice di stato 500 è un codice di errore di runtime comune per le violazioni delle norme relative all'arresto dei picchi.

  5. Visualizza l'app Distribuzione per sviluppatore, appena sotto il riquadro Causa presunta, per identificare le app sviluppatore con i tassi di errore più elevati.

Per ulteriori informazioni su questo passaggio, vedi Identificare i problemi.

Passaggio 4: configura l'avviso 5xx

Configura un avviso in base al contesto selezionato nel riquadro Esamina dettagli per ricevere una notifica quando il numero di codici di stato 5xx supera una soglia specifica.

  1. Nel riquadro a destra della dashboard di indagine, seleziona Menu Altro > Crea avviso.

  2. Completa i campi nella finestra di dialogo di avviso. I campi delle condizioni vengono precompilati con i dati del contesto corrente. Ad esempio:

  3. Fai clic su Salva.

In futuro, quando il tasso di errore 5xx supera il 5% per un periodo di 5 minuti per il proxy API perfBenchmark_invalid_v1, viene inviata una notifica all'indirizzo email specificato e nell'interfaccia utente viene visualizzato un avviso visivo. Ad esempio:

Per ulteriori informazioni su questo passaggio, vedi Configurare avvisi e notifiche.

Passaggio 5: genera un report personalizzato con i dettagli del cliente (facoltativo)

(Facoltativo) Genera un report personalizzato per identificare ulteriori dettagli sul client che attiva gli errori 5xx.

Nella pagina Report, i report personalizzati creati in base a un avviso vengono denominati utilizzando il seguente formato: API Monitoring Generated: alert-name.

  1. Accedi al report personalizzato creato durante la configurazione dell'avviso in uno dei seguenti modi:

    • Seleziona Analizza > Report personalizzati > Report nella barra di navigazione a sinistra per visualizzare la pagina Report. Fai clic sul nome del report nell'elenco: Monitoraggio delle API generato: avviso 5xx

    • Fai clic all'interno della notifica che viene visualizzata quando viene creato l'avviso. Ad esempio:

  2. Aggiungi le seguenti dimensioni:

    • App sviluppatore
    • ID client
    • Indirizzo IP client

  3. Per visualizzare un report basato su una specifica app dello sviluppatore con un alto tasso di errori, aggiungi un filtro simile al seguente:

    and (developer_app eq 'perfBenchmarkApp0')

    Nota: in questo caso, rimuovi App sviluppatore dall'elenco delle dimensioni.

  4. Fai clic su Salva.

  5. Esegui il report per visualizzare i dettagli sull'app e sui client dello sviluppatore che attivano il codice di stato 5xx.

Per ulteriori informazioni su questo passaggio, consulta Creare report personalizzati.

Passaggio 6: raggruppa i proxy API in una raccolta

Crea una raccolta per raggruppare i proxy API e imposta valori di soglia di avviso appropriati per tutti i membri del gruppo, in modo da diagnosticare i problemi più velocemente.

  1. Seleziona Analizza > Monitoraggio API > Raccolte nell'interfaccia utente Edge per visualizzare la dashboard Raccolte.
  2. Fai clic su + Raccolta.
  3. Seleziona Proxy.
  4. Seleziona la voce prod dal menu a discesa dell'ambiente.
  5. Tocca Avanti.
  6. Completa i campi nella finestra di dialogo della raccolta.
  7. Fai clic su Salva

Successivamente, puoi configurare un avviso, come nel passaggio 4, e impostare la dimensione sulla raccolta definita in precedenza.

Per ulteriori informazioni su questo passaggio, vedi Gestire le raccolte.

Passaggio 7: risolvi i problemi 5xx

Adotta le misure appropriate per risolvere i problemi 5xx. Ad esempio, in base alla tua diagnosi potresti eseguire una delle seguenti attività:

  • Utilizza Apigee Sense per determinare se il picco di richieste è sospetto e decidi di bloccare l'indirizzo IP del client identificato nel report personalizzato.
  • Aggiungi un criterio per le quote per limitare il numero di connessioni che le app degli sviluppatori possono effettuare al tuo proxy API in un determinato periodo di tempo.
  • Monetizza la tua API per addebitare agli sviluppatori l'utilizzo per un determinato numero di chiamate.