Creazione e gestione di rapporti personalizzati

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

I report personalizzati ti consentono di esaminare in dettaglio metriche API specifiche e visualizzare i dati esatti che ti interessano. Puoi creare un report personalizzato utilizzando una qualsiasi delle metriche e delle dimensioni integrate in Apigee.

Esistono due tipi di report personalizzati:

  • Report in tempo reale (chiamati anche report sincroni): quando specifichi i parametri del report nell'interfaccia utente Apigee, i report in tempo reale vengono visualizzati nell'interfaccia utente Apigee entro un paio di minuti.
  • Report (chiamati anche report asincroni): per i report personalizzati richiedi il report e recupera i risultati in un secondo momento.

Consulta la sezione Report in tempo reale e report di lavoro.

Disponibilità dei report personalizzati

Se sei un cliente con abbonamento Apigee, l'accesso ad Apigee API Analytics e alla funzionalità di report personalizzati è incluso nei tuoi diritti di abbonamento e viene attivato automaticamente per ciascuno dei tuoi ambienti Apigee.

Se sei un cliente con piano Pay-as-you-go, devi attivare Apigee API Analytics come componente aggiuntivo a pagamento per accedere alle analisi e generare report personalizzati. Per saperne di più sull'attivazione del componente aggiuntivo Apigee API Analytics per gli ambienti Apigee intermedi o completi, consulta Gestire il componente aggiuntivo Apigee API Analytics.

Se non sai se stai utilizzando un'organizzazione Apigee con abbonamento o con pagamento a consumo, contatta l'amministratore dell'organizzazione Apigee.

Informazioni sui report personalizzati

Quando crei un report personalizzato, selezioni i dati che vuoi visualizzare (metriche), raggruppi i dati in modo significativo (dimensioni) e limiti facoltativamente 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:

    Grafico a colonne personalizzato

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

    Grafico a linee personalizzato

Impostazione di 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

Oltre alle metriche e alle dimensioni standard, puoi anche creare report personalizzati per i dati personalizzati che raccogli utilizzando il criterio DataCapture. Consulta Raccolta di dati personalizzati con il criterio DataCapture.

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 medio di risposta.
  • 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 come raggruppare i 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 AppGroup:

  • Il tempo di risposta per prodotto API
  • Il tempo di risposta per proxy API
  • Il tempo di risposta per AppGroup

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 di dimensione diverso.
  • Linea: ogni linea nel grafico corrisponde a un valore di dimensione diverso e l'asse X rappresenta il tempo.

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.

Puoi creare filtri complessi utilizzando operatori e sintassi condizionali 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:

TPS report personalizzato

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:

Report personalizzato con due metriche

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 = Request verb

Report in tempo reale e job di report

Apigee Analytics ti consente di eseguire un report in tempo reale o un job di report.

  • Per i report in tempo reale, richiedi il report e questo viene visualizzato non appena il server di analisi fornisce una risposta. Tuttavia, poiché un report potrebbe dover elaborare una grande quantità di dati (ad esempio, centinaia di GB), un report in tempo reale potrebbe non riuscire a causa di un timeout.

    Un report in tempo reale può avere un intervallo di tempo massimo di 92 giorni. Se selezioni un intervallo di tempo superiore, il report viene eseguito come job di report.

    Vedi Eseguire un report personalizzato.

  • Per un job di report, richiedi il report e recupera i risultati in un secondo momento. Alcune situazioni in cui un job di report potrebbe essere una buona alternativa includono:

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

    Puoi anche eseguire un job di report utilizzando l'API, come descritto in Utilizzo dell'API dei report personalizzati asincroni. Vedi Visualizzare un job di report.

Apri la pagina Report personalizzati

Per aprire la pagina Report personalizzati:

  1. Apri la UI di Apigee nella console Cloud.
  2. Seleziona Analytics > Report personalizzati.

Viene visualizzata la pagina Report personalizzati:

Dashboard dei report personalizzati

La pagina Report personalizzati contiene due schede:

  • Report: mostra i report in tempo reale.
  • Report Jobs: mostra i job di report.

Consulta la sezione Report in tempo reale e report di lavoro.

Entrambe le schede mostrano un elenco dei report o dei job di report già creati. Per visualizzare un report o un job di report, fai clic sul nome del report. Per un esempio, vedi Eseguire un report.

Report

La scheda Report mostra le seguenti informazioni su ogni report:

  • Nome visualizzato: il nome del report.
  • Dimensioni: le dimensioni incluse nel report.
  • Metriche: le metriche e le funzioni di aggregazione (ad esempio sum) incluse nel report.
  • Ultima modifica: l'ultima data e ora in cui è stato eseguito il report.

Report sui lavori

La scheda Report sui job mostra le seguenti informazioni su ogni job di report:

  • Nome report: il nome del report.
  • Intervallo di tempo di inizio (UTC): l'ora di inizio del job di report.
  • Intervallo di tempo di fine (UTC): l'ora di fine del job di report.
  • Stato: lo stato del job di report, che può essere in esecuzione, completato o scaduto.
  • Inviato: la data e l'ora in cui è stato inviato il job di report.

La pagina Report personalizzati ti consente di:

Creare un report personalizzato

Questa sezione spiega come creare un report personalizzato.

Nella pagina Report personalizzati, puoi creare un report in tempo reale o un job di report. Ecco come fare:

  1. Apri la pagina Report personalizzati.
  2. Fai clic su + Crea.
    • Per creare un report in tempo reale, seleziona Report personalizzato.
    • Per creare un job di report, seleziona Job di report personalizzato.
  3. Nella sezione Di base, inserisci le seguenti informazioni:
    • Nome report: il nome del report.
    • Solo per un report in tempo reale, puoi anche inserire una Descrizione facoltativa del report.
  4. Le sezioni seguenti dipendono dalla creazione di un report in tempo reale di un job di report:
    • Solo per i report in tempo reale:

      Dopo Tipo di grafico, seleziona lo stile del grafico per presentare i dati:

      • Colonna: l'asse X rappresenta i gruppi designati dalle dimensioni.
      • Linea: l'asse X rappresenta il tempo.

    • Solo per i job di report:
      • Dettagli report: nel campo Ambiente, seleziona l'ambiente in cui vuoi eseguire il report. Tieni presente che per i report in tempo reale puoi selezionare l'ambiente nella pagina del report, dopo l'esecuzione del report.
      • Intervallo di date del report: seleziona Ora di inizio e Ora di fine per il report.

        Nota:l'intervallo di date massimo per un job relativo a un report è 365 giorni. Per i report che richiedono intervalli di date precisi al secondo, utilizza l' API Custom Reports per creare il job di report. L'API accetta input di intervalli di date che includono i secondi.

  5. Nella sezione Metriche:
    1. Seleziona la metrica che vuoi analizzare.
    2. Seleziona una funzione di aggregazione per visualizzare i valori Somma, Media, Minimo o Massimo.
    3. Fai clic su Fine.

    Nota:oltre alle metriche e alle dimensioni standard, puoi selezionare anche metriche o dimensioni corrispondenti ai dati personalizzati raccolti con le norme DataCapture.

  6. Nel campo Dimensioni, 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.
  7. Nella sezione Filtro, puoi restringere ulteriormente i dati visualizzati aggiungendo filtri alla definizione del report. Ad esempio, potresti aggiungere un filtro che esclude i dati per il proxy API meteo o lo sviluppatore [email protected].

    Innanzitutto, fai clic su Aggiungi un filtro per aprire la sezione Nuovo filtro.

    1. Seleziona il nome dell'entità in base alla quale vuoi filtrare, che può essere una metrica o una dimensione.
    2. Seleziona un operatore come = o != e un valore.
    3. Inserisci un valore per la metrica o la dimensione.
    4. Fai clic su Fine per aggiungere il filtro.
  8. Fai clic su Salva per salvare il report.

Eseguire un report

Per generare un report in tempo reale:

  1. Apri la pagina Report personalizzati.
  2. Nella scheda Report, seleziona il report da eseguire.

Quando il report è pronto, viene visualizzato:

Viene visualizzato il report personalizzato.

Il report mostra un grafico dei dati e una tabella riepilogativa.

Nella pagina del report, puoi selezionare le seguenti opzioni per il report:

  • Ambiente: l'ambiente in cui eseguire il report.
  • Un periodo di tempo per il report.
  • Dimensione: una dimensione per il report. Puoi visualizzare una sola dimensione alla volta.
  • Valore: un valore specifico per la dimensione o Tutti per visualizzare tutti i valori.

Puoi anche scegliere le seguenti opzioni nella parte superiore della pagina del report:

  • Modifica: modifica i dettagli del report.
  • Esporta: scarica i dati del report in un file CSV.
  • Invia job: invia il report come job di report. Quando fai clic su Invia lavoro, si apre una finestra di dialogo che ti offre le opzioni descritte in Creare un report personalizzato. Dopo aver inserito le opzioni, fai clic su Crea per creare il job del report.

Per ulteriori informazioni sui job di report, consulta la sezione Visualizzare un job di report.

Visualizzare un job di report

Per visualizzare un job di report, seleziona la scheda Job di report nella parte superiore della pagina Report personalizzati.

Viene visualizzata la scheda Report sui job:

Report sui job

La pagina Report sui job ti consente di:

  • Visualizza tutti i job di report inviati negli ultimi 7 giorni.

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

  • 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.

Per visualizzare il report personalizzato, assicurati che lo Stato sia completato. Poi fai clic sul nome del report per visualizzarlo.

Modificare un report personalizzato

Per modificare un report personalizzato:

  1. Apri la pagina Report personalizzati.
  2. Fai clic sul menu con tre puntini nella sezione Azioni.
  3. Seleziona Modifica. Si apre la finestra di dialogo Modifica report personalizzato, in cui puoi modificare le opzioni del report. Le opzioni sono descritte in Creare un report personalizzato.
  4. Fai clic su Update (Aggiorna) per salvare le modifiche.

Eliminare un report personalizzato

Per eliminare un report personalizzato:

  1. Apri la pagina Report personalizzati.
  2. Fai clic sul menu con tre puntini nella sezione Azioni.
  3. Fai clic su Elimina per eliminare il report.