Creare e gestire i report personalizzati

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

I report personalizzati ti consentono di esaminare in dettaglio metriche API specifiche e visualizzare i dati esatti che vuoi visualizzare. Puoi creare un report personalizzato utilizzando una qualsiasi delle metriche e delle dimensioni integrate in Edge. Inoltre, puoi collegare il criterio StatisticsCollector ai tuoi proxy API per raccogliere metriche personalizzate, come ID utente o prodotto, prezzo, azione REST, versione di destinazione, URL di destinazione e lunghezza del messaggio.

Video

Guarda i seguenti video per saperne di più sui report personalizzati.

Video	Descrizione
Creare report personalizzati utilizzando la UI	Scopri come creare report personalizzati utilizzando l'interfaccia utente Edge.
Panoramica dei report personalizzati	Visualizza una panoramica dell'utilizzo dei report personalizzati.
Monitorare la latenza dell'API	Scopri come monitorare la latenza dell'API utilizzando i report personalizzati.
Monitorare le risposte agli errori dell'API	Monitora le risposte di errore dell'API utilizzando i report personalizzati.

Informazioni sui rapporti personalizzati

Quando crei un report personalizzato, selezioni i dati che vuoi visualizzare (metriche), li raggruppi in modo significativo (dimensioni) e, se vuoi, limiti i dati restituiti in base a caratteristiche specifiche (filtri) dei dati.

Puoi anche impostare il tipo di grafico visualizzato nel report personalizzato come grafico a colonne o a linee. Le seguenti immagini mostrano esempi di grafici per la metrica Transazioni al secondo raggruppate in base alla dimensione Proxy API:

• Colonna: ogni proxy API è rappresentato da una colonna diversa:

  

• Linea: ogni API è rappresentata da una linea diversa:

  

Impostare metriche e dimensioni

Le metriche che scegli per il report personalizzato specificano i dati che stai cercando di misurare. Le metriche più comuni includono:

• Transazioni al secondo
• Data/ora della risposta
• Errori dei criteri

Alcune metriche ti consentono di impostare una funzione di aggregazione da applicare alla metrica. Ad esempio, puoi utilizzare le seguenti funzioni di aggregazione con la metrica Tempo di risposta:

• avg: restituisce il tempo di risposta medio.
• min: Restituisce il tempo di risposta minimo.
• max: Restituisce il tempo di risposta massimo.
• sum: Restituisce la somma di tutti i tempi di risposta.

Non tutte le metriche supportano tutte le funzioni di aggregazione. La documentazione sulle metriche contiene una tabella che specifica il nome della metrica e la funzione (sum, avg, min, max) supportata dalla metrica.

La dimensione specifica la modalità di raggruppamento dei dati delle metriche. Ad esempio, vuoi creare un report personalizzato che mostri la metrica Tempo di risposta. Puoi utilizzare le dimensioni per raggruppare i dati delle metriche per prodotto API, proxy API o email dello sviluppatore per ottenere:

• Il tempo di risposta per prodotto API
• Il tempo di risposta per proxy API
• Il tempo di risposta per email dello sviluppatore

Il modo in cui la dimensione viene visualizzata nel grafico del report personalizzato dipende dal tipo di grafico:

• Colonna: ogni colonna corrisponde a un valore diverso della dimensione.
• Linea: ogni linea nel grafico corrisponde a un valore diverso della dimensione e l'asse X rappresenta il tempo.

Creare metriche e dimensioni personalizzate

Aggiungi il criterio StatisticsCollector ai tuoi 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 definite da te. Una volta raccolti i dati, puoi creare un report personalizzato per visualizzarli.

Il modo in cui visualizzi i dati di analisi personalizzati in un report personalizzato dipende dal tipo di dati:

• Per i dati di tipo stringa, fai riferimento ai dati statistici come dimensione in un report personalizzato.
• Per i tipi di dati numerici (integer/float/long/double), fai riferimento ai dati statistici in un report personalizzato come dimensione o metrica.

Per esempi di raccolta di dati di analisi personalizzati, consulta le norme StatisticsCollector.

Impostare i filtri

Un filtro ti consente di limitare i dati delle metriche visualizzati nel report personalizzato impostando caratteristiche specifiche per i dati delle metriche da restituire. Ad esempio, puoi creare un filtro in modo da visualizzare i dati delle metriche solo per un tempo di risposta superiore a un valore specifico o solo per un proxy API con un nome specifico.

I filtri utilizzano una sintassi condizionale che ti consente di creare filtri complessi utilizzando operatori come eq, ne, gt, lt e altri.

Esempi di report personalizzati

Nel tipo più semplice di report personalizzato, specifichi una singola metrica e una singola dimensione. Ad esempio, definisci un report personalizzato con le seguenti impostazioni:

• type = Column
• metrica = Media transazioni al secondo
• dimension = API Proxy

Il report personalizzato contiene un grafico a colonne con i dati della metrica "Transazioni medie al secondo" raggruppati per dimensione proxy API:

Le metriche che mostrano le medie visualizzano anche un link Mostra dispersione sul lato destro del grafico, come puoi vedere nel grafico sopra. Passa il mouse sopra il link per aprire la casella di dispersione. Una scatola di dispersione mostra le tendenze centrali dei tuoi dati.

Puoi aggiungere più metriche a un report personalizzato. Ad esempio, definisci un report personalizzato con due metriche:

• type = Column
• metrica = Media transazioni al secondo
• metrica = Policy Errors
• dimension = API Proxy

Il report personalizzato contiene un grafico separato per ogni metrica:

Puoi aggiungere più dimensioni a un report personalizzato. Ad esempio, definisci un report personalizzato con le seguenti impostazioni che includono due metriche e due dimensioni:

• type = Column
• metrica = Media transazioni al secondo
• metrica = Policy errors
• dimension = API Proxy
• dimensione = Verbo della richiesta

Il grafico inizialmente mostra le metriche raggruppate per proxy, la prima dimensione specificata quando hai creato il report personalizzato:

Puoi quindi utilizzare il menu a discesa Proxy, corrispondente alla prima dimensione, per selezionare un singolo proxy. Il grafico aggiornato ora mostra le metriche per il proxy selezionato in base al verbo della richiesta:

Man mano che aggiungi dimensioni al report personalizzato, l'interfaccia utente si adatta per consentirti di esaminare in dettaglio il report in base a ogni dimensione.

Visualizzare tutti i report personalizzati

Accedi alla pagina dei report personalizzati, come descritto di seguito.

La pagina dei report personalizzati mostra tutti i report personalizzati creati per la tua organizzazione, come mostrato nella figura seguente:

Come evidenziato nella figura, la pagina dei report personalizzati ti consente di:

• Visualizza un elenco di tutti i report personalizzati.
• Aggiungere un report personalizzato.
• Esegui un report personalizzato facendo clic sul relativo nome nell'elenco. Il report viene eseguito utilizzando i dati raccolti nell'ultima ora per impostazione predefinita e i dati vengono visualizzati nel dashboard del report personalizzato. Consulta Esplorare la dashboard dei report personalizzati.
• Cerca nell'elenco dei report personalizzati inserendo una stringa pertinente completa o parziale nella casella di ricerca; la stringa viene cercata in tutti i campi visualizzati.
• Eliminare un report personalizzato.

Esplorazione della dashboard dei report personalizzati

La dashboard dei report personalizzati mostra i risultati del report personalizzato per un intervallo di tempo specifico, incluso il grafico a colonne o a linee della metrica specificata:

La dashboard dei report personalizzati ti consente di:

• Visualizza i dati dei report personalizzati per l'intervallo di tempo selezionato.
• Seleziona l'ambiente per il quale vuoi visualizzare i dati del report personalizzato.
• Seleziona una dimensione specifica per filtrare i dati del report personalizzato. Questa area viene attivata solo quando specifichi più dimensioni per il report.

• Seleziona la visualizzazione Grafico o Tabella.

• Analizza una metrica selezionando l'icona nella riga della tabella della metrica associata. Visualizza le anomalie e confrontale con un periodo precedente o con altre metriche.
• Esegui il report personalizzato facendo clic e impostando l'intervallo di tempo.
• Scarica il report personalizzato come file CSV. Il file è denominato come segue: metric.csv. Ad esempio Average_of_total_response_time.csv.
• Modifica il report personalizzato.

Esplorare la dashboard di analisi delle metriche

Se selezioni l'icona in una riga della tabella riepilogativa, vengono visualizzati i seguenti grafici (il grafico in alto viene visualizzato solo se hai configurato il report in modo da utilizzare più metriche):

Questi grafici mostrano le seguenti informazioni:

• Confronta con: se hai configurato il report in modo che utilizzi più metriche, confronta le metriche tra loro.
• Confronto con il periodo precedente: visualizza la metrica per il periodo di tempo precedente. Ad esempio, se hai scelto di visualizzare il report personalizzato per le ultime 24 ore, questo grafico mostra i dati del periodo di 24 ore precedente.

• Analizza anomalie: mostra eventuali punti dati anomali nei dati del report. Questo grafico mostra due valori:

  • La media mobile della metrica visualizzata come linea. Per un determinato punto sulla linea, il valore della media mobile viene calcolato come media del valore della metrica in quel momento e dei valori della metrica per i due punti dati precedenti.
  • L'area blu del grafico definisce i valori medi massimi e medi minimi della metrica. La media massima è 1,2 * (media mobile) e la media minima è 0,8 * (media mobile).

  Se la media mobile è al di fuori dell'intervallo della media massima o della media minima, viene considerata una possibile anomalia e viene disegnata come un punto rosso sul grafico.

Aggiungere un report personalizzato

Aggiungendo report personalizzati, puoi creare un insieme di grafici che forniscono informazioni su ogni aspetto del tuo programma API.

Dopo aver aggiunto il report personalizzato, devi eseguirlo in modo sincrono o asincrono.

Per aggiungere un report personalizzato:

1. Accedi alla pagina Report personalizzati.
2. Fai clic su + Report personalizzato.
3. Nella sezione Base, inserisci le seguenti informazioni:

   Campo	Descrizione
   Nome report	Il nome del report.
   Segnala descrizione	Descrizione della segnalazione.
   Tipo di grafico	Seleziona lo stile del grafico da utilizzare per presentare i dati di analisi personalizzati. Colonna: l'asse X rappresenta i gruppi designati dalle dimensioni. Linea: l'asse X rappresenta il tempo.

4. Nella sezione Metriche:
   1. Fai clic sull'icona per Metriche.
   2. Seleziona la metrica che vuoi analizzare.
   3. Seleziona una funzione di aggregazione per visualizzare i valori Somma, Media, Minimo o Massimo.
   4. Fai clic su Salva.
   5. Fai clic sull'icona per aggiungere altre metriche.
5. Nella sezione Dimensioni, fai clic su e seleziona una dimensione, ad esempio "Proxy", per vincolare il set di dati utilizzato per generare i report. Puoi aggiungere altre dimensioni per vincolare ulteriormente i dati.

6. Nella sezione Filtri, restringi ulteriormente i dati visualizzati aggiungendo filtri alla definizione del report. Ad esempio, puoi aggiungere un filtro che esclude i dati per il proxy API Weather o lo sviluppatore jane@example.com.

   1. Fai clic su e seleziona il nome dell'entità su cui vuoi filtrare, un operatore come = o != e un valore.
   2. Fai clic su Aggiungi per salvare il filtro.
   3. Fai clic su per aggiungere altri filtri e seleziona un connettore AND o OR.

7. Per limitare l'accesso al report personalizzato, modifica i ruoli personalizzati definiti per il report.

   1. Fai clic su per modificare le impostazioni del ruolo personalizzato.
   2. Seleziona il ruolo personalizzato necessario per accedere al report e il livello di accesso (visualizzazione, modifica, eliminazione).
   3. Fai clic su Aggiungi.
   4. Fai clic su per modificare i ruoli aggiuntivi.
8. Fai clic su Salva per salvare il report.

Eseguire un report personalizzato

Edge Analytics ti consente di eseguire un report in modo sincrono o asincrono.

• Per un report sincrono, esegui la richiesta di report e la richiesta viene bloccata finché il server di analisi non fornisce una risposta. Tuttavia, poiché un report potrebbe dover elaborare una grande quantità di dati (ad esempio, centinaia di GB), un report sincrono potrebbe non riuscire a causa di un timeout.

  Un report sincrono può avere un intervallo di tempo massimo di 14 giorni. Se selezioni un intervallo di tempo di 15 giorni o più, il report viene sempre eseguito in modo asincrono.

• Per un report asincrono, esegui la richiesta del report e recupera i risultati in un secondo momento. Alcune situazioni in cui l'elaborazione asincrona delle query potrebbe essere una buona alternativa includono:

  • Analisi e creazione di report che coprono intervalli di tempo ampi.
  • Analizzare i dati con una serie di dimensioni di raggruppamento e altri vincoli che aggiungono complessità alla query
  • Gestire le query quando noti che i volumi di dati sono aumentati in modo significativo per alcuni utenti o organizzazioni.

  Questo documento descrive come avviare un report asincrono utilizzando l'interfaccia utente. Puoi anche utilizzare l'API, come descritto in Utilizzo dell'API dei report personalizzati asincroni.

Per generare un report personalizzato per un intervallo di tempo specifico:

1. Accedi alla pagina Report personalizzati.
2. Seleziona il report da eseguire. Per impostazione predefinita, il report mostra i dati dell'ora precedente.

3. Per generare il report per un intervallo di tempo diverso:

   1. Fai clic nell'area dell'intervallo di tempo nella parte superiore del report per aprire il popup Selezione dell'intervallo di tempo del report personalizzato.
   2. Seleziona una delle seguenti opzioni:
      • Un intervallo di tempo predefinito, ad esempio Ultima ora, Ieri o Ultimi 7 giorni.

      • Un intervallo personalizzato selezionando una data e un'ora Da/A oppure utilizza il calendario per selezionare le date di inizio e di fine. Fai clic su UTC per utilizzare il tempo universale coordinato (UTC).

   3. Per generare il report, seleziona una delle seguenti opzioni:

      • Fai clic su Applica per eseguire il report in modo sincrono. I risultati verranno visualizzati nella dashboard dei report personalizzati al termine del report. Se l'esecuzione del report richiede più di 60 secondi, questo verrà convertito automaticamente in un report asincrono.

      • Fai clic su Invia job per eseguire il report in modo asincrono come job in background. Viene visualizzata la seguente finestra di dialogo:

        

        Fai clic su Visualizza stato nella finestra di dialogo per visualizzare lo stato del job del report personalizzato.

Visualizzazione dei job di report personalizzati asincroni

Per visualizzare i job dei report personalizzati asincroni, seleziona una delle seguenti opzioni:

• Fai clic su Visualizza stato nella finestra di dialogo Report inviato come job in background.
• Seleziona Analizza > Report personalizzati > Lavori di report dalla barra di navigazione a sinistra.

Viene visualizzata la pagina Report Jobs, come mostrato nella figura seguente:

La pagina Report sui lavori ti consente di:

• Visualizza tutti i risultati dei job di report personalizzati asincroni inviati negli ultimi 7 giorni.

• Seleziona l'ambiente per il quale vuoi visualizzare i job di report personalizzati.

• Per visualizzare il report personalizzato, assicurati che lo Stato sia completato. Poi sposta il mouse sopra la riga corrispondente al report. Vengono visualizzate un'icona e una . Seleziona per visualizzare il report.

• Scarica il report personalizzato facendo clic su .

  Il report completo viene scaricato come file ZIP denominato OfflineQueryResult-xxx.zip che contiene i file CSV.

• Cerca nell'elenco dei report personalizzati inserendo una stringa pertinente, completa o parziale, nella casella di ricerca; la stringa viene cercata in tutti i campi visualizzati.

Modificare un report personalizzato

Per modificare un report personalizzato:

1. Accedi alla pagina Report personalizzati.
2. Sposta il mouse sopra il nome del report che vuoi modificare. Le icone di modifica ed eliminazione vengono visualizzate sul lato destro della pagina.
3. Fai clic sull'icona di modifica.
4. Modifica i dettagli del report personalizzato.
5. Fai clic su Salva.

Verranno visualizzati nuovamente i risultati del report personalizzato.

Eliminare un report personalizzato

Per eliminare un report personalizzato:

1. Accedi alla pagina Report personalizzati.
2. Sposta il mouse sopra il nome del report che vuoi modificare. Le icone di modifica ed eliminazione vengono visualizzate sul lato destro della pagina.
3. Fai clic sull'icona di eliminazione per eliminare il report.