Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
I report personalizzati consentono di visualizzare in dettaglio metriche API specifiche e di vedere i dati esatti che vuoi vedere. Dalle dashboard di monitoraggio delle API puoi creare un report personalizzato con il filtro e le metriche preimpostati in base alle condizioni configurate al momento della creazione. Inoltre, nel report viene configurato automaticamente un insieme di dimensioni e metriche predefinite.
Creare un report personalizzato in base al contesto
Crea rapidamente report personalizzati in base al tuo contesto, come riepilogato nella seguente tabella. Nella pagina Report personalizzati, i report personalizzati creati utilizzando API Monitoring hanno un nome univoco (per impostazione predefinita), come indicato nella tabella; può essere modificato durante la modifica del report personalizzato.
| Contesto del report personalizzato | Convenzione di denominazione predefinita per i report personalizzati |
|---|---|
| Dashboard recente | API Monitoring Recent Generated |
| Dashboard della cronologia | API Monitoring Timeline Generated |
| Esamina la dashboard | API Monitoring Investigate Generated |
| Condizione di avviso | API Monitoring Generated: alert-name |
Dimensione e metriche predefinite
Per impostazione predefinita, il report personalizzato includerà le dimensioni e le metriche elencate nella tabella seguente per tutti i report generati dal monitoraggio delle API.
| Componente | Valori predefiniti |
|---|---|
| Dimensioni | URI della richiesta |
| Metriche |
|
Modificare il report personalizzato
Come indicato nella sezione precedente, un insieme predefinito di dimensioni e metriche predefinite di API Monitoring è preconfigurato nei report personalizzati. Dopo averlo creato, puoi modificare il report personalizzato per aggiungere o eliminare metriche e dimensioni, se necessario. Ad esempio, potresti voler limitare la tua indagine a un determinato token di accesso, app per sviluppatori, proxy API o ID richiesta.
Nel seguente report personalizzato aggiungi la dimensione predefinita Gateway Flow ID, dove Gateway Flow ID contiene l'UUID univoco di ogni richiesta API inviata a Edge.
Tieni presente che il report utilizza già la dimensione Request URI:
Nell'esempio seguente la dimensione Client ID viene aggiunta al report personalizzato.
La dimensione Client ID contiene la chiave utente (chiave API) dello sviluppatore che effettua la chiamata API, a seconda che venga trasmessa nella richiesta come chiave API o inclusa in un token OAuth:
Il report personalizzato contiene informazioni per tutti i valori Client ID.
Nel prossimo esempio viene aggiunto un filtro per creare un report personalizzato per un Client ID specifico:
Per ulteriori informazioni su tutte le dimensioni e le metriche predefinite che puoi aggiungere a un report, consulta l'articolo Riferimento per metriche, dimensioni e filtri di Analytics.
Nel prossimo esempio, aggiungi un filtro a un report personalizzato che acquisisce le metriche e le dimensioni predefinite per il codice di errore policies.ratelimit.QuotaViolation e i codici di stato 5xx:
Per informazioni dettagliate su come modificare un report personalizzato, consulta Gestire i report personalizzati.
Esempio: utilizzare i report personalizzati per diagnosticare i problemi di deployment
Allega il criterio StatisticsCollector ai proxy API per raccogliere dati di analisi personalizzati, come ID utente o prodotto, prezzo, azione REST, versione di destinazione, URL di destinazione e lunghezza del messaggio. I dati possono provenire da variabili di flusso predefinite da Apigee, intestazioni delle richieste, parametri di query o variabili personalizzate da te definite.
Ad esempio, le richieste al proxy API includono intestazioni per ID prodotto, ID utente e versione del server di destinazione. che può avere il seguente formato:
curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi
Potrai quindi utilizzare le informazioni nelle intestazioni per diagnosticare i problemi di runtime con il proxy API.
Per creare un report personalizzato per queste intestazioni:
Aggiungi il criterio StatisticsCollector alla tua API per acquisire il valore delle intestazioni personalizzate:
<StatisticsCollector name="publishPurchaseDetails"> <Statistics> <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic> <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic> <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic> </Statistics> </StatisticsCollector>
Esegui il deployment del proxy e attendi il tempo necessario per l'accesso.
Fai clic su Analizza > Monitoraggio API > Recenti nell'interfaccia utente Edge per visualizzare eventuali problemi relativi all'API. Tieni presente che vengono visualizzati errori 4xx e 5xx per il proxy myapi:
Seleziona la riga del proxy myapi per visualizzare ulteriori dettagli nel riquadro a destra della dashboard recente.
Nel riquadro a destra della dashboard Recenti, seleziona
> Visualizza in Esamina per accedere alla dashboard Esamina:
Filtra la dashboard di indagine in base al proxy myapi, quindi visualizza il codice di stato nel grafico in alto. Nota che ricevi errori 403 e 501:
Nell'interfaccia utente Edge, seleziona Analytics > Report personalizzati > Report per creare un report personalizzato che includa i valori di queste metriche personalizzate come dimensione.
Seleziona + Report personalizzato per creare un report personalizzato denominato myapi_errors.
Seleziona Errori del proxy per la metrica e imposta la Funzione aggregata su Somma. Se vuoi, puoi aggiungere altre metriche.
Seleziona la dimensione predefinita Codice di stato della risposta, quindi aggiungi le tre statistiche personalizzate prodid, targetersion e userid a Dimensioni:
Imposta il filtro in modo da includere solo i dati per il proxy API myapi
(apiproxy eq 'myapi'):
Salva il report.
Crea il report per le 24 ore precedenti. Alla prima apertura del report, viene visualizzato un grafico degli errori HTTP 403 e 501:
In Riepilogo, fai clic su 403 o 510 per vedere quale prodotto genera gli errori. Ad esempio, selezioni 403:
Fai clic su un ID prodotto nella sezione Riepilogo per visualizzare gli errori in base alla versione di destinazione (alpha o beta):
Fai clic su una versione di destinazione in Riepilogo per visualizzare gli errori in base all'utente:
